Skip to main content
POST
Create accessory

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /accessories.

gtin
string<gtin>
required

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

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

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

Required string length: 8 - 14

Response

Created

An accessory 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
AccessoryProductOut · object
required

The product the accessory replaces a piece of.

Example:
accessory
AccessoryProductOut · object
required

The product that serves as the accessory.

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