Skip to main content
GET
List customer orders

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

page[cursor]
string

Pagination cursor

page[limit]
integer

Number of records per page (max 100)

Free-text search across order number, customer name/email/phone, external id, and order id/number

sort
enum<string>

Sort key; prefix with '-' for descending

Available options:
sale_date,
-sale_date,
created_at,
-created_at,
id,
-id,
order_status,
-order_status,
status,
-status,
customer_name,
-customer_name,
customer,
-customer,
amount,
-amount
status
enum<string>

Filter by order status ('all' returns every status)

Available options:
all,
draft,
pending,
pending_review,
processing,
completed,
cancelled,
archived
type
enum<string>

Filter by order class

Available options:
sample_order,
customer_order,
member_order,
enrollment_order,
autoship_order
customer_id
integer

Filter by customer id

user_company_id
integer

Filter by user company id

subscription_id
integer

Filter by subscription id

start_date
string<date>

Include orders on or after this date

end_date
string<date>

Include orders on or before this date

timezone
string

Timezone for date-range filtering

within_days
integer

Include orders within the last N days

cart_source
string

Filter by cart source

country_isos
string

Comma-separated country ISO codes to filter by

force_stats
boolean

Force recomputation of aggregate stats

order_number
string

Filter by exact order number

Response

Success

Paginated list of customer orders with stats

orders
object[]
required
meta
object
required

Default meta envelope plus cursor pagination and order stats rendered by Commerce::Api::Orders::IndexAction as {pagination:}.merge(stats).