Skip to main content
GET
Error

Authorizations

x-api-key
string
header
required

unique identifier access key. each brand has it own unique key.

Query Parameters

limit
number
default:10

pagination: limit of entities returned by query

Required range: x <= 50
cursorId
string

pagination: it is necessary to pass cursorId = null in the first call

code
string

filter by order code

externalCode
string

filter by order external code

status
enum<string>[]

filter by status

Available options:
DRAFT,
IN_REVISION,
ON_APPROVAL,
APPROVED,
SENT,
CANCELED,
ABANDONED,
REJECTED,
SUGGESTED
types
enum<string>[]

filter by order type (accepts multiple values)

Available options:
PRE_ORDER,
READY_FOR_DELIVERY,
BOTH
changeStartDate
string

change interval start date

changeEndDate
string

change interval end date

date
string<date-time>

filter by date

synchronizedStatus
enum<string>

filter sinchronized orders

Available options:
NOT_SYNCHRONIZED,
ERROR,
SUCCESS,
PROCESSING
archived
boolean

filter by archived orders

customerCode
string

filter by customer code

customerId
string

filter by customer id

Response

orders pagination

data
object[]
required
nextCursor
string | null

when the field is null, it means that pagination has ended