Skip to main content
GET
Compose a GS1 Digital Link URI from Application Identifiers

Query Parameters

primary_ai
string
required

The primary identifier AI code, e.g. 01 for GTIN.

Required string length: 2 - 4
primary_value
string
required

The primary identifier's value, e.g. 09506000164908.

Required string length: 1 - 256
qualifier
string[]

Repeatable qualifier AI in code:value form, e.g. 10:LOT1.

attribute
string[]

Repeatable data-attribute AI in code:value form, e.g. 17:261231.

scheme
string
default:https

URI scheme; http or https. Anything else is reported as an issue and the default is used.

Maximum string length: 16
host
string
default:id.example.com

Resolver host to compose against, e.g. id.gs1.org.

Maximum string length: 255

Response

200 - application/json

OK

A composed Digital Link URI plus how it graded.

is_conformant
boolean
required

True when the composed URI carries no error-severity issues.

scheme
string
required

The scheme actually used (normalised; defaults apply when input was blank).

host
string
required

The host actually used (normalised; defaults apply when input was blank).

uri
string | null

The composed URI, or null when the inputs were too incomplete to compose one.

issues
DigitalLinkIssueOut · object[]

Every issue found while composing.

primary
ParsedAIOut · object | null

The primary identifier AI, or null when none was supplied.

Example:
qualifiers
ParsedAIOut · object[]

Qualifier AIs written into the path.

data_attributes
ParsedAIOut · object[]

Data attributes written into the query string.

permitted_qualifier_codes
string[]

Which qualifier AI codes this primary key permits — use it to drive a picker.

Example: