Skip to main content
POST
Retrieve a list of orders for an Amazon channel (Requires Enterprise plan)

Authorizations

x-api-key
string
header
required

Body

application/json

Filter criteria

channelId
string
required

The channel ID, as returned by the channels endpoint

merchantId
string
required

The channel's merchant ID, as returned by the channels endpoint

dateField
enum<string>

The field to which fromDate and toDate filter are applied - either 'createdAt' (the order's createdTime) or 'updatedAt' (the order's lastUpdatedTime)

Available options:
createdAt,
updatedAt
fromDate
integer

Start of date range as unix epoch seconds.

Example:

1609459200

toDate
integer

End of date range as unix epoch seconds.

Example:

1612137600

orderId
string

The order ID to filter by

key
string

The key used for pagination - pass meta.key from the previous response to get the next page

pageSize
integer

The number of results to return per page (Default 10, Max 100)

Example:

50

Response

Successful operation

meta
object
data
object[]