Skip to main content
GET
Get a paginated list of orders with optional filtering, search, and sorting

Query parameters

integer (int64)
Page number (default: 1)
integer (int64)
Items per page (default: 20, max: 100)
OrderStatus
Filter by order status
string (uuid)
Filter by customer ID
Search by order number, notes, or shipping address
string
Only include orders created after this RFC3339 timestamp
string
Only include orders created before this RFC3339 timestamp
OrderSortField
Sort field (created_at, order_date, total_amount, order_number)
SortDirection
Sort direction (asc, desc)
boolean
If true, include line items for each order in the response

Responses

ApiResponse_PaginatedResponse_OrderResponse
Orders retrieved successfully
ErrorResponse
Invalid request parameters
ErrorResponse
Unauthorized
ErrorResponse
Forbidden
ErrorResponse
Rate limit exceeded
ErrorResponse
Internal server error