> ## 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. # Generate a batch of QR codes asynchronously > Kick off a Celery task that renders one QR per item, packages them into a ZIP bundle, and uploads the bundle to object storage. Returns a task ID immediately (HTTP 202). Poll ``GET /qr/bulk/{task_id}/`` for status and the temporary download URL. Hard cap: 5000 items per request. ## OpenAPI ````yaml /openapi/openapi-products.json post /products/api/v1/qr/bulk/ 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__ ``` 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/qr/bulk/: post: tags: - QR summary: Generate a batch of QR codes asynchronously description: >- Kick off a Celery task that renders one QR per item, packages them into a ZIP bundle, and uploads the bundle to object storage. Returns a task ID immediately (HTTP 202). Poll ``GET /qr/bulk/{task_id}/`` for status and the temporary download URL. Hard cap: 5000 items per request. operationId: apps_products_api_qr_api_generate_qr_bulk parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/QRBulkPayload' required: true responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/QRBulkAcceptedOut' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: QRBulkPayload: description: |- Request body for the async bulk-QR endpoint. Every item in the bundle shares the same parent GTIN, output format, and size; only ``lot``/``serial``/``expiry`` vary per item. Hard cap of :data:`BULK_MAX_ITEMS` items per request to keep a single Celery task's runtime and ZIP-bundle size bounded. examples: - format: png gtin: '00012345678905' items: - expiry: '261231' lot: LOT-A001 serial: SER-0001 - expiry: '261231' lot: LOT-A001 serial: SER-0002 - expiry: '270630' lot: LOT-A002 serial: SER-0003 size: 400 properties: gtin: description: >- GTIN barcode (GTIN-8, 12, 13, or 14, with or without separators) shared by every item in the bundle. Normalized to GTIN-14 server-side. maxLength: 17 minLength: 8 pattern: ^[\d\s\-]{8,17}$ title: Gtin type: string format: allOf: - $ref: '#/components/schemas/BulkQRImageFormatEnum' default: png description: >- ``svg`` / ``eps`` for vector output (one file per symbol in the ZIP); ``png`` for raster output sized by ``size``. PDF is intentionally not offered here — multi-symbol PDFs go through the multi-up label sheet path (C-2602), not a ZIP of single-page PDFs. size: default: 400 description: >- Target image side length in pixels (50-2000) for every QR in the bundle. Ignored when ``format`` is ``svg`` or ``eps``. maximum: 2000 minimum: 50 title: Size type: integer items: description: >- List of items to render — must contain at least 1 and at most 5000 entries. Each entry varies only the GS1 AI values (lot, serial, expiry); the GTIN, format, and size come from the parent payload. items: $ref: '#/components/schemas/QRBulkItem' maxItems: 5000 minItems: 1 title: Items type: array required: - gtin - items title: QRBulkPayload type: object QRBulkAcceptedOut: description: |- Response for an accepted bulk job — always returned with HTTP 202. Receipt only; the actual ZIP bundle is built asynchronously. Poll ``poll_url`` to retrieve the signed download URL once status flips to ``completed``. examples: - items: 3 poll_url: /products/api/v1/qr/bulk/0c4d2a4e-3b5b-4d2b-9f1a-1c2d3e4f5a6b/ status: pending task_id: 0c4d2a4e-3b5b-4d2b-9f1a-1c2d3e4f5a6b properties: task_id: description: >- Celery task identifier (UUID4 format). Use to poll the status endpoint at ``GET /qr/bulk/{task_id}/``. title: Task Id type: string status: $ref: '#/components/schemas/BulkQRTaskStatusEnum' description: >- Initial task status — always ``pending`` on this 202 receipt. Subsequent polls may return ``running``, ``completed``, or ``failed``. items: description: >- Number of QR codes that will be generated (mirrors the request's ``items`` length). maximum: 5000 minimum: 1 title: Items type: integer poll_url: description: >- Relative URL of the polling endpoint for this task — combine with the API host to retrieve status. Embeds the same ``task_id`` for convenience. title: Poll Url type: string required: - task_id - status - items - poll_url title: QRBulkAcceptedOut 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 BulkQRImageFormatEnum: description: |- Output image format for the **bulk** QR-code endpoint. Narrower than :class:`QRImageFormatEnum` — bulk responses are ZIP bundles of one file per item, and per-item PDF is intentionally not supported there. PDF output for many symbols goes through the multi-up sheet path (C-2602), not a ZIP of single-page PDFs. ``eps`` and ``tif`` are offered alongside ``svg``/``png`` because, like SVG, each is a single file per symbol that drops cleanly into the ZIP. enum: - svg - png - eps - tif title: BulkQRImageFormatEnum type: string QRBulkItem: description: >- One item in a bulk QR request — lot/serial/expiry trio under a shared GTIN. The GTIN, format, and size live on the parent :class:`QRBulkPayload`; each item only varies the AI values. An item with all three fields null produces a Digital Link with just the GTIN (equivalent to a single-AI plain barcode). examples: - expiry: '261231' lot: LOT-A001 serial: SER-0001 properties: lot: anyOf: - maxLength: 20 minLength: 1 pattern: ^[\x21-\x7E]{1,20}$ type: string - type: 'null' description: >- Optional GS1 AI(10) lot identifier — 1-20 printable ASCII chars, no spaces. title: Lot serial: anyOf: - maxLength: 20 minLength: 1 pattern: ^[\x21-\x7E]{1,20}$ type: string - type: 'null' description: >- Optional GS1 AI(21) serial identifier — 1-20 printable ASCII chars, no spaces. title: Serial expiry: anyOf: - maxLength: 6 minLength: 6 pattern: ^\d{6}$ type: string - type: 'null' description: Optional GS1 AI(17) expiry date as ``YYMMDD`` — exactly 6 digits. title: Expiry title: QRBulkItem type: object BulkQRTaskStatusEnum: description: |- Lifecycle state of an async bulk QR generation task. Mirrors the status values produced by :func:`apps.products.services.qr_bulk.get_bulk_qr_status`. Two in-flight states (``pending``, ``running``) and two terminal states (``completed``, ``failed``). ``download_url``/``expires_at`` are populated only on ``completed``; ``error`` only on ``failed``. enum: - pending - running - completed - failed title: BulkQRTaskStatusEnum type: string securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````