> ## 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. # Get in-store promotion > Retrieve a single in-store offer promotion by UUID. Returns ``404`` when the promotion does not exist or the caller lacks the ``VIEW`` permission on the parent offer's owning organization. ## OpenAPI ````yaml /openapi/openapi-retailers.json get /retailers/api/v1/in-store-promotions/{promotion_id} 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. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /retailers/api/v1/in-store-promotions/{promotion_id}: get: tags: - In-store Offer Promotions summary: Get in-store promotion description: >- Retrieve a single in-store offer promotion by UUID. Returns ``404`` when the promotion does not exist or the caller lacks the ``VIEW`` permission on the parent offer's owning organization. operationId: apps_retailers_api_in_store_promotion_api_get_in_store_promotion parameters: - in: path name: promotion_id schema: description: UUID of the in-store promotion to retrieve. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Promotion Id type: string required: true description: UUID of the in-store promotion to retrieve. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InStorePromotionOut' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: InStorePromotionOut: description: |- A time-windowed promotional price on an :class:`InStoreOffer`. Mirrors :class:`apps.retailers.models.InStoreOfferPromotion`. Currency is read-through from the parent ``PhysicalStore`` — the row itself only stores the bare decimal ``promotional_price``. examples: - currency: USD description: Black Friday weekend end_date: '2026-12-31T23:59:59Z' id: 9f8e7d6c-5b4a-3210-fedc-ba9876543210 is_active: true metadata: campaign_id: bf-2026 offer_id: c4d5e6f7-8901-2345-abcd-ef6789012345 promotion_type: SEASONAL promotional_price: '9.99' short_id: keATfB8VP2gSjcnTbsMNQL start_date: '2026-11-25T00:00:00Z' properties: metadata: additionalProperties: type: string description: >- Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars. title: Metadata type: object id: description: >- Stable UUID primary key of the promotion. Use this for cross-references. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Id type: string short_id: description: >- URL-safe shortuuid (base57) encoding of ``id``. Up to 22 characters; preferred over ``id`` in human-shareable URLs and log lines. maxLength: 22 title: Short Id type: string offer_id: description: >- UUID of the parent ``InStoreOffer`` this promotion applies to. The offer must already exist; create it via the in-store offers API before attaching promotions. Immutable after creation — moving a promotion to a different offer means deleting and recreating. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Offer Id type: string promotional_price: description: >- Time-windowed override for the offer's regular ``price`` in the parent store's currency. Must be non-negative. When multiple promotions overlap on the same offer the cheapest active one wins; ``$0`` is allowed and intentional for free-with-purchase BOGO arms (it is not a sentinel for 'unknown'). pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Promotional Price type: string currency: default: '' description: >- ISO 4217 currency code lifted from the parent ``PhysicalStore.currency`` at read time. Read-only here — there is no per-promotion currency override; the store decides. maxLength: 3 title: Currency type: string start_date: description: >- Timestamp at which this promotion becomes effective (inclusive). Must be strictly before ``end_date`` — the database enforces ``end_date > start_date``. format: date-time title: Start Date type: string end_date: description: >- Timestamp at which this promotion stops being effective (inclusive). A daily Celery beat task flips ``is_active`` to ``false`` once this passes; the row is kept for historical pricing rather than deleted. format: date-time title: End Date type: string promotion_type: allOf: - $ref: '#/components/schemas/PromotionTypeEnum' default: SALE description: >- Merchandising context — display-only, does not change resolution semantics. Use ``SEASONAL`` for time-of-year promotions (Black Friday, holiday), ``CLEARANCE`` for end-of-life inventory, ``BOGO`` for buy-one-get-one arms (often at ``promotional_price=0``), ``BUNDLE`` for discounts that apply when buying with another product, ``INTRODUCTORY`` for launch pricing, ``LOYALTY`` for member-only prices, and ``SALE`` (the default) for everything else. description: default: '' description: >- Optional human-readable label shown alongside the promoted price (e.g. 'Black Friday weekend', 'Member appreciation week'). Free-form, up to 255 characters. Empty string when no label is needed. maxLength: 255 title: Description type: string is_active: default: true description: >- Soft-deactivate flag. ``true`` means the promotion is eligible for cheapest-active resolution within its date window; ``false`` excludes it (the daily beat task auto-flips this to ``false`` once ``end_date`` passes). Use the update endpoint to set this to ``false`` rather than deleting if you want to preserve the historical pricing row. title: Is Active type: boolean required: - id - short_id - offer_id - promotional_price - start_date - end_date title: InStorePromotionOut 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 PromotionTypeEnum: description: |- Merchandising context for an offer promotion. Mirrors :class:`apps.retailers.models.PromotionType`. Display-only — the choice does not affect resolution semantics (cheapest active promotion wins regardless of type). enum: - SALE - CLEARANCE - BOGO - BUNDLE - SEASONAL - INTRODUCTORY - LOYALTY title: PromotionTypeEnum type: string securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````