Skip to main content
POST
Create consumable

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /consumables.

gtin
string<gtin>
required

GTIN (8, 12, 13 or 14 digits) of the product the consumable belongs to. Must be a product the caller's organization owns, else 404.

Required string length: 8 - 14
consumable_gtin
string<gtin>
required

GTIN of the product that is the consumable. Must be a product the same organization owns, else 404 and nothing is created.

Required string length: 8 - 14
estimated_lifespan
string
default:""

How long one unit lasts, as free text (for example 6 months).

Maximum string length: 100
Pattern: ^[^\x00]{0,100}$
is_required
boolean
default:false

Whether the product needs this consumable to work.

note
string
default:""

Short note shown with the consumable.

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$

Response

Created

A consumable of one of the organization's products.

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}$
product
ConsumableProductOut · object
required

The product the consumable is used with.

Example:
consumable
ConsumableProductOut · object
required

The product that serves as the consumable.

Example:
estimated_lifespan
string
required

How long one unit lasts, as free text. Empty when unset.

is_required
boolean
required

Whether the product needs this consumable to work.

note
string
required

Short note shown with the consumable. Empty when unset.

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