List Orders
Orders
List Orders
Retrieve a list of orders with pagination and filtering options.
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, completedstring
Filter orders by payment status. Valid values:
not_paid, partially_paid, fully_paid, processing, refunded, partially_refundedstring
Filter orders by fulfillment status. Valid values:
not_fulfilled, partially_fulfilled, fulfilledstring
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)
string
Search across confirmation code, customer comment, and coupon code
string
default:"created_at"
Field to sort results by. Valid values:
id, total, created_at, statusstring
default:"DESC"
Sort direction. Valid values:
ASC, DESC