Skip to main content
POST
Create packaging element

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /packaging.

gtin
string<gtin>
required

GTIN (8, 12, 13 or 14 digits) of the product. Must be a product the caller's organization owns, else 404.

Required string length: 8 - 14
packaging_type
enum<string>
required

Packaging tier: primary (direct contact), secondary (retail wrap), tertiary (transport).

Available options:
primary,
secondary,
tertiary
description
string
default:""

Free-text description of the element.

Maximum string length: 200
Pattern: ^[^\x00]{0,200}$
weight_grams
number | null

Weight in grams, up to two decimal places.

Required range: 0 <= x <= 99999999.99
is_recyclable
boolean
default:false

Whether the element is generally recyclable.

is_reusable
boolean
default:false

Whether the element is designed for reuse.

recycled_content_percentage
number | null

Recycled content, 0-100.

Required range: 0 <= x <= 100

Response

Created

A packaging element of one of the organization's products.

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

The organization that owns the product.

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

The product's GTIN, normalized to GTIN-14.

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).

packaging_type
string
required

Packaging tier: primary, secondary or tertiary.

description
string
required

Free-text description. Empty string when unset.

weight_grams
number | null
required

Weight in grams. Null when not measured.

is_recyclable
boolean
required

Whether the element is generally recyclable.

is_reusable
boolean
required

Whether the element is designed for reuse.

recycled_content_percentage
number | null
required

Recycled content, 0-100. Null when undeclared.