List Orders
Retrieve orders with advanced filtering, pagination, and sorting capabilities
This endpoint supports comprehensive filtering, pagination, and sorting. Use query parameters to efficiently retrieve the exact orders you need.
Pagination Parameters
Maximum number of orders to return per page. Range: 1-100.
Number of orders to skip. Use for pagination.
Cursor-based pagination token. More efficient for large datasets.
Sorting Parameters
Sort field. Options: created_at
, updated_at
, order_number
, total_amount
, status
, customer_email
Sort direction. Options: asc
, desc
Filter Parameters
Status Filters
Filter by order status. Options: pending
, processing
, shipped
, delivered
, cancelled
, refunded
Filter by multiple statuses. Example: status_in=pending,processing
Date Filters
Orders created after this date (ISO 8601 format: 2024-01-01T00:00:00Z
)
Orders created before this date (ISO 8601 format: 2024-12-31T23:59:59Z
)
Orders updated after this date
Orders shipped after this date
Customer Filters
Filter by exact customer email
Filter by customer ID
Filter by customer tier. Options: bronze
, silver
, gold
, platinum
Financial Filters
Orders with total amount greater than or equal to this value
Orders with total amount less than or equal to this value
Filter by currency code (ISO 4217). Example: USD
, EUR
, GBP
Location Filters
Filter by shipping country code (ISO 3166-1). Example: US
, CA
, GB
Filter by shipping state/province
Filter by fulfillment center ID
Product Filters
Filter orders containing specific SKU
Filter orders containing products from specific category
Source Filters
Filter by order source. Options: website
, mobile_app
, marketplace
, phone
, retail
Filter by sales channel
Search
Full-text search across order number, customer name, email, and product names
Advanced Filters
Filter orders that have associated returns
Filter gift orders
Filter by fraud risk level. Options: low
, medium
, high
Filter by order priority. Options: low
, normal
, high
, urgent
Include Parameters
Include related data. Options: line_items
, customer
, shipping_address
, billing_address
, payments
, returns
, fulfillments
Response
An array of order objects.
The total number of orders matching the query parameters.