Skip to main content
POST
Create recyclability assessment

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /recyclability. One assessment per packaging element.

packaging_id
string<shortuuid>
required

Packaging element to assess. Must belong to one of the caller's organization's products, else 404. 409 if it already has an assessment.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
status
enum<string> | null

Consumer-facing status (How2Recycle-aligned).

Available options:
WIDELY_RECYCLABLE,
CHECK_LOCALLY,
STORE_DROP_OFF,
SPECIAL_HANDLING,
NOT_RECYCLABLE
recyclability_code
string
default:""

Short code for the material or scheme.

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

Share that is recyclable, 0-100.

Required range: 0 <= x <= 100
description
string
default:""

Free-text description.

Maximum string length: 1000
Pattern: ^[^\x00]{0,1000}$
conditions
string
default:""

Conditions for recyclability.

Maximum string length: 1000
Pattern: ^[^\x00]{0,1000}$
recycling_instructions
string
default:""

How to recycle it.

Maximum string length: 1000
Pattern: ^[^\x00]{0,1000}$
recycling_instructions_url
string
default:""

Link to recycling instructions (http or https).

Maximum string length: 200
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,191})?$
assessment_standard
enum<string> | null

Standard the assessment follows.

Available options:
EN_13430,
ISO_14021,
HOW2RECYCLE,
OPRL,
RECYCLASS,
CUSTOM
assessment_date
string<date> | null

Date of the assessment.

assessed_by
string
default:""

Who performed the assessment.

Maximum string length: 200
Pattern: ^[^\x00]{0,200}$
valid_until
string<date> | null

Date the assessment expires.

valid_regions
string
default:""

Regions the assessment applies to, for example US, CA.

Maximum string length: 200
Pattern: ^[^\x00]{0,200}$
recycling_stream
enum<string> | null

Recycling stream the element belongs to.

Available options:
PAPER_CARDBOARD,
PLASTIC_PET,
PLASTIC_HDPE,
GLASS,
METAL_ALUMINUM,
METAL_STEEL,
ORGANIC_COMPOSTABLE,
ELECTRONICS,
HAZARDOUS,
MIXED_OTHER,
NOT_RECYCLABLE

Response

Created

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.