Get Orders

Return a list of up to 100 orders for a given location within a given timeframe.

There are several ways to make the GET request by timeframe. Don't include the curly brackets {} when you make the GET request - just add your in-store system ID and substitute the example dates and times for the ones you want to query.

Example GET requests:

GET api/v1/{site_location_id}/orders?date=2018-12-11

See all orders on a certain date. This example would show all orders on 11 December 2018.

GET api/v1/{site_location_id}/orders?date=2018-12-11T15:00

See all orders on a certain date from a certain time. This example would show all orders between 15:00 and the end of the day on 11 December 2018.

GET api/v1/{site_location_id}/orders?date=2018-12-11&date_end=2018-12-13

See all orders from the beginning of a certain date to the end of another. This example would show all orders from the beginning of 11 December 2018 to the end of 13 December 2018.

GET api/v1/{site_location_id}/orders?date=2018-12-11T15:00&date_end=2018-12-13

See orders from a certain time on a certain date to the end of another date. This example would show all orders from 15:00 on 11 December 2018 to the end of the day on 13 December 2018.

GET api/v1/{site_location_id}/orders?date=2018-12-11T15:00&date_end=2018-12-13T16:21

See orders from a certain time on a certain date to a certain time on another date. This example would show all orders from 15:00 on 11 December 2018 to 16:21 on 13 December 2018.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Related site location ID.

Query Params
string

The parameter used for pagination.

string

Beginning of the time range to search in. ISO8601 compliant date-time string.

string

End of the time range to search in. ISO8601 compliant date-time string.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json