Sign in

v1

latestSwagger 2.02026-07-1322030.3 KB
v1

Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time

<strong>API Resellers</strong><ul><li>This endpoint does not support subaccounts and therefore API Resellers should not supply an X-Shopper-Id header</li></ul>

get/v1/orders

Query parameters

periodStartstring

Start of range indicating what time-frame should be returned. Inclusive

periodEndstring

End of range indicating what time-frame should be returned. Inclusive

domainstring

Domain name to use as the filter of results

productGroupIdinteger

Product group id to use as the filter of results

paymentProfileIdinteger

Payment profile id to use as the filter of results

parentOrderIdstring

Parent order id to use as the filter of results

offsetinteger

Number of results to skip for pagination

limitinteger

Maximum number of items to return

sort'createdAt' | '-createdAt' | 'orderId' | '-orderId' | 'pricing.total' | '-pricing.total'

Property name that will be used to sort results. '-' indicates descending

Headers

X-Shopper-Idstring

Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>

X-App-Keystring required

A unique application key identifying the source of the request. This is required for request tracking

Response

Request was successful

All 2 operations