Skip to main content
GET
cURL

Authorizations

X-Delegated-Token
string
header
required

Headers

X-Tenant-ID
string
required

Unique identifier of the tenant in the system (usually a store identifier)

Query Parameters

query
string

Search query. Terms are field:value; comparisons field:>value, :<, :>=, :<=. Quote values in single or double quotes unless they are only letters and digits, with single dots between them, or a UUID as a filter value. Combine terms with AND (binds tighter) and OR, group with parentheses, negate a term or group with NOT or a leading -. Fields: id, type, subscriptionId, placedAt, createdAt, includeOneTime. Example: subscriptionId:"<subscription id>" AND placedAt:>="2026-01-01". See search query language and the field reference. Free-text terms are rejected: orders have no search index behind them, unlike customers, products and subscriptions. includeOneTime:true widens the scope to the customer's full Shopify order history and cannot be combined with other filters, because we hold no row for those orders to filter on. Changing this restarts pagination.

Minimum string length: 1
includeOneTime
boolean
default:false
deprecated

DEPRECATED: use query=includeOneTime:true instead, so that scope and filters travel in one parameter. Still honoured, and still mutually exclusive with query filters. When false (default), only subscription-driven orders are returned: the set is determined by orders tracked in our database for the customer, hydrated from Shopify. When true, the full Shopify order history (including one-time orders) is returned. Toggling this restarts pagination (the default path uses database cursors; the full-history path uses Shopify cursors).

limit
integer
default:20
Required range: 1 <= x <= 50
sort
enum<string>

Sort order. When set to placedAt, orders are sorted by placement date (newest first). When omitted, the default sort is used. Toggling this flag restarts pagination (cursors are not interchangeable between sort modes).

Available options:
placedAt
after
string
Minimum string length: 1
before
string
Minimum string length: 1

Response

200 - application/json

Default Response

resource
enum<string>
required
Available options:
list
hasNextPage
boolean
required
hasPrevPage
boolean
required
endCursor
null | string
required
startCursor
null | string
required
data
Order · object[]
required
orders
Order · object[]
required
deprecated

DEPRECATED: use data instead. Returned for backward compatibility with the pre-pagination response shape.