Terminal orders - company level
Get a list of orders
Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters.
To make this request, your API credential must have one of the following roles:
- Management API—Terminal ordering read
- Management API—Terminal ordering read and write
In the live environment, requests to this endpoint are subject to rate limits.
get/companies/{companyId}/terminalOrders
Path parameters
companyIdstring required
The unique identifier of the company account.
Query parameters
customerOrderReferencestring
Your purchase order number.
statusstring
The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.
offsetinteger
The number of orders to skip.
limitinteger
The number of orders to return.
Response
OK - the request has succeeded.