Skip to main content
GET
Get recyclability assessment

Authorizations

X-API-Key
string
header
required

Path Parameters

record_id
string<shortuuid>
required

Id of the recyclability assessment.

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

Response

OK

The recyclability assessment of one packaging element.

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_id
string<shortuuid>
required

The packaging element this assessment applies to.

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

Consumer-facing status. Empty string when unset.

recyclability_code
string
required

Short code for the material or scheme. Empty when unset.

recyclability_percentage
number | null
required

Share that is recyclable, 0-100. Null when unset.

description
string
required

Free-text description. Empty when unset.

conditions
string
required

Conditions for recyclability. Empty when unset.

recycling_instructions
string
required

How to recycle it. Empty when unset.

recycling_instructions_url
string
required

Link to recycling instructions. Empty when unset.

assessment_standard
string
required

Standard the assessment follows. Empty when unset.

assessment_date
string<date> | null
required

Date of the assessment. Null when unset.

assessed_by
string
required

Who performed the assessment. Empty when unset.

valid_until
string<date> | null
required

Date the assessment expires. Null when unset.

valid_regions
string
required

Regions the assessment applies to. Empty when unset.

recycling_stream
string
required

Recycling stream the element belongs to. Empty when unset.