List orders
Orders
List orders
Retrieve a paginated list of the store’s orders with optional filters. Requires the READ_ORDERS scope.
GET
List orders
Returns the store’s orders most recent first, each enriched with the customer, payment, coupon and shipment summaries. The shipment summary includes the delivery address (
shipment.shippingAddress) once the order has a shipment — no per-order detail fetch needed for bulk geographic or shipping-zone work. The store is bound to your app token server-side — never send a shop id.Authorizations
Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.
Query Parameters
Page number (1-based).
Required range:
x >= 1Number of orders per page.
Required range:
x >= 1Filter by order status. One of: pending, processing, paid, cancelled, refunded. Other values are ignored.
Available options:
pending, processing, paid, cancelled, refunded Filter by the customer's user id (Mongo ObjectId). Invalid ids are ignored.
Inclusive lower bound on order creation date (ISO 8601, filters createdAt).
Inclusive upper bound on order creation date (ISO 8601, filters createdAt).

