Skip to main content
GET
List Orders

Authorizations

Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
starting_after
string

Return results after this ID (cursor)

status
enum<string>
Available options:
draft,
pending,
confirmed,
processing,
completed,
cancelled
payment_status
string
fulfillment_status
string
created_after
string<date-time>
created_before
string<date-time>
q
string

Search by order number or email

Response

200 - application/json

Success

data
object[]
total_count
integer

Only returned in Admin API

has_more
boolean
next_cursor
string | null