Order query

Order query

Headers

x-api-key

string

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

offset

integer

default: 0

Required range: x > 0

limit

integer

default: 10

Required range: 1 < x < 500

sortBy

enum<string>

default: createdAt

Available options:

createdAt,

orderTotal,

totalQuantity,

status

sortDirection

enum<string>

default: desc

Available options:

asc,

desc

filters

object

Show child attributes

Response

200 - application/json

query

object

Show child attributes

orders

object[]

Show child attributes