Skip to content
API referenceAPI v1admin-sdk 1.1.52Search docs⌘K
Orders · List orders
API reference / Orders

List orders

GET/api/v1/ordersorders:read

The merchant's orders, a page at a time. Filter on any field, e.g. status=3 or reference_id=order_1042.

Query parameters

pageinteger

Page number, from 1.

page_sizeinteger

Items per page.

orderstring

Sort, e.g. id desc for newest first.

statusinteger

Only orders with this status.

reference_idstring

Only the order with your reference.

Headers

Authorizationheaderrequired

Bearer with your secret key, or the merchant's OAuth token.

Returns

entries and pagination. Lists and filters.

statusMeaning
1pending: waiting for the customer to pay.
2error: the payment failed.
3paid: orders.paid has been sent.
32partial: part of the total is paid.
4confirmed: the merchant accepted it.
5cancelled.
6prepared: ready to ship or collect.
7shipped.
8delivered.
9completed: delivered and confirmed.
10returned.
11refunded.
12verifying: the merchant is checking it.
13stale: pending for too long.
14archived.

Errors

401The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs.