API Reference

Retrieve Orders

get
http://api.spoton.com/reporting/v1/locations//orders

Retrieve a list of historical orders for a given location.

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

SpotOn Location ID

Query Params
date-time

Start time of the order created date time range. Format is RFC 3339.

date-time

End time of the order created date time range. Format is RFC 3339.

string
enum
Defaults to RANGE_UNSPECIFIED

Range for the aggregation. RANGE_LAST_DAY is 24 hours, RANGE_LAST_WEEK is 168 hours, RANGE_LAST_MONTH is 720 hours, and LAST_YEAR is 31,536,000 seconds and doesn't take into account leap-years, leap-seconds.

Allowed:
int64

Multiplier for the range. For example, if range is RANGE_LAST_DAY and multiplier is 2, the filter will return the last 48 hours of data.

int64

Page number. If not provided, the default value is 1.

int64
≤ 1000

Number of results per page. Maximum is 1000. If not provided, the default value is 100.

string

Start date of the fiscal date range. Format is the date portion of RFC 3339 (YYYY-MM-DD).

string

End date of the fiscal date range. Format is the date portion of RFC 3339 (YYYY-MM-DD).

date-time

Start time of the order last updated date time range. Format is RFC 3339. Can be used standalone or combined with the from_time/to_time query parameters.

date-time

End time of the order last updated date time range. Format is RFC 3339. Can be used standalone or combined with the from_time/to_time query parameters.

Responses

Updated 3 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?