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

# Poll a bulk label-export job

> Returns the status of a previously submitted bulk-label-export job. When the job is complete, the response includes a temporary signed download URL for the artifact and an `expires_at` timestamp. Cross-org polling deliberately returns 404 (not 403) to prevent id enumeration.



## OpenAPI

````yaml /openapi/openapi-products.json get /products/api/v1/labels/export/{job_id}/
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 from CSV files.
  - 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.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /products/api/v1/labels/export/{job_id}/:
    get:
      tags:
        - Labels
      summary: Poll a bulk label-export job
      description: >-
        Returns the status of a previously submitted bulk-label-export job. When
        the job is complete, the response includes a temporary signed download
        URL for the artifact and an `expires_at` timestamp. Cross-org polling
        deliberately returns 404 (not 403) to prevent id enumeration.
      operationId: apps_products_api_labels_export_api_get_label_export_status
      parameters:
        - in: path
          name: job_id
          schema:
            description: >-
              `LabelExportJob.id` returned by `POST /labels/export/`. 22-char
              shortuuid. Malformed ids are rejected with 422 before hitting the
              DB.
            title: Job Id
            type: string
          required: true
          description: >-
            `LabelExportJob.id` returned by `POST /labels/export/`. 22-char
            shortuuid. Malformed ids are rejected with 422 before hitting the
            DB.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelExportStatusOut'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - SessionAuth: []
components:
  schemas:
    LabelExportStatusOut:
      description: |-
        Response for `GET /labels/export/{job_id}/`.

        Two terminal states (`completed`, `failed`) and two in-flight states
        (`pending`, `processing`). When `status='completed'`, `download_url`,
        `expires_at`, `output_filename`, and `file_size_bytes` are populated;
        when `status='failed'`, `error` carries the failure reason.
      examples:
        - download_url: >-
            https://closient-bulk.s3.amazonaws.com/exports/.../sheet-AbCd-42.pdf?X-Amz-...
          expires_at: '2026-05-08T13:00:00+00:00'
          file_size_bytes: 248321
          job_id: AbCdEfGhIjKlMnOpQrStUv
          output_filename: sheet-AbCdEfGh-42.pdf
          processed_items: 42
          progress_percent: 100
          status: completed
          total_items: 42
      properties:
        job_id:
          description: >-
            Job identifier (echoed from the request) used to look up this
            status.
          title: Job Id
          type: string
        status:
          $ref: '#/components/schemas/LabelExportStatusEnum'
          description: >-
            Lifecycle state — `pending` (queued, not yet picked up),
            `processing` (worker is rendering), `completed` (artifact uploaded;
            `download_url` populated), or `failed` (`error` populated).
        total_items:
          default: 0
          description: >-
            Total entity count the job's filters resolved to. Populated as soon
            as the worker has resolved the filter set; `0` while the job is
            still queued.
          minimum: 0
          title: Total Items
          type: integer
        processed_items:
          default: 0
          description: >-
            Number of entities written so far. Equals `total_items` when
            `status='completed'`. Useful for surfacing progress in a polling
            client.
          minimum: 0
          title: Processed Items
          type: integer
        progress_percent:
          default: 0
          description: >-
            Convenience field — `processed_items / total_items * 100`, capped at
            100.
          maximum: 100
          minimum: 0
          title: Progress Percent
          type: integer
        download_url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Temporary signed download URL for the completed artifact. Only
            present when `status='completed'`; null in every other state. URL
            expires at `expires_at`; refetch the status endpoint if expired.
          title: Download Url
        expires_at:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            ISO-8601 timestamp (with timezone) at which `download_url` stops
            working. Null when `download_url` is null.
          title: Expires At
        output_filename:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Human-readable filename of the completed artifact (e.g.
            `sheet-AbCd-42.pdf` or `datamatrix-lots-AbCd-42.zip`). Null until
            the job reaches `completed`.
          title: Output Filename
        file_size_bytes:
          default: 0
          description: Size of the completed artifact in bytes; `0` while in-flight.
          minimum: 0
          title: File Size Bytes
          type: integer
        error:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Human-readable error message. Populated only when `status='failed'`;
            null otherwise.
          title: Error
      required:
        - job_id
        - status
      title: LabelExportStatusOut
      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
    LabelExportStatusEnum:
      description: |-
        Lifecycle state of a bulk label-export job.

        Mirrors :class:`apps.products.models.LabelExportStatus`. ``pending``
        and ``processing`` are in-flight; ``completed`` and ``failed`` are
        terminal. The polling endpoint surfaces this directly.
      enum:
        - pending
        - processing
        - completed
        - failed
      title: LabelExportStatusEnum
      type: string
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    SessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````