Skip to main content
GET
List sale orders

Authorizations

x-api-key
string
header
required

API key for authentication

Query Parameters

status
enum<string>

Filter by order status

Available options:
awaiting_payment,
payment_processing,
fufillment_in_progress,
payment_failed,
order_shipped,
order_complete,
order_cancelled,
partially_fufilled
limit
integer
default:20

Maximum number of orders to return (default 20, max 100)

Required range: 1 <= x <= 100
offset
integer
default:0

Number of orders to skip (for pagination)

Required range: 0 <= x <= 9007199254740991

Response

200 - application/json

Default Response

data
object[]
required