Get all order

GET {{base_url}}/orders

Description

This API endpoint is used to search for orders based on various criteria such as order number, provider, order status, user ID, and date range.

Request

Request Headers:

Name	Description
tenantId	(required, header) The tenant ID associated with the request.
countryCode	(required, header) The country code associated with the request.

Query Parameters:

Name	Description
pageNumber	(query) Page number for pagination.
pageSize	(query) Number of results per page for pagination.
orderNumber	(query) Filter by specific order numbers.
globalOrderNumber	(query) Filter by global order numbers.
providers	(query) Filter by specific providers.
globalOrderStatusList	(query) Filter by specific global order statuses.
providerOrderStatusList	(query) Filter by specific provider order statuses.
userIdList	(query) Filter by specific user IDs.
startDate	(query) Start date for filtering orders.
endDate	(query) End date for filtering orders.

Responses: Status: 200 OK Description: Orders found successfully.

Response Body Schema (JSON):

{
  "status": "boolean",
  "statusCode": "integer",
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Example:

<orderSearchResponse>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</orderSearchResponse>

400 Bad Request Description: Invalid reference supplied.

404 Not Found Description: Orders not found.