Search Orders

Description

Gets a list and details of the Block Storage 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. Enter a value between 10 and 500
page-no Integer Required Page number for which details are to be fetched
order-id Array of Integers Optional Order ID(s) of the Block Storage order whose details need to be fetched
reseller-id Array of Integers Optional Reseller Id(s) of the Reseller(s) whose Orders need to be fetched
customer-id Array of Integers Optional Customer Id(s) of the Customer(s) 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 Block Storage Order
creation-date-start String Optional UNIX TimeStamp for listing of the Block Storage Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the Block Storage Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the Block Storage Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the Block Storage 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

 

Response

Returns the list of the Block Storage Orders which match the search criteria.