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

# Resolve freshness chip thresholds for a scanned GTIN

> Return the color-coded freshness-chip thresholds for a scanned GTIN, resolved from the GPC-brick → category-threshold config (C-2861) and any per-brand organization overrides.

Called by the public ``/scan/`` overlay after a Digital Link / DataMatrix decode: the chip first renders with the client-side default thresholds, then re-tints with the values returned here.

Anonymous-allowed — no API key required. Always returns ``200`` with a usable threshold set: an unknown or malformed GTIN falls back to the global-default thresholds so the chip never breaks.



## OpenAPI

````yaml /openapi/openapi-scanner.json get /scanner/api/v1/freshness-thresholds
openapi: 3.1.0
info:
  title: Scanner API
  version: 1.0.0
  description: >
    Barcode and product scanning with vision extraction.


    ## 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: Scanner Sessions
    description: Create and manage barcode scanning sessions.
  - name: Scanner Captures
    description: Record barcode scan captures within sessions.
  - name: Scanner Enrichment
    description: Enrich scanned items with product data.
  - name: Scanner Photos
    description: Manage photos attached to scan sessions.
  - name: Scanner Upload
    description: Upload scan data in bulk.
  - name: Scanner Resolve
    description: >-
      Dual-scan QR resolve: follow QR redirect chains and save the canonical URL
      as a trade-item redirect (C-503).
  - name: Scanner Freshness
    description: >-
      Resolve color-coded freshness-chip thresholds for a scanned GTIN from the
      GPC-brick category config (C-2987). Anonymous-allowed; consumed by the
      public /scan/ overlay.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /scanner/api/v1/freshness-thresholds:
    get:
      tags:
        - Scanner Freshness
      summary: Resolve freshness chip thresholds for a scanned GTIN
      description: >-
        Return the color-coded freshness-chip thresholds for a scanned GTIN,
        resolved from the GPC-brick → category-threshold config (C-2861) and any
        per-brand organization overrides.


        Called by the public ``/scan/`` overlay after a Digital Link /
        DataMatrix decode: the chip first renders with the client-side default
        thresholds, then re-tints with the values returned here.


        Anonymous-allowed — no API key required. Always returns ``200`` with a
        usable threshold set: an unknown or malformed GTIN falls back to the
        global-default thresholds so the chip never breaks.
      operationId: apps_scanner_api_freshness_endpoints_freshness_thresholds_endpoint
      parameters:
        - in: query
          name: gtin
          schema:
            description: The scanned GTIN (8/12/13/14 digits, hyphens/spaces tolerated).
            maxLength: 20
            minLength: 1
            title: Gtin
            type: string
          required: true
          description: The scanned GTIN (8/12/13/14 digits, hyphens/spaces tolerated).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreshnessThresholdsSchema'
components:
  schemas:
    FreshnessThresholdsSchema:
      description: |-
        Resolved freshness-chip thresholds for a scanned GTIN (C-2987).

        Returned by ``GET /freshness-thresholds`` and threaded into the
        scanner overlay's ``summarizeDateAis`` so the color-coded chip tints
        against the right category window (fresh produce expires far sooner
        than canned goods). Mirrors
        :class:`apps.products.services.freshness.Thresholds`; the day fields
        use the camelCase shape the client-side
        ``DEFAULT_FRESHNESS_THRESHOLDS`` already expects.
      examples:
        - categoryLabel: Fresh / refrigerated
          criticalDays: 3
          source: global-default
          warningDays: 7
      properties:
        warningDays:
          description: >-
            Days-remaining at or above which the chip is tinted 'fresh'. Below
            this (but at or above ``criticalDays``) the chip is 'warning'.
          minimum: 0
          title: Warningdays
          type: integer
        criticalDays:
          description: >-
            Days-remaining below which the chip is tinted 'expired'. Always less
            than or equal to ``warningDays``.
          minimum: 0
          title: Criticaldays
          type: integer
        categoryLabel:
          description: >-
            Human-readable category label for the matched GPC brick (e.g. 'Fresh
            / refrigerated'). Surfaced as the chip's secondary text.
            Empty-string is never returned — the fallback layers always carry a
            label.
          title: Categorylabel
          type: string
        source:
          description: >-
            Which precedence layer produced these values: ``org-override`` |
            ``org-fallback`` | ``global-default`` | ``global-fallback`` |
            ``built-in``. Useful for transparency and debugging which rule
            applied.
          title: Source
          type: string
      required:
        - warningDays
        - criticalDays
        - categoryLabel
        - source
      title: FreshnessThresholdsSchema
      type: object

````