Look up a product by identifier/URL, or search by category

This endpoint has two mutually exclusive modes, selected by which
query parameters are present. Mixing them is a 400, as is any query
parameter not valid for the selected mode.

Identifier/URL lookup — exactly one of gtin or url, plus
optional retailer and region. Returns a single Product. At MVP,
gtin and url are the only supported lookup identifiers.

Category searchcategory, plus optional limit and cursor.
retailer and region are not accepted in this mode. Returns a
paginated CategorySearchResponse.

Results are filtered to the retailers your organization is entitled
to; disallowed items are silently omitted from the page rather than
causing an error, so meta.count can be smaller than limit even
when more results exist. Use meta.next_cursor (not meta.count) to
decide whether to keep paging: it is "" once there are no more
results. The cursor is opaque — treat it as an unparsed token from the
previous response, not something to construct yourself.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Global Trade Item Number. Identifier lookup mode. Mutually exclusive with url and category.

uri

A retailer product page URL. Identifier lookup mode. Mutually exclusive with gtin and category.

string

Identifier lookup mode only; a 400 if combined with category.
Optional retailer slug to scope the lookup. If the resolved
product belongs to a different retailer, the response is 404
rather than the product from the unscoped retailer.

string
Defaults to us

Identifier lookup mode only; a 400 if combined with category.
See the note on /products/{retailer}/{product_id}.

string

Category search mode. Mutually exclusive with gtin and url.

integer
Defaults to 20

Category search mode only; a 400 if combined with gtin or
url. Page size. Server-configured default and maximum currently
20 and 50; a value outside 1..max is a 400.

string

Category search mode only; a 400 if combined with gtin or
url. Opaque pagination cursor from a previous response's
meta.next_cursor. Omit for the first page.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json