Search Orders
Knowledge Base
Search Google Workspace Orders Using the API
When you want to search Google Workspace orders using the API. This article explains available search filters, order status options, pagination parameters, sorting options, and response details for matching Google Workspace orders.
Description
Gets a list and details of 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 Order(s) whose details need to be fetched. |
| reseller-id | Array of Integers | Optional | Reseller Id(s) whose Orders need to be fetched. |
| customer-id | Array of Integers | Optional | Customer Id(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 | Name of the Domain of the G Suite Order. |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of Orders whose Creation Date is greater than creation-date-start. |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of Orders whose Creation Date is less than creation-date-end. |
| expiry-date-start | String | Optional | UNIX TimeStamp for listing of Orders whose expiry date is greater than expiry-date-start. |
| expiry-date-end | String | Optional | UNIX TimeStamp for listing of 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 order id; it will fetch the second batch of 30 Orders sorted by orderid |
HTTP Method
GET
Example Test URL Request
India
https://test.httpapi.com/api/gapps/in/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1
South East Asia & Egypt
https://test.httpapi.com/api/gapps/se/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1
Rest of the World
https://test.httpapi.com/api/gapps/gbl/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1
Response
Returns the list of the Orders which match the search criteria.