Skip to main content
PATCH
Update end-of-life instruction

Authorizations

X-API-Key
string
header
required

Path Parameters

record_id
string<shortuuid>
required

Id of the end-of-life instruction.

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

Body

application/json

Payload for PATCH /end-of-life-instructions/{id}. Only the keys present are applied.

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}$
instruction_type
enum<string> | null

What the consumer should do.

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

Plain-text description of the disposal action.

Required string length: 1 - 1000
Pattern: ^[^\x00]{1,1000}$
valid_regions
string | null

Regions the instruction applies to. Null clears it.

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

Collection-point link. Null clears it.

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

Display order, lowest first.

Required range: 0 <= x <= 2147483647

Response

OK

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.