> ## 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 single QR code > Render a QR code for a GTIN with optional GS1 Application Identifiers (lot, serial, expiry). Returns the image bytes directly with the appropriate content-type (``image/svg+xml``, ``image/png``, ``application/pdf``, or ``application/postscript``). Single QR generation is synchronous because rendering is fast (<50ms) and cached. For batches, use ``POST /qr/bulk/``. **Caching**: responses are deterministic given the request body. The endpoint sets ``Cache-Control: public, max-age=2592000`` (30 days) and a strong ``ETag`` over the image bytes. Clients sending ``If-None-Match`` with a matching ETag get ``304 Not Modified``. ## OpenAPI ````yaml /openapi/openapi-products.json post /products/api/v1/qr/ 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/: post: tags: - QR summary: Generate a single QR code description: >- Render a QR code for a GTIN with optional GS1 Application Identifiers (lot, serial, expiry). Returns the image bytes directly with the appropriate content-type (``image/svg+xml``, ``image/png``, ``application/pdf``, or ``application/postscript``). Single QR generation is synchronous because rendering is fast (<50ms) and cached. For batches, use ``POST /qr/bulk/``. **Caching**: responses are deterministic given the request body. The endpoint sets ``Cache-Control: public, max-age=2592000`` (30 days) and a strong ``ETag`` over the image bytes. Clients sending ``If-None-Match`` with a matching ETag get ``304 Not Modified``. operationId: apps_products_api_qr_api_generate_qr parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/QRSinglePayload' required: true responses: '200': description: OK content: application/json: schema: format: binary title: Response type: string '304': description: Not Modified '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: QRSinglePayload: description: |- Request body for the synchronous single-QR endpoint. Encodes a GS1 Digital Link URL as a QR code. The ``gtin`` is the only required identifier; ``lot``, ``serial``, and ``expiry`` are GS1 Application Identifier values that, when present, are appended to the Digital Link path/query so a phone scan resolves to the most specific instance available. examples: - expiry: '261231' format: svg gtin: '00012345678905' lot: LOT-A001 serial: SER-0001 size: 400 properties: gtin: description: >- GTIN barcode (GTIN-8, 12, 13, or 14, with or without separators). Normalized to GTIN-14 server-side before encoding into the Digital Link URL. maxLength: 17 minLength: 8 pattern: ^[\d\s\-]{8,17}$ title: Gtin type: string lot: anyOf: - maxLength: 20 minLength: 1 pattern: ^[\x21-\x7E]{1,20}$ type: string - type: 'null' description: >- Optional GS1 AI(10) lot/batch identifier — 1-20 printable ASCII chars, no spaces. Encoded into the Digital Link path as ``/10/{lot}``. When present alongside ``serial``, both are added (lot before serial). 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. Encoded into the Digital Link path as ``/21/{serial}``. Use serial for unit-level traceability when each item carries a unique tag. 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 (e.g. ``261231`` for 2026-12-31). Encoded into the Digital Link query as ``?17={expiry}``. title: Expiry format: allOf: - $ref: '#/components/schemas/QRImageFormatEnum' default: png description: >- Output image format. ``svg`` for resolution-independent vector output; ``png`` for raster output sized by ``size``; ``pdf`` for single-page vector PDF (path operators in the content stream — for print houses that scale to label size at the press, not in the browser); ``eps`` for PostScript vector output that packaging-design tools ingest into Illustrator. size: default: 400 description: >- Target image side length in pixels (50-2000). QR codes are square, so this is both width and height. For ``format='svg'``, ``format='pdf'``, and ``format='eps'`` the value is treated as the target width in SVG user units / PostScript points (1pt = 1/72 inch ≈ 0.353mm), so a 400-unit symbol is roughly 140mm wide. Ignored when ``xdim_mm`` is set — X-dimension-correct sizing supersedes the pixel heuristic. maximum: 2000 minimum: 50 title: Size type: integer cmyk: default: false description: >- Emit CMYK process colours instead of RGB. Only valid with ``format='eps'`` — any other format returns 422. Use for print houses that ingest the EPS directly into a CMYK workflow, avoiding an RGB→CMYK conversion that can shift module ink density. title: Cmyk type: boolean xdim_mm: anyOf: - maximum: 10 minimum: 0.1 type: number - type: 'null' description: >- Target physical X-dimension (module width) in millimetres. When set, the symbol is sized so each module is exactly this wide on the printed surface (via Zint ``--scalexdimdp``), ``size`` is ignored, and physical-size metadata travels with the file (PNG ``pHYs`` chunk, TIF resolution IFD tags, SVG ``width``/``height`` in ``mm``). GS1 recommends 0.625 mm for consumer packaging; 0.495 mm is the GS1 minimum. Null keeps the legacy pixel-heuristic sizing. title: Xdim Mm dpmm: default: 11.81 description: >- Device resolution in dots per millimetre, used only when ``xdim_mm`` is set. Default 11.81 (300 dpi), matching the label/flexo presses we target. Affects the raster pixel grid for PNG/TIF; vector outputs (SVG/EPS) carry physical units regardless. maximum: 200 minimum: 1 title: Dpmm type: number required: - gtin title: QRSinglePayload 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 QRImageFormatEnum: description: |- Output image format for QR-code generation endpoints. Used by the synchronous single-QR endpoint. ``svg`` is resolution-independent vector output (``size`` controls the SVG width); ``png`` is raster output sized by the ``size`` parameter; ``pdf`` is single-page vector PDF for print workflows (C-2852) — the PDF content stream contains path operators rather than an embedded raster preview, so a print house can scale the symbol to its target label size without resolution loss; ``eps`` is PostScript vector output (C-2587) for packaging-design tools that ingest EPS into Illustrator; ``tif`` is high-resolution raster (TIFF) output (C-2980) for flexography / archival print workflows, carrying resolution IFD tags when an X-dimension is supplied. The bulk endpoint uses a narrower :class:`BulkQRImageFormatEnum` because per-symbol PDFs in a ZIP bundle are not a documented bulk output today — that capability lives behind the multi-up label sheet path (C-2602) instead. enum: - svg - png - pdf - eps - tif title: QRImageFormatEnum type: string securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````