Skip to main content
GET
List a retailer's online storefronts

Authorizations

X-API-Key
string
header
required

Path Parameters

retailer_id
string<shortuuid>
required

Unique identifier of the retailer whose storefronts to list.

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

Query Parameters

country
string

Only storefronts serving this ISO 3166-1 alpha-2 country. Case-insensitive. A syntactically valid code that is not assigned to any country matches nothing and returns an empty page rather than an error — this filters, it does not validate.

Required string length: 2
Pattern: ^[A-Za-z]{2}$
is_active
boolean

Only active (true) or only retired (false) storefronts. 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
StorefrontDetailOut · 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: