> ## 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. # Parse a GS1 Digital Link URL into structured AIs > Accept a URL string; return the structured GS1 Digital Link components (GTIN, lot, expiry, serial, plus any other AIs found in the path). Returns `is_valid: false` when the URL is not a recognisable Digital Link rather than 4xx-erroring — callers can use a single endpoint to triage arbitrary scanned URLs. ## OpenAPI ````yaml /openapi/openapi-products.json post /products/api/v1/digital-link/parse 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/digital-link/parse: post: tags: - Digital Link summary: Parse a GS1 Digital Link URL into structured AIs description: >- Accept a URL string; return the structured GS1 Digital Link components (GTIN, lot, expiry, serial, plus any other AIs found in the path). Returns `is_valid: false` when the URL is not a recognisable Digital Link rather than 4xx-erroring — callers can use a single endpoint to triage arbitrary scanned URLs. operationId: apps_products_api_digital_link_parse_digital_link parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/DigitalLinkParseIn' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DigitalLinkParseOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: DigitalLinkParseIn: description: Request body for the parse endpoint. examples: - url: https://gtin1.com/01/00614141123452/10/LOT1/21/SN1?17=261231 properties: url: description: >- The candidate URL to parse. Should be a GS1 Digital Link URI of the form `https://{host}/01/{gtin}[/10/{lot}][/21/{serial}][?17={expiry}]`. examples: - https://gtin1.com/01/00614141123452/10/LOT1/21/SN1?17=261231 maxLength: 4096 minLength: 1 title: Url type: string required: - url title: DigitalLinkParseIn type: object DigitalLinkParseOut: description: >- Response body for the parse endpoint. ``is_valid`` is True when the input is a recognisable GS1 Digital Link (carries a ``/01/{gtin}`` segment with a valid Mod-10 GTIN) and False otherwise. When False, all the structured fields are null and ``raw_ais`` is empty — the caller should fall back to treating the URL as an arbitrary link rather than a GS1-aware payload. examples: - gtin: '00614141123452' is_valid: true lot: LOT1 raw_ais: '10': LOT1 '21': SN1 '01': '00614141123452' serial: SN1 url: https://gtin1.com/01/00614141123452/10/LOT1/21/SN1?17=261231 - is_valid: false raw_ais: {} url: https://example.com/blog-post properties: is_valid: description: >- True when the URL parses as a conformant GS1 Digital Link with a valid GTIN. title: Is Valid type: boolean url: description: The input URL, echoed back unchanged. title: Url type: string gtin: anyOf: - type: string - type: 'null' description: >- The normalized GTIN-14 if a `/01/` segment is present and Mod-10-valid; otherwise null. examples: - '00614141123452' title: Gtin lot: anyOf: - type: string - type: 'null' description: GS1 AI 10 (lot/batch) if present in the path. title: Lot expiry: anyOf: - type: string - type: 'null' description: >- GS1 AI 17 (expiry, YYMMDD) if present in the path. Note: GS1 spec allows AI 17 on the query string too — this v1 endpoint reads path-only per the underlying parser. examples: - '261231' title: Expiry serial: anyOf: - type: string - type: 'null' description: GS1 AI 21 (serial) if present in the path. title: Serial raw_ais: additionalProperties: type: string description: >- Every AI/value pair found in the path, including any non-first-class AIs not surfaced as named fields above. title: Raw Ais type: object required: - is_valid - url title: DigitalLinkParseOut type: object securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````