List WordPress Hosting Orders Using the API
When you want to retrieve WordPress Hosting orders matching specific search criteria. This article explains how to list WordPress Hosting orders using the API with filters such as order ID, reseller ID, customer ID, status, domain name, creation date, expiry date, and sorting options.
Description
Gets a list and details of the Wordpress Hosting Orders matching the search criteria.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Your Live Account Reseller Id |
| api-key | String | Required | An alphanumeric code that can be used to authenticate your API calls |
| no-of-records | Integer | Required | Number of Orders to be fetched |
| page-no | Integer | Required | Page number for which details are to be fetched |
| order-id | Array ofIntegers | Optional | Order ID(s) of the Wordpress Hosting Order(s) whose details need to be fetched |
| reseller-id | Array of Integers | Optional | Reseller ID(s) whose Wordpress Hosting Orders need to be fetched |
| customer-id | Array of Integers | Optional | Customer ID(s) whose Wordpress Hosting Orders need to be fetched |
| show-child-orders | Boolean | Optional | Whether Sub-Reseller Orders need to be fetched or not |
| status | Array of Strings | Optional | Status of the Order: Active, InActive, Suspended or Deleted |
| domain-name | String | Optional | Name of the Domain of the Wordpress Hosting Order |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of the Wordpress Hosting Orders whose Creation Date is greater than creation-date-start |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of the Wordpress Hosting Orders whose Creation Date is less than creation-date-end |
| expiry-date-start | String | Optional | UNIX TimeStamp for listing of the Wordpress Hosting Orders whose expiry date is greater than expiry-date-start |
| expiry-date-end | String | Optional | UNIX TimeStamp for listing of the Wordpress Hosting Orders whose expiry date is less than expiry-date-end |
| order-by | Array of Strings | Optional | One or more parameters by which you want to sort the Orders. Default is orderid.
Example: If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. If page-no is 2, no-of-records is 30 and order-by is orderid; it will fetch the second batch of 30 Orders sorted by orderid. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/restapi/product/wordpresshostingusa/list.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1&order-by=orderid
Response
Returns a hash map containing the below details of the Wordpress Hosting Orders which match the search criteria:
-
Domain Name (entity.description)
-
Order Id (orders.orderid)
-
Customer Id (entity.customerid)
-
Order Creation Timestamp (orders.creationtime)
-
Order Expiry Timestamp (orders.endtime)
-
Current Order Status (entity.currentstatus) - value will be InActive, Active, Suspended or Deleted
-
Product Name (entitytype.entitytypename)
-
Product Key (entitytype.entitytypekey)
In case of any errors, a status key with value as ERROR along with an error message will be returned.