Skip to main content
PATCH
Update accessory

Authorizations

X-API-Key
string
header
required

Path Parameters

accessory_id
string<shortuuid>
required

Id of the accessory.

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

Body

application/json

Payload for PATCH /accessories/{accessory_id}.

accessory_gtin
string<gtin>
required

GTIN of the product that becomes the accessory. Must be a product the owning organization owns, else 404 and nothing changes. The product the accessory belongs to cannot change.

Required string length: 8 - 14

Response

OK

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