Skip to main content
GET
List Orders

Query Parameters

integer
default:"1"
Page number for pagination
integer
default:"10"
Number of orders per page (max 100)
integer
Filter orders by customer ID
string
Filter orders by status. Valid values: open, cancelled, completed
string
Filter orders by payment status. Valid values: not_paid, partially_paid, fully_paid, processing, refunded, partially_refunded
string
Filter orders by fulfillment status. Valid values: not_fulfilled, partially_fulfilled, fulfilled
string
Filter orders that used a specific coupon code (exact match)
number
Filter orders with a total amount greater than or equal to this value
number
Filter orders with a total amount less than or equal to this value
string
Filter orders created on or after this date (YYYY-MM-DD)
string
Filter orders created on or before this date (YYYY-MM-DD)
Search across confirmation code, customer comment, and coupon code
string
default:"created_at"
Field to sort results by. Valid values: id, total, created_at, status
string
default:"DESC"
Sort direction. Valid values: ASC, DESC

Example Requests

Basic pagination

Filter by customer

Filter by status

Filter by payment status

Example Response

Once you have an order ID from the list, you can access related resources:

Order Invoices

Order Transactions

Example Usage