Skip to main content
GET
This endpoint supports comprehensive filtering, pagination, and sorting. Use query parameters to efficiently retrieve the exact orders you need.

Pagination Parameters

integer
default:"20"
Maximum number of orders to return per page. Range: 1-100.
integer
default:"0"
Number of orders to skip. Use for pagination.
string
Cursor-based pagination token. More efficient for large datasets.

Sorting Parameters

string
default:"created_at"
Sort field. Options: created_at, updated_at, order_number, total_amount, status, customer_email
string
default:"desc"
Sort direction. Options: asc, desc

Filter Parameters

Status Filters

string
Filter by order status. Options: pending, processing, shipped, delivered, cancelled, refunded
array
Filter by multiple statuses. Example: status_in=pending,processing

Date Filters

string
Orders created after this date (ISO 8601 format: 2024-01-01T00:00:00Z)
string
Orders created before this date (ISO 8601 format: 2024-12-31T23:59:59Z)
string
Orders updated after this date
string
Orders shipped after this date

Customer Filters

string
Filter by exact customer email
string
Filter by customer ID
string
Filter by customer tier. Options: bronze, silver, gold, platinum

Financial Filters

number
Orders with total amount greater than or equal to this value
number
Orders with total amount less than or equal to this value
string
Filter by currency code (ISO 4217). Example: USD, EUR, GBP

Location Filters

string
Filter by shipping country code (ISO 3166-1). Example: US, CA, GB
string
Filter by shipping state/province
string
Filter by fulfillment center ID

Product Filters

string
Filter orders containing specific SKU
string
Filter orders containing products from specific category

Source Filters

string
Filter by order source. Options: website, mobile_app, marketplace, phone, retail
string
Filter by sales channel
Full-text search across order number, customer name, email, and product names

Advanced Filters

boolean
Filter orders that have associated returns
boolean
Filter gift orders
string
Filter by fraud risk level. Options: low, medium, high
string
Filter by order priority. Options: low, normal, high, urgent

Include Parameters

array
Include related data. Options: line_items, customer, shipping_address, billing_address, payments, returns, fulfillments

Response

array
An array of order objects.
integer
The total number of orders matching the query parameters.