Skip to main content
GET
List inventory

Authorizations

Authorization
string
header
required

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

Scopes

watches:read

Read the watches in your inventory

Headers

Accept-Language
enum<string>

The language to answer in: specificationLabels, translatedDescription, facet and label names, the content pages, and every other translated word in the answer. Read on every request, whatever the endpoint. One we do not have falls back to English rather than failing.

Available options:
en,
nl,
de,
es,
fr,
it,
pt,
fi,
pl

Path Parameters

sellerId
string
required

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. Combine them with commas — include=images,watchModel. Anything else is refused with 400 rather than ignored.

favorite is the viewer's own favorite of this listing, or null. Ask for it when you draw a heart that has to be able to turn itself off: removing a favorite needs its id, and without this a client has to fetch somebody's whole list to find one. favorited is the cheaper read when the heart is all you are drawing.

Available options:
seller,
watchModel,
images,
cover,
favorite
fields[watches]
string

Only these attributes, comma separated. Worth using on a full inventory walk: a listing carries a long description and a gallery, and a sync that only needs prices and stock does not want either.

sort
enum<string>

price, createdAt or updatedAt, prefixed with - for descending. year sorts only a catalogue search; here it is refused with 400 (search_only_sort).

Available options:
price,
-price,
createdAt,
-createdAt,
updatedAt,
-updatedAt
filter[status]
string

One status, or several separated by commas. A word we do not know matches nothing rather than everything.

Examples:

"available"

"draft,awaiting_update"

filter[reference]
string

The manufacturer's reference, exactly as stored.

Example:

"126610LN"

filter[q]
string

Words, matched as the dashboard's listing search matches them: in the name, the reference, your dealerProductCode or externalIdentifier, or brand and model as one phrase (Omega Seamaster). Not the catalogue's ranked search.

Example:

"RLX-116610LN-02"

filter[externalIdentifier]
string

Your own id. Several at once either comma-separated (filter[externalIdentifier]=PIM-10294,PIM-10295) or as a list (filter[externalIdentifier][]=PIM-10294&filter[externalIdentifier][]=PIM-10295); an id with a comma in it has to go in the list form.

Response

A page of this business's listings.

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.