Search Orders
Knowledge Base
Search Business Email Orders Using the API
When you want to search Business Email orders using the API. This article explains available search filters, order status options, sorting, pagination, and response details for matching Business Email orders.
Description
Gets a list and details of the Business Email Orders matching the search criteria.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| 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 of Integers | Optional | Order ID(s) of the Business Email Order(s) whose details need to be fetched |
| reseller-id | Array of Integers | Optional | Reseller ID(s) of the Resellers whose Orders need to be fetched |
| customer-id | Array of Integers | Optional | Customer ID(s) of the Customers whose 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, Deleted, etc. |
| domain-name | String | Optional | Domain name associated with the Business Email Order |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of the Business Email Orders whose Creation Date is greater than creation-date-start |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of the Business Email Orders whose Creation Date is less than creation-date-end |
| expiry-date-start | String | Optional | UNIX TimeStamp for listing of the Business Email Orders whose expiry date is greater than expiry-date-start |
| expiry-date-end | String | Optional | UNIX TimeStamp for listing of the Business Email 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
US Server https://test.httpapi.com/api/eelite/us/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1
Response
Returns a hash map containing the below details of the Business Email Orders which match the search criteria:
-
Domain Name (entity.description)
-
Order Id (orders.orderid)
-
Customer Id (entity.customerid)
-
Order Addition Timestamp (orders.creationdt)
-
Order Creation Timestamp (orders.creationtime)
-
Expiry Timestamp (orders.endtime)
-
Current Order Status under the System (entity.currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived
-
Product Name (entitytype.entitytypename)
-
Product Key (entitytype.entitytypekey)
-
GEO Location (hosting_group_info.location)