> ## 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.

# Create consumable

> List one of the organization's products as a consumable of another. Requires CONTRIBUTE on the organization. 404 if either GTIN isn't a product the organization owns; 409 if the pair already exists; 422 if a product is made its own consumable. Nothing is created on error.



## OpenAPI

````yaml /openapi/openapi-products.json post /products/api/v1/consumables
openapi: 3.1.0
info:
  title: Products API
  version: 1.0.0
  description: >
    Look up, claim, and browse GTINs in the Closient product repository.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    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: Products
    description: Look up, claim, and browse products and trade items.
  - name: Product Group
    description: Manage GDSN packaging hierarchy relationships.
  - name: Import
    description: >-
      Bulk import products, batch/lots (GS1 AI 10) and serial numbers (GS1 AI
      21) from CSV, TSV or XLSX files, with a downloadable template per entity.
  - name: QR
    description: Generate QR codes encoding GS1 Digital Link URLs.
  - name: Codes
    description: Generate GS1 DataMatrix and 1D barcodes (EAN/UPC/ITF-14/Code128).
  - name: Digital Link
    description: >-
      Parse GS1 Digital Link URIs into structured AIs (GTIN, lot, expiry,
      serial).
  - name: Labels
    description: >-
      Bulk label-export jobs: ZIPs of QR / DataMatrix / 1D symbols and multi-up
      sheet PDFs, async via Celery with status polling.
  - name: Lots
    description: >-
      Lot generator v2: format templates with persistent counters,
      reserve/commit/discard runs, soft/hard collision handling, and an async
      Celery path with SSE progress.
  - name: Retailer Catalog Import
    description: >-
      Server-side retailer catalog import jobs: stage normalised rows, then run
      the GTIN-keyed cross-retailer merge with a dry-run mode, per-field
      provenance and a quarantine report for every row refused.
  - name: HRI Presets
    description: >-
      Saved, named per-organisation Human Readable Interpretation (HRI)
      configurations — placement, layout, notation and typography. Referenceable
      by name from the QR generation endpoint, with an org default applied when
      no options or preset are supplied.
  - name: PIP Embed (Public)
    description: >-
      Unauthenticated, cross-origin read powering the embeddable PIP panel
      (`/widget/v1/pip-panel.js`) that retailers drop into their own product
      detail pages. Reduced to the disclosure level the hosted page would serve
      an anonymous visitor.
  - name: Recipes
    description: >-
      Recipes shown on a product's hosted page. Create a recipe, attach it to
      the organization's products by GTIN, and update or delete it.
  - name: Firmware
    description: >-
      Firmware releases shown on a product's hosted page. Publish a release for
      the organization's products by GTIN, mark it latest or stable, and update
      or delete it.
  - name: App Links
    description: >-
      Companion-app download and launch links shown on a product's hosted page,
      one per platform. Create, list, update and delete the links on the
      organization's products.
  - name: Replacement Parts
    description: >-
      Replacement parts shown on a product's hosted page. List one of the
      organization's products as a part of another, repoint it, or remove it.
  - name: Accessories
    description: >-
      Accessories shown on a product's hosted page. List one of the
      organization's products as an accessory of another, repoint it, or remove
      it.
  - name: Consumables
    description: >-
      Consumables shown on a product's hosted page (filters, refills,
      cartridges). List one of the organization's products as a consumable of
      another, with its lifespan and whether it is required, repoint it, or
      remove it.
  - name: Product Families
    description: >-
      Consumer variant groups: one organization's products that are the same
      concept in different sizes, shades, flavors or scents. Create a family,
      then add, update, reorder and remove its member products. Distinct from
      Product Group, which is packaging hierarchy.
  - name: Product Links
    description: >-
      Generic, GS1-link-type-keyed brand CTA links (e.g. reviews, promotions,
      loyalty programs, homepage) attached to a product or a brand and rendered
      on the hosted page.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /products/api/v1/consumables:
    post:
      tags:
        - Consumables
      summary: Create consumable
      description: >-
        List one of the organization's products as a consumable of another.
        Requires CONTRIBUTE on the organization. 404 if either GTIN isn't a
        product the organization owns; 409 if the pair already exists; 422 if a
        product is made its own consumable. Nothing is created on error.
      operationId: apps_products_api_consumables_create_consumable
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsumableCreate'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumableOut'
        '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'
        '409':
          description: Conflict
          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:
    ConsumableCreate:
      description: Payload for ``POST /consumables``.
      examples:
        - consumable_gtin: '00850012345671'
          estimated_lifespan: 6 months
          gtin: '00850012345688'
          is_required: true
          note: Replace when the indicator light turns red.
      properties:
        gtin:
          description: >-
            GTIN (8, 12, 13 or 14 digits) of the product the consumable belongs
            to. Must be a product the caller's organization owns, else 404.
          format: gtin
          maxLength: 14
          minLength: 8
          title: Gtin
          type: string
        consumable_gtin:
          description: >-
            GTIN of the product that is the consumable. Must be a product the
            same organization owns, else 404 and nothing is created.
          format: gtin
          maxLength: 14
          minLength: 8
          title: Consumable Gtin
          type: string
        estimated_lifespan:
          default: ''
          description: How long one unit lasts, as free text (for example 6 months).
          maxLength: 100
          pattern: ^[^\x00]{0,100}$
          title: Estimated Lifespan
          type: string
        is_required:
          default: false
          description: Whether the product needs this consumable to work.
          title: Is Required
          type: boolean
        note:
          default: ''
          description: Short note shown with the consumable.
          maxLength: 255
          pattern: ^[^\x00]{0,255}$
          title: Note
          type: string
      required:
        - gtin
        - consumable_gtin
      title: ConsumableCreate
      type: object
    ConsumableOut:
      description: A consumable of one of the organization's products.
      examples:
        - consumable:
            gtin: '00850012345671'
            id: 8Jw2nQxK5vTbR3mYcLdZaE
            product_name: Carrying Case
          created: '2026-09-30T09:00:00Z'
          estimated_lifespan: 6 months
          id: F5n5NdW6dTbvPYkgnLNjte
          is_required: true
          modified: '2026-09-30T09:00:00Z'
          note: Replace when the indicator light turns red.
          organization_id: 9fHkqR2aXcVbNmLpQwErTy
          product:
            gtin: '00850012345688'
            id: SBjSX6xUJPPHQKUXBpYX2C
            product_name: Countertop Water Purifier
      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
        organization_id:
          description: The organization that owns the product.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Organization Id
          type: string
        product:
          $ref: '#/components/schemas/ConsumableProductOut'
          description: The product the consumable is used with.
        consumable:
          $ref: '#/components/schemas/ConsumableProductOut'
          description: The product that serves as the consumable.
        estimated_lifespan:
          description: How long one unit lasts, as free text. Empty when unset.
          title: Estimated Lifespan
          type: string
        is_required:
          description: Whether the product needs this consumable to work.
          title: Is Required
          type: boolean
        note:
          description: Short note shown with the consumable. Empty when unset.
          title: Note
          type: string
        created:
          description: Server-side ISO 8601 timestamp of creation (UTC).
          format: date-time
          title: Created
          type: string
        modified:
          description: Server-side ISO 8601 timestamp of last modification (UTC).
          format: date-time
          title: Modified
          type: string
      required:
        - id
        - organization_id
        - product
        - consumable
        - estimated_lifespan
        - is_required
        - note
        - created
        - modified
      title: ConsumableOut
      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
    ConsumableProductOut:
      description: A product at one end of a consumable relationship.
      examples:
        - gtin: '00850012345671'
          id: 8Jw2nQxK5vTbR3mYcLdZaE
          product_name: Carrying Case
      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
        gtin:
          description: The product's GTIN, normalized to GTIN-14.
          title: Gtin
          type: string
        product_name:
          description: The product's name. Empty string when unknown.
          title: Product Name
          type: string
      required:
        - id
        - gtin
        - product_name
      title: ConsumableProductOut
      type: object
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````