Skip to main content
POST
Activate a serialization pool

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

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

Identifier of the pool, as listed.

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

Response

OK

The serial-number pool of one product.

id
string<shortuuid>
required

Identifier of the pool, for activating it.

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

GTIN of the product the pool numbers.

product_name
string
required

Name of the product the pool numbers.

encoding_type
enum<string>
required

Kind of serial numbers the pool hands out.

Available options:
numeric,
alphanumeric,
uuid
status
enum<string>
required

active when serial numbers can be commissioned from the pool, exhausted when its ranges are used up, disabled when it was switched off.

Available options:
active,
exhausted,
disabled
regions
SerialRegionOut · object[]
required

The ranges the pool holds, with their allocation cursors; empty until ranges are added.