Skip to main content
GET
List orders

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

page
integer
Required range: x >= 1
page_size
integer
Required range: 1 <= x <= 100
created_after
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

created_before
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_after
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_before
string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

ids
string[]

Filter by order IDs. Repeat param for multiple: ?ids=&ids=

reference_ids
string[]

Filter by order reference ID. Repeat param for multiple: ?reference_ids=ORD-123&reference_ids=ORD-124

customer_ids
string[]

Filter by customer IDs. Repeat param for multiple: ?customer_ids=&customer_ids=

customer_reference_ids
string[]

Filter by customer reference ID. Repeat param for multiple: ?customer_reference_ids=CUST_123&customer_reference_ids=CUST_124

sort_by
enum<string>
default:updated_at
Available options:
created_at,
updated_at
sort
enum<string>
default:desc
Available options:
asc,
desc
order_status
enum<string>
default:confirmed

If not provided, by default "confirmed" orders will be sent.

Available options:
draft,
confirmed,
cancelled,
submitted
type
enum<string>
Available options:
order,
quote
source
string[]

Include orders with these sources e.g. openapi(Open API), sales_rep(Wizorder), wizshop(Wizshop). Repeat param for multiple: ?source=openapi&source=sales_rep

exclude_source
string[]

Exclude orders with these sources e.g. openapi(Open API), sales_rep(Wizorder), wizshop(Wizshop). Repeat param for multiple: ?exclude_source=sales_rep&exclude_source=openapi

Response

OK

data
object[]
pagination
object