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

# Save a QR-resolved URL as a product redirect

> Persist a URL — typically the ``final_url`` from ``/resolve-url`` — as a PRODUCT-scoped resolution rule on the product linked to this capture.

Returns ``400`` when the capture has no linked product (the lookup pipeline either has not run yet or did not match). The client should retry once ``capture_status`` is ``COMPLETED``.

The rule is written into the organization that owns the product, so the product must be one **your** organization owns: another organization's product returns ``404`` (the status never confirms who claimed a GTIN), a credential whose role cannot contribute returns ``403``, and an unclaimed product returns ``409`` — claim it first.

The new rule is appended to the end of the product's existing rule list so it never silently jumps ahead of a manually-curated rule. Manage / reorder via the resolver UI.



## OpenAPI

````yaml /openapi/openapi-scanner.json post /scanner/api/v1/captures/{short_id}/save-redirect
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 product 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/captures/{short_id}/save-redirect:
    post:
      tags:
        - Scanner Resolve
      summary: Save a QR-resolved URL as a product redirect
      description: >-
        Persist a URL — typically the ``final_url`` from ``/resolve-url`` — as a
        PRODUCT-scoped resolution rule on the product linked to this capture.


        Returns ``400`` when the capture has no linked product (the lookup
        pipeline either has not run yet or did not match). The client should
        retry once ``capture_status`` is ``COMPLETED``.


        The rule is written into the organization that owns the product, so the
        product must be one **your** organization owns: another organization's
        product returns ``404`` (the status never confirms who claimed a GTIN),
        a credential whose role cannot contribute returns ``403``, and an
        unclaimed product returns ``409`` — claim it first.


        The new rule is appended to the end of the product's existing rule list
        so it never silently jumps ahead of a manually-curated rule. Manage /
        reorder via the resolver UI.
      operationId: apps_scanner_api_resolve_endpoints_save_redirect_endpoint
      parameters:
        - in: path
          name: short_id
          schema:
            description: Unique capture short_id identifier.
            title: Short Id
            type: string
          required: true
          description: Unique capture short_id identifier.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveRedirectSchema'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveRedirectResponseSchema'
        '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:
    SaveRedirectSchema:
      description: Request body for accepting a resolved URL as a product redirect.
      examples:
        - resolved_url: https://www.brand.example/products/widget
      properties:
        resolved_url:
          description: >-
            URL to persist as the redirect destination. Stored as-is — no
            further transformation, no tracking-param stripping in v1. Typically
            the ``final_url`` returned by ``/resolve-url``.
          maxLength: 2048
          minLength: 1
          title: Resolved Url
          type: string
      required:
        - resolved_url
      title: SaveRedirectSchema
      type: object
    SaveRedirectResponseSchema:
      description: Result of saving a resolved URL as a PRODUCT-scoped resolution rule.
      examples:
        - custom_url: https://www.brand.example/products/widget
          order_index: 3
          product_short_id: trail-mix-12oz
          rule_short_id: rule-a1b2c3
      properties:
        rule_short_id:
          description: Short ID of the new resolution rule.
          title: Rule Short Id
          type: string
        product_short_id:
          description: Short ID of the linked product.
          title: Product Short Id
          type: string
        custom_url:
          description: Persisted custom URL on the rule.
          title: Custom Url
          type: string
        order_index:
          description: >-
            Evaluation index assigned to the new rule within the PRODUCT scope.
            Appended to the end of any existing list.
          minimum: 0
          title: Order Index
          type: integer
      required:
        - rule_short_id
        - product_short_id
        - custom_url
        - order_index
      title: SaveRedirectResponseSchema
      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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.