Skip to main content
POST
Add a GS1 Company Prefix

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization.

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

Body

application/json

Request body to add a GS1 Company Prefix to the caller's organization.

prefix
string
required

The 4-12 digit GS1 Company Prefix to add.

Required string length: 4 - 12
Pattern: ^\d{4,12}$
is_licensed
boolean
default:true

False for a closed-loop, internal-only prefix whose minted identifiers are non-conformant.

label
string
default:""

Optional human label to tell multiple prefixes apart.

Maximum string length: 120

Response

OK

One GS1 Company Prefix the caller's organization holds.

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}$
prefix
string
required

4–12 digit GS1 Company Prefix. Globally unique.

is_licensed
boolean
required

True for a real GS1-licensed prefix; False for a closed-loop, internal-only prefix whose identifiers are non-conformant.

verification_status
enum<string>
required

Ownership-verification state for a licensed prefix.

Available options:
unverified,
verified,
disputed
label
string
required

Optional human label to tell multiple prefixes apart.

is_conformant
boolean
required

Whether identifiers minted from this prefix may be presented as GS1-conformant: requires both is_licensed and a verification_status of verified. Always false for a closed-loop prefix, regardless of verification status.