Skip to main content
GET
Get Packaging Unit by ID

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Path Parameters

id
string<uuid>
required

Response

Packaging unit details

One packaging unit as GET /api/ppwr/units/{id} returns it: the stored unit fields, the identity of its PRIMARY size folded in (gtin and the three dimensions), its supplier's country, all of its sizes and its bill of materials.

id
string<uuid>
required
companyId
string<uuid>
required

Your company — a key never reads another company's data.

name
string
required
internalRef
string
required

The upsert key of POST /api/ppwr/units, generated as PU-<n> when a row sent none.

packagingType
enum<string>
required
Available options:
sales,
grouped,
transport,
ecommerce,
service
role
enum<string>
required
Available options:
manufacturer,
importer,
distributor,
authorised_representative,
supplier,
fulfilment_service_provider
placedUnderOwnBrand
boolean
required
modifiesConformity
boolean
required
isProducer
boolean
required
reusable
boolean
required

Art. 11 reusable packaging.

marketMemberStates
string[]
required

ISO alpha-2 codes of the member states the unit is placed on the market in.

formats
object[]
required

Every size of the unit, primary first. Empty for a unit created before sizes existed.

components
object[]
required

The unit's bill of materials, ordered by component code.

createdByUserId
string<uuid> | null
format
string | null

Packaging form (free text).

recyclabilityGrade
enum<string> | null
Available options:
A,
B,
C,
non_recyclable,
null
gradeSource
enum<string> | null

Where the grade came from. An imported grade is stored as declared.

Available options:
declared,
manual,
engine,
null
targetRotations
integer | null
averageRotations
string | null

Decimal string.

averageRotationMethod
enum<string> | null
Available options:
measured,
estimated,
null
reconditioningProcess
string | null
recyclabilityReference
string | null
notes
string | null

Description and intended use of the packaging.

supplierId
string<uuid> | null
supplierRoleOverride
enum<string> | null
Available options:
component_supplier,
external_manufacturer,
upstream_operator,
null
reuseSystemMemberId
string<uuid> | null

Set when the unit is managed inside a re-use system pool.

deletedAt
string<date-time> | null

Always null here — this route never returns a soft-deleted unit.

retentionUntil
string<date-time> | null

Set only on a deleted unit, so always null here.

gtin
string | null

GTIN of the unit's PRIMARY size.

widthMm
string | null

Width of the primary size in mm, as a decimal string.

heightMm
string | null

Height of the primary size in mm, as a decimal string.

depthMm
string | null

Depth of the primary size in mm, as a decimal string.

supplierCountry
string | null

Country of the unit's supplier, null when it has none.