Skip to main content
POST
Create end-of-life instruction

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /end-of-life-instructions.

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
instruction_type
enum<string>
required

What the consumer should do with the product.

Available options:
RECYCLE,
COMPOST,
RETURN,
SPECIAL_DISPOSAL,
LANDFILL,
REUSE,
DONATE
description
string
required

Plain-text description of the disposal action.

Required string length: 1 - 1000
Pattern: ^[^\x00]{1,1000}$
component_id
string<shortuuid> | null

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}$
valid_regions
string
default:""

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

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

Link to a collection-point lookup (http or https).

Maximum string length: 200
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,191})?$
priority
integer
default:0

Display order, lowest first.

Required range: 0 <= x <= 2147483647

Response

Created

A disposal instruction for one of the organization's products or one of its components.

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).

component_id
string<shortuuid> | null
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}$
instruction_type
string
required

What the consumer should do with the product at end of life.

description
string
required

Plain-text description of the disposal action.

valid_regions
string
required

Regions the instruction applies to. Empty when global.

collection_url
string
required

Link to a collection-point lookup. Empty when unset.

priority
integer
required

Display order, lowest first.