Skip to main content
GET
List orders by status

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <live_api_key>.

Query Parameters

status
enum<string>
required

Use a status_key from GET /api/v2/order/statuses, or ALL to return every order. Status key from GET /api/v2/order/statuses, or ALL.

Available options:
RECENT,
PENDING,
SETUP,
SHIPPED,
CANCELLED,
RETURNED,
TERMINATED,
SUSPENDED,
ERROR,
ALL
per_page
integer

Response

OK

success
boolean