Querying orders¶
It is possible to retrieve one or more via the order retrieval API. With this API it is possible to:
Retrieve a list of all orders
Get orders by or excluding one or more statuses.
Get a single order
Query orders by an arbitrary search string
See the order UI for the list of query parameters, section
Example queries¶
The following URLs are examples of how to query orders.
Paginated¶
Retrieve a list of orders, paginated:
This will retrieve a list of orders ordered by order date/time descending. At most 20 entries will be returned, starting at the first “page”.
Note
Query with limit=0 and offset=0 to query all orders. This may result in a very large list of orders, depending on how many orders you’ve registered in the system
Arbitrary search strings¶
When executing a query with the “q” query parameter, the following fields will be queried:
Customer order id
A2B order id
Resource id
Postcode
Street
City
Parameter value