Skip to main content
GET
List orders
Returns a paginated list of orders for the authenticated merchant. Use this endpoint to power operational dashboards, support tools, and cross-channel reporting.
Requires an access token with the orders:read scope. See Token to obtain a token.

Query parameters

Request

Response

The response wraps an array of order objects in data.

Order object

Each entry in lines represents a product, fee, or modifier row:
Use customer_id to pull order history for a known shopper. Use is_anonymous=true to analyze guest checkout volume separately from registered customers.

Error responses

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from
string
required
to
string
required
store_id
string

Filter by external store identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
channel_id
string

Filter by external channel identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
customer_id
string

Filter by external customer identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
is_anonymous
boolean

Filter by anonymous checkout orders.

Response

200 - application/json

Ok

data
object[]