> ## Documentation Index > Fetch the complete documentation index at: https://docs.closient.com/llms.txt > Use this file to discover all available pages before exploring further. # List a retailer's online storefronts > Every online storefront (web property) declared for one retailer, paginated and including retired ones by default. This is the list a caller needs before sending listing URLs: a listing row's `store_url` must match an **active** storefront's root URL exactly, and a row naming one that does not exist comes back as `invalid` rather than creating the property. Reading the list first is how a caller tells a typo from a genuinely undeclared property. Reading a canonical (Closient-curated) retailer's storefronts needs only an authenticated caller. An organization-private retailer requires view access on the organization that owns it, and a credential scoped to a different organization gets `404` rather than `403`, so the API never confirms that another organization's retailer exists. ## OpenAPI ````yaml /openapi/openapi-retailers.json get /retailers/api/v1/retailers/{retailer_id}/storefronts openapi: 3.1.0 info: title: Retailers API version: 1.0.0 description: > Manage retailers, in-store offers, and online offers. ## Authentication All endpoints require an API key passed via the `X-API-Key` HTTP header, unless otherwise noted. ``` X-API-Key: csb__ ``` Generate API keys in **Settings > API Keys** in your dashboard, or via the Account API. Session-based (cookie) authentication is also accepted for browser-based access. ## Rate Limits | Tier | Requests / minute | Requests / day | |-------------|-------------------|----------------| | Default | 300 | 10,000 | | Custom | Contact us | Contact us | Rate-limit headers are included on every response so callers can self-throttle without hitting our 429s ("informed governor"): - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400` - `RateLimit-Limit` — quota for the **most-restrictive** currently-active window - `RateLimit-Remaining` — requests left in that window - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew safe) Legacy `X-RateLimit-*` aliases are also emitted for back-compat. `X-RateLimit-Reset` keeps the absolute Unix-timestamp shape to avoid breaking existing consumers. When rate-limited, you receive `429 Too Many Requests` with a `retry_after_seconds` field in the error envelope and a `Retry-After` header. ## Pagination List endpoints return paginated results in this envelope: ```json { "data": [...], "pagination": { "page": 1, "page_size": 25, "total_count": 342, "total_pages": 14, "has_next": true, "has_previous": false } } ``` Use `?page=2&page_size=50` query parameters. Maximum page size is 100. ## Error Responses All errors conform to [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) with `Content-Type: application/problem+json`: ```json { "type": "https://closient.com/docs/errors/not_found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "error_code": "not_found", "retryable": false, "timestamp": "2026-03-31T12:00:00+00:00" } ``` Common error codes: `unauthorized` (401), `forbidden` (403), `not_found` (404), `validation_error` (422), `rate_limited` (429), `internal_error` (500). termsOfService: https://www.closient.com/terms/ servers: - url: https://www.closient.com security: [] tags: - name: Retailers description: Manage retailers (canonical and org-private). - name: In-store Offers description: Per-store physical offers (aisle, on-hand quantity, pickup). - name: Online Offers description: Per-storefront online offers (URL, delivery, fulfillment). - name: In-store Offer Promotions description: Time-windowed promotional pricing on in-store offers. - name: Online Offer Promotions description: Time-windowed promotional pricing on online offers. - name: Retailer Stores description: >- Physical storefront upsert, reconciled against existing stores by store number, then proximity, then normalised address — a match enriches in place rather than creating a near-duplicate. - name: Retailer Listings description: >- Retailer-scoped product listings (SKU, badges, per-property URLs, extensible attributes) and the web properties those URLs attach to. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /retailers/api/v1/retailers/{retailer_id}/storefronts: get: tags: - Retailer Listings summary: List a retailer's online storefronts description: >- Every online storefront (web property) declared for one retailer, paginated and including retired ones by default. This is the list a caller needs before sending listing URLs: a listing row's `store_url` must match an **active** storefront's root URL exactly, and a row naming one that does not exist comes back as `invalid` rather than creating the property. Reading the list first is how a caller tells a typo from a genuinely undeclared property. Reading a canonical (Closient-curated) retailer's storefronts needs only an authenticated caller. An organization-private retailer requires view access on the organization that owns it, and a credential scoped to a different organization gets `404` rather than `403`, so the API never confirms that another organization's retailer exists. operationId: apps_retailers_api_listing_catalog_list_retailer_storefronts parameters: - in: path name: retailer_id schema: description: Unique identifier of the retailer whose storefronts to list. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Retailer Id type: string required: true description: Unique identifier of the retailer whose storefronts to list. - in: query name: country schema: description: >- 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. title: Country maxLength: 2 minLength: 2 pattern: ^[A-Za-z]{2}$ type: string required: false description: >- 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. - in: query name: is_active schema: description: >- Only active (`true`) or only retired (`false`) storefronts. Omit for both. title: Is Active type: boolean required: false description: >- Only active (`true`) or only retired (`false`) storefronts. Omit for both. - in: query name: page schema: default: 1 description: Page number (1-indexed). minimum: 1 title: Page type: integer required: false description: Page number (1-indexed). - in: query name: page_size schema: default: 25 description: Number of items per page (max 100). maximum: 100 minimum: 1 title: Page Size type: integer required: false description: Number of items per page (max 100). responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedStorefrontDetailOut' '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '404': description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '405': description: Method Not Allowed content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '422': description: Unprocessable Content content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - CookieGatedSessionAuth: [] components: schemas: PagedStorefrontDetailOut: properties: data: description: >- 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. items: $ref: '#/components/schemas/StorefrontDetailOut' title: Data type: array pagination: $ref: '#/components/schemas/PaginationMeta' description: Pagination envelope describing position within the full result set. required: - data - pagination title: PagedStorefrontDetailOut type: object ErrorOut: description: |- RFC 9457 Problem Details response. All API errors are returned in this format with Content-Type: application/problem+json. examples: - detail: The requested resource was not found. error_code: not_found retryable: false status: 404 timestamp: '2026-03-31T12:00:00+00:00' title: Not Found type: https://closient.com/docs/errors/not_found - detail: Validation error. details: - loc: - body - name msg: Field required type: missing error_code: validation_error retryable: false status: 422 timestamp: '2026-03-31T12:00:00+00:00' title: Validation Error type: https://closient.com/docs/errors/validation_error - detail: Rate limit exceeded. Please try again later. error_code: rate_limited retry_after: 31 retryable: true status: 429 timestamp: '2026-03-31T12:00:00+00:00' title: Rate Limited type: https://closient.com/docs/errors/rate_limited properties: type: description: URI reference identifying the error type. title: Type type: string title: description: Short human-readable summary of the error. title: Title type: string status: description: HTTP status code. title: Status type: integer detail: description: Human-readable explanation of this specific occurrence. title: Detail type: string error_code: description: Machine-readable error code (e.g. not_found, unauthorized). title: Error Code type: string retryable: default: false description: Whether retrying the same request can succeed. title: Retryable type: boolean timestamp: description: ISO 8601 timestamp of when the error occurred. title: Timestamp type: string retry_after: anyOf: - type: integer - type: 'null' description: Seconds to wait before retrying (when applicable). title: Retry After owner_action_required: anyOf: - type: boolean - type: 'null' description: Whether the error requires account owner intervention. title: Owner Action Required details: description: Additional context (validation errors, etc.). title: Details required: - type - title - status - detail - error_code - timestamp title: ErrorOut type: object StorefrontDetailOut: description: >- One online storefront as the catalog holds it. Distinct from ``StorefrontOut`` in ``listings.py``, which is the *result of a write* — it carries ``created: true/false`` for "did this call create the row" and would be meaningless on a read. examples: - country: CA created: '2026-01-15T10:00:00Z' currency: CAD id: c3d4e5f6789012345abcdef012 is_active: true locale: en-CA modified: '2026-02-01T09:30:00Z' name: Sephora Canada platform: salesforce_commerce retailer_id: f47ac10b58cc4372a5670e02b2 url: https://www.sephora.ca properties: id: description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Id type: string retailer_id: description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Retailer Id type: string name: description: Display name of the web property. title: Name type: string url: description: >- Root URL of the storefront — its identity within the retailer, and the value a listing's `urls[].store_url` matches against. title: Url type: string platform: $ref: '#/components/schemas/OnlineStorePlatformEnum' description: >- E-commerce software or marketplace powering the store. `unknown` is a valid answer. country: default: '' description: Primary country this storefront serves, ISO 3166-1 alpha-2. title: Country type: string locale: default: '' description: BCP 47 locale tag the storefront presents in, e.g. `en-CA`. title: Locale type: string currency: default: '' description: ISO 4217 code this storefront transacts in. title: Currency type: string is_active: description: >- False for a retired property. Only active storefronts may be referenced by a listing URL, and `DELETE` clears this flag rather than removing the row. title: Is Active type: boolean created: description: When this storefront row was first written. format: date-time title: Created type: string modified: description: When this storefront row last changed. format: date-time title: Modified type: string required: - id - retailer_id - name - url - platform - is_active - created - modified title: StorefrontDetailOut type: object PaginationMeta: description: >- Page envelope returned alongside ``data`` on every paginated list endpoint. examples: - has_next: true has_previous: false page: 1 page_size: 25 total_count: 342 total_pages: 14 properties: page: description: >- 1-indexed page number that was returned. Echoes the ``?page=`` query parameter. examples: - 1 minimum: 1 title: Page type: integer page_size: description: >- Number of items returned in ``data`` for this page. Capped at the endpoint's ``max_page_size`` (typically 100). examples: - 25 minimum: 1 title: Page Size type: integer total_count: description: Total number of items matching the query across all pages. examples: - 342 minimum: 0 title: Total Count type: integer total_pages: description: >- Total number of pages at the current ``page_size``. Always at least 1 (an empty result still reports ``total_pages: 1``). examples: - 14 minimum: 1 title: Total Pages type: integer has_next: description: >- True when ``page < total_pages`` — clients can request ``page=page+1`` to continue. examples: - true title: Has Next type: boolean has_previous: description: >- True when ``page > 1`` — clients can request ``page=page-1`` to go back. examples: - false title: Has Previous type: boolean required: - page - page_size - total_count - total_pages - has_next - has_previous title: PaginationMeta type: object OnlineStorePlatformEnum: description: >- Mirror of :class:`apps.retailers.models.OnlineStorePlatform`. The e-commerce software or marketplace powering a retailer's web property. It is read for behaviour, not display: the integrations layer picks how to connect to a storefront from this value (Shopify Storefront API, Amazon SP-API, WooCommerce REST, a scrape profile). ``unknown`` is a real answer rather than a missing one — plenty of sites cannot be classified from the outside, and recording that honestly is what keeps "we have not looked" distinguishable from "we looked and it is custom" (``custom``). enum: - shopify - bigcommerce - woocommerce - magento - salesforce_commerce - sap_hybris - squarespace - wix - webflow - prestashop - opencart - custom - amazon - walmart - etsy - ebay - target_plus - unknown title: OnlineStorePlatformEnum type: string securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer CookieGatedSessionAuth: type: apiKey in: cookie name: sessionid ````