> ## 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. # Create product link > Create a new CTA link for a product or brand. Returns 404 if the referenced product/brand doesn't exist or the caller lacks CONTRIBUTE permission on its owning organization; 422 if ``link_type`` isn't a recognised GS1 Web Vocabulary CURIE. ## OpenAPI ````yaml /openapi/openapi-products.json post /products/api/v1/product-links 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, batch/lots (GS1 AI 10) and serial numbers (GS1 AI 21) from CSV, TSV or XLSX files, with a downloadable template per entity. - 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. - name: Lots description: >- Lot generator v2: format templates with persistent counters, reserve/commit/discard runs, soft/hard collision handling, and an async Celery path with SSE progress. - name: Retailer Catalog Import description: >- Server-side retailer catalog import jobs: stage normalised rows, then run the GTIN-keyed cross-retailer merge with a dry-run mode, per-field provenance and a quarantine report for every row refused. - name: HRI Presets description: >- Saved, named per-organisation Human Readable Interpretation (HRI) configurations — placement, layout, notation and typography. Referenceable by name from the QR generation endpoint, with an org default applied when no options or preset are supplied. - name: Product Links description: >- Generic, GS1-link-type-keyed brand CTA links (e.g. reviews, promotions, loyalty programs, homepage) attached to a product or a brand and rendered on the hosted page. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /products/api/v1/product-links: post: tags: - Product Links summary: Create product link description: >- Create a new CTA link for a product or brand. Returns 404 if the referenced product/brand doesn't exist or the caller lacks CONTRIBUTE permission on its owning organization; 422 if ``link_type`` isn't a recognised GS1 Web Vocabulary CURIE. operationId: apps_products_api_product_links_create_product_link parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductLinkCreate' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProductLinkOut' '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' '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: ProductLinkCreate: description: Payload for ``POST /product-links``. examples: - label: Rate it on Untappd link_type: gs1:review product_id: SBjSX6xUJPPHQKUXBpYX2C url: https://untappd.com/b/container-brewing-seawise-giant/3533900 oneOf: - anyOf: - not: required: - brand_id - properties: brand_id: type: 'null' properties: product_id: not: type: 'null' required: - product_id - anyOf: - not: required: - product_id - properties: product_id: type: 'null' properties: brand_id: not: type: 'null' required: - brand_id properties: product_id: anyOf: - description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: >- ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ type: string - type: 'null' description: >- Product this link belongs to. Exactly one of ``product_id`` / ``brand_id`` is required — a link is either product-specific (e.g. a promotion for one GTIN) or brand-wide (e.g. the brand's homepage), never both, never neither. title: Product Id brand_id: anyOf: - description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: >- ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ type: string - type: 'null' description: >- Brand this link belongs to. Exactly one of ``product_id`` / ``brand_id`` is required — see ``product_id``. title: Brand Id link_type: description: >- GS1 Web Vocabulary link-type CURIE, e.g. ``gs1:promotion``, ``gs1:loyaltyProgram``, ``gs1:homepage``. Validated against the live GS1 Web Vocabulary link-type set — an unknown or resolver-only CURIE (``gs1:defaultLink``, ``gs1:handledBy``, …) is rejected with 422. enum: - gs1:activityIdeas - gs1:allergenInfo - gs1:appDownload - gs1:backgroundInfo - gs1:brandHomepageClinical - gs1:brandHomepagePatient - gs1:careersInfo - gs1:certificationInfo - gs1:consumerHandlingStorageInfo - gs1:dpp - gs1:eifu - gs1:epcis - gs1:epil - gs1:eventsInfo - gs1:faqs - gs1:hasRetailers - gs1:homepage - gs1:ingredientsInfo - gs1:instructions - gs1:jws - gs1:leaveReview - gs1:locationInfo - gs1:logisticsInfo - gs1:loyaltyProgram - gs1:masterData - gs1:menuInfo - gs1:nutritionalInfo - gs1:openingHoursInfo - gs1:paymentLink - gs1:pip - gs1:promotion - gs1:purchaseSuppliesOrAccessories - gs1:quickStartGuide - gs1:recallStatus - gs1:recipeInfo - gs1:registerProduct - gs1:registryEntry - gs1:relatedImage - gs1:relatedVideo - gs1:reportFound - gs1:review - gs1:safetyInfo - gs1:scheduleTime - gs1:serviceInfo - gs1:smartLabel - gs1:smpc - gs1:socialMedia - gs1:statisticInfo - gs1:subscribe - gs1:support - gs1:sustainabilityInfo - gs1:traceability - gs1:tutorial - gs1:userAgreement - gs1:verificationService - gs1:whatsInTheBox title: Link Type type: string url: description: >- Destination URL. May include ``{gtin}``/``{lot}``/``{serial}`` substitution tokens to prefill the brand's page from the scan context when ``use_ai_substitution`` is set. maxLength: 2048 title: Url type: string label: default: '' description: >- Link label shown on the hosted page. Defaults to the GS1 link type's title when blank. maxLength: 120 title: Label type: string description: default: '' description: Optional longer description shown alongside the link. title: Description type: string order: default: 0 description: >- Display order within the link type's group on the hosted page (ascending). minimum: 0 title: Order type: integer use_ai_substitution: default: false description: >- When set, treat ``url`` as a template and inject the scanned GS1 AIs (GTIN/lot/serial) at render time. title: Use Ai Substitution type: boolean required: - link_type - url title: ProductLinkCreate type: object ProductLinkOut: description: >- A product link as read from the API. Mirrors :class:`apps.products.models.ProductLink`. examples: - anchor: review created: '2026-09-01T09:00:00Z' description: '' display_label: Rate it on Untappd id: keATfB8VP2gSjcnTbsMNQL label: Rate it on Untappd link_type: gs1:review modified: '2026-09-01T09:00:00Z' order: 0 product_id: SBjSX6xUJPPHQKUXBpYX2C url: https://untappd.com/b/container-brewing-seawise-giant/3533900 use_ai_substitution: false properties: id: description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Id type: string product_id: anyOf: - description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: >- ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ type: string - type: 'null' description: >- Product this link belongs to. Exactly one of ``product_id`` / ``brand_id`` is set — a link is either product-specific (e.g. a promotion for one GTIN) or brand-wide (e.g. the brand's homepage), never both, never neither. title: Product Id brand_id: anyOf: - description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: >- ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ type: string - type: 'null' description: >- Brand this link belongs to. Exactly one of ``product_id`` / ``brand_id`` is set — see ``product_id``. title: Brand Id link_type: description: >- GS1 Web Vocabulary link-type CURIE, e.g. ``gs1:promotion``, ``gs1:loyaltyProgram``, ``gs1:homepage``. Validated against the live GS1 Web Vocabulary link-type set — an unknown or resolver-only CURIE (``gs1:defaultLink``, ``gs1:handledBy``, …) is rejected with 422. maxLength: 64 title: Link Type type: string url: description: >- Destination URL. May include ``{gtin}``/``{lot}``/``{serial}`` substitution tokens to prefill the brand's page from the scan context when ``use_ai_substitution`` is set. maxLength: 2048 title: Url type: string label: default: '' description: >- Link label shown on the hosted page. Defaults to the GS1 link type's title when blank. maxLength: 120 title: Label type: string description: default: '' description: Optional longer description shown alongside the link. title: Description type: string order: description: >- Display order within the link type's group on the hosted page (ascending). minimum: 0 title: Order type: integer use_ai_substitution: description: >- When set, treat ``url`` as a template and inject the scanned GS1 AIs (GTIN/lot/serial) at render time. title: Use Ai Substitution type: boolean anchor: description: Hosted-page fragment anchor this link's group renders under. title: Anchor type: string display_label: description: >- Label to render — the explicit ``label``, else the link type's title. title: Display Label type: string created: description: Server-side ISO 8601 timestamp of creation (UTC). format: date-time title: Created type: string modified: description: Server-side ISO 8601 timestamp of last modification (UTC). format: date-time title: Modified type: string required: - id - link_type - url - order - use_ai_substitution - anchor - display_label - created - modified title: ProductLinkOut 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 ````