Skip to main content
PUT
Create or replace product registration link

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the product.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string<gtin>
required

GTIN-8/12/13/14 of the target product. Normalized to GTIN-14 by zero-padding before lookup.

Pattern: ^[0-9]{8,14}$

Body

application/json

Request body for setting a product's registration link (replaces the whole link).

url
string<uri-template>
required

Registration page URL. Must be https. May include the substitution tokens {gtin}, {lot}, {serial}, {expiry} and the other recognised scan-context tokens, which the hosted page fills from the scan so the brand's form prefills; any other {...} is rejected.

Maximum string length: 2048
Pattern: ^[Hh][Tt][Tt][Pp][Ss]://(?:[^\x00-\x20\x7f/?#{}]|\{(?:batch|bestBefore|cpv|expiry|expiryDateTime|gtin|lot|packagingDate|prodDate|sellBy|serial|tpx)\})(?:[^\x00-\x20\x7f{}]|\{(?:batch|bestBefore|cpv|expiry|expiryDateTime|gtin|lot|packagingDate|prodDate|sellBy|serial|tpx)\})*$
label
string
default:""

Call-to-action button label. Blank shows 'Register your product'.

Maximum string length: 120
Pattern: ^[^\x00]{0,120}$
description
string
default:""

Optional text shown alongside the registration call to action.

Pattern: ^[^\x00]{0,}$

Response

OK

A product's registration link.

id
string<shortuuid>
required

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

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
url
string
required

Registration page URL as entered, substitution tokens intact.

label
string
required

Call-to-action button label; blank shows 'Register your product'.

description
string
required

Text shown alongside the registration call to action.

created
string<date-time>
required

ISO-8601 UTC timestamp of when the link was added.

modified
string<date-time>
required

ISO-8601 UTC timestamp of the last change.