Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

A bearer token obtained through one of the two flows below.

Query Parameters

page[after]
string

The cursor from the previous page's links.next. Do not build it yourself, and do not hold on to it: follow the link until there is no next.

page[limit]
integer
default:25

How many to return. Up to 50; more than that is refused rather than quietly trimmed. The same everywhere in this API.

Required range: 1 <= x <= 50
include
enum<string>

Related resources to return alongside, comma separated: seller, items, items.watch, items.watch.cover, addresses. items.watch is the one that matters — it carries the externalIdentifier you gave the listing, which is how you recognise your own product. Add items.watch.cover when you are drawing order rows: one photo per order, rather than a request per row to find it.

There is deliberately no seller.watches: that would return every listing a seller has, unpaged, in the middle of an order. Nor items.watch.images: a row draws one photo, and a page of orders carrying every gallery is the payload problem cover exists to avoid.

Available options:
seller,
items,
items.watch,
items.watch.cover,
addresses
sort
enum<string>

createdAt, updatedAt, status, paidAt, deliveredAt or paidOutAt, prefixed with - for descending. Newest first by default.

Available options:
createdAt,
-createdAt,
updatedAt,
-updatedAt,
status,
-status,
paidAt,
-paidAt,
deliveredAt,
-deliveredAt,
paidOutAt,
-paidOutAt
filter[status]
string

One status, or several separated by commas.

Examples:

"payment_received"

"payment_received,awaiting_delivery"

filter[updatedSince]
string<date-time>

ISO 8601. Everything that moved at or after this moment.

filter[q]
string

The same search as the shop's: the order number (a leading # is ignored), the name or email on it, the street, zipcode or city it ships to, or the watch's name, model or brand.

Example:

"202610100"

Response

A page of orders.

data
object[]
required
included
object[]

Present when the answer is a page.

meta
object

page when the answer is a page: from, to, perPage and hasMore for a cursor (from and to are cursors, not numbers), or currentPage, from, lastPage, perPage, to and total for numbered pages. Some lists add their own beside it, such as statusCounts, unread or facets.