> ## 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. # Declare a retailer web property > Create or update one of the retailer's online storefronts, keyed on its root URL. A retailer has one property per country it sells through online — `sephora.com` for the US, `sephora.ca` for Canada — and each carries its own product URLs, which is what lets a hosted page pick the right URL for the visitor's country. This endpoint exists because listings deliberately never create a storefront implicitly: at import scale that would fabricate retailer web properties nobody confirmed exist. Declare the property once here, then reference its root URL as `store_url` on listing rows. Sending the same `url` again updates that property rather than adding a second one. `retailer_id` is a `retailers.Retailer`. An organization-private retailer requires OWNER or MANAGER on the organization that owns it; a canonical (Closient-curated) retailer requires a staff account. ## OpenAPI ````yaml /openapi/openapi-retailers.json post /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: post: tags: - Retailer Listings summary: Declare a retailer web property description: >- Create or update one of the retailer's online storefronts, keyed on its root URL. A retailer has one property per country it sells through online — `sephora.com` for the US, `sephora.ca` for Canada — and each carries its own product URLs, which is what lets a hosted page pick the right URL for the visitor's country. This endpoint exists because listings deliberately never create a storefront implicitly: at import scale that would fabricate retailer web properties nobody confirmed exist. Declare the property once here, then reference its root URL as `store_url` on listing rows. Sending the same `url` again updates that property rather than adding a second one. `retailer_id` is a `retailers.Retailer`. An organization-private retailer requires OWNER or MANAGER on the organization that owns it; a canonical (Closient-curated) retailer requires a staff account. operationId: apps_retailers_api_listings_declare_storefront parameters: - in: path name: retailer_id schema: description: Unique identifier of the retailer this property belongs to. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Retailer Id type: string required: true description: Unique identifier of the retailer this property belongs to. requestBody: content: application/json: schema: $ref: '#/components/schemas/StorefrontIn' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StorefrontOut' '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: StorefrontIn: description: One of a retailer's web properties. examples: - country: CA currency: CAD is_active: true name: Sephora Canada url: https://www.sephora.ca properties: url: description: >- Root URL of the storefront — its identity, and the value a listing's `urls[].store_url` must match. Unique per retailer, so sending the same URL again updates the property rather than adding a second one. Must be an absolute `http(s)` URL. The constraint is published rather than merely enforced, because this value is matched **verbatim** against a listing's `store_url`: a storefront stored with a malformed URL is one no listing can ever reference, and nothing downstream would report that. maxLength: 500 pattern: ^https?://[^\s/?#]+[^\s]*$ title: Url type: string name: default: '' description: Display name. Defaults to ' Online' when blank. maxLength: 255 title: Name type: string currency: default: USD description: >- ISO 4217 code this storefront transacts in — three uppercase letters. Offers attached here use it for their prices. A pattern rather than an enum of codes: `OnlineStore.currency` carries no `choices`, so an enum here would publish a constraint the model does not enforce and would drift from it silently. pattern: ^[A-Z]{3}$ title: Currency type: string country: anyOf: - description: >- ISO 3166-1 alpha-2 country code (``US``, ``CA``, ``GB``). Case-insensitive on input and normalized to upper case; unassigned codes are rejected with a 422. format: iso3166-alpha2 maxLength: 2 minLength: 2 pattern: ^[A-Za-z]{2}$ type: string - type: 'null' description: >- Primary country this storefront serves, ISO 3166-1 alpha-2. Omit to leave unset. title: Country is_active: default: true description: >- Disable without deleting when a property goes dark. Only **active** storefronts can be referenced by a listing URL. title: Is Active type: boolean required: - url title: StorefrontIn type: object StorefrontOut: description: The retailer web property this call created or updated. examples: - created: true storefront_id: c3d4e5f6-7890-1234-abcd-ef3456789012 url: https://www.sephora.ca properties: storefront_id: description: Identifier of the storefront. title: Storefront Id type: string url: description: Root URL, i.e. the value listings reference as `store_url`. title: Url type: string created: description: True when this call created the property, false when it updated one. title: Created type: boolean required: - storefront_id - url - created title: StorefrontOut 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 securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer CookieGatedSessionAuth: type: apiKey in: cookie name: sessionid ````