Orders

Order Model

For a full list of all order attributes and their definition, see the link below;

Polling Orders
Please note that frequent polling of orders is not allowed. To receive orders in real time as a POS, use the Order Notification webhook.

Refine Results

By account;

Add the account Id as below to return all orders for a specified account;

?where={"account": "65********************6f"}

By location

Add the location Id as below to return all orders for a specified location;

?where={"location": "65********************fd"}

By Order Id

?where={"_id": "62********************7c}

Querying Results

As results can be paginated, please reference the link below which shows how to correctly handle this;

As results are paginated, please reference the Guide on Query Parameters which shows how to correctly handle paged results.

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json