A request to the OrderSync API will return either a success response with a 'data' payload (which may be empty) or an error response.
Success Response
A successful response for order status data from the API looks like:
json
{
"data": [ /* response data */ ],
"meta": {
"total": 120,
"page": 1,
"limit": 50,
"has_more": true
}
}
All endpoints that may return a large number of results support pagination. If the response's 'meta' object contains:
"has_more": true
then another page of results exists and another API request must be made to obtain the other pages. To see an example of how to handle the "has_more" flag, see the Pagination page.
For details on the 'data' items that can be returned by the API, see the individual endpoint resource pages.
Error Response
A request resulting in an error will return an error response containing at least:
json
{
"error": "<error_name>",
"errorCode": <error_code>,
"message": "<error_message>"
}
See the Errors page for more details on specific errors.