Skip to main content
POST
Link a GLN to a brand

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<shortuuid>
required

URL-safe brand identifier.

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

Body

application/json

Payload to link a GLN to a brand.

gln
string
required

The 13-digit Global Location Number, including its GS1 check digit. A wrong check digit is refused with 422.

Required string length: 13
Pattern: ^[0-9]{13}$
gln_type
enum<string>
required

GS1 classification: physical (AI 414), invoicing (AI 415) or legal (AI 417). A GLN already registered on Closient under a different classification is refused with 409.

Available options:
physical,
invoicing,
legal
label
string
default:""

Optional human-readable description, such as 'Head office'.

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$
is_primary
boolean
default:false

Make this the brand's primary GLN, demoting the current one. The first GLN a brand gets is primary whatever this says.

Response

Created

One GLN linked to a brand.

id
string<shortuuid>
required

Identifier of this brand-to-GLN link (not the GLN itself).

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

The 13-digit Global Location Number.

gln_type
enum<string>
required

GS1 classification of the GLN: physical (physical location, AI 414), invoicing (invoicing party, AI 415) or legal (legal entity, AI 417). Held by the GLN registry, so one GLN has one classification across Closient.

Available options:
physical,
invoicing,
legal
ai_code
string
required

GS1 Application Identifier the classification maps to: 414, 415 or 417.

label
string
required

Optional human-readable description, such as 'Head office'.

is_primary
boolean
required

Whether this is the brand's primary GLN. A brand has at most one.

created
string<date-time>
required

ISO-8601 time the GLN was linked to the brand.