Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort
string

Sort order, use: order_number, created_at, fulfilled_at. For descending order use '-' e.g. &sort=-created_at

page[number]
integer
page[size]
integer

Number of documents

fields[orders]
string

Partial attributes as specified, e.g. fields[orders]=order_number,total_price_in_cents

filter[site_id]
string

Filter by site_id, for example ?filter[site_id]=111

filter[customer_id]
string

Filter by customer_id, for example ?filter[customer_id]=456789

filter[order_number_eq]
string

Filter by order number, for example ?filter[order_number_eq]=12345

filter[fulfilled_at_null]
boolean

Filter by fulfillment status, for example ?filter[fulfilled_at_null]=true

Response

Success, list of orders which the current user may access

data
object[]