Get single order
GET {{base_url}}/orders/single-order
Description
This API endpoint is used to search for an order using its UUID or order number.
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 |
|---|---|
| orderUuid | (query) The UUID of the order to be searched. |
| orderNumber | (query) The order number to be searched. |
| Responses: | |
| Status: 200 OK | |
| Description: |
Found the order. 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 order ID reference supplied. 404 Not Found
Description: Order not found.
LANGUAGE
CURL REQUEST
curl --request GET \
--url /orders/single-order \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!