Skip to main content
GET
List a retailer's product listings

Authorizations

X-API-Key
string
header
required

Path Parameters

retailer_id
string<shortuuid>
required

Unique identifier of the retailer whose listings to list.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

gtin
string

Only the listing for this GTIN, digits only. A retailer has at most one per product.

Required string length: 8 - 14
Pattern: ^\d+$
sku
string

Only listings carrying this exact retailer SKU.

Maximum string length: 100
is_active
boolean

Only listed (true) or only dropped (false) products. Omit for both.

page
integer
default:1

Page number (1-indexed).

Required range: x >= 1
page_size
integer
default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

OK

data
ListingOut · object[]
required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

pagination
PaginationMeta · object
required

Pagination envelope describing position within the full result set.

Example: