Skip to main content
POST
Add product family member

Authorizations

X-API-Key
string
header
required

Path Parameters

family_id
string<shortuuid>
required

Id of the product family.

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

Body

application/json

Payload for POST /families/{family_id}/members.

gtin
string
required

GTIN of a product the family's organization owns (8, 12, 13 or 14 digits). 404 if no such product is owned by that organization.

Maximum string length: 32
variant_type
enum<string>
default:OTHER

Axis this variant differs from its siblings along.

Available options:
SIZE,
FLAVOR,
SCENT,
COLOR,
STRENGTH,
FORMAT,
OTHER
variant_value
string
default:""

Concrete value on that axis, e.g. 946ml.

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

Make this the family's canonical variant, clearing any previous default.

position
integer | null

Display order within the family. Omit to append after the last member.

Required range: 0 <= x <= 2147483647

Response

Created

One variant in a family: the product plus the axis it varies along.

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}$
product_id
string<shortuuid>
required

The member product's id.

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

The member product's GTIN, normalized to GTIN-14.

product_name
string
required

The member product's name. Empty string when unknown.

variant_type
enum<string>
required

Axis this variant differs from its siblings along (size, flavor, scent, color, ...).

Available options:
SIZE,
FLAVOR,
SCENT,
COLOR,
STRENGTH,
FORMAT,
OTHER
variant_value
string
required

Concrete value on that axis, e.g. 946ml or Lavender. Empty string when unset.

is_default
boolean
required

Whether this is the family's canonical variant. At most one member per family is default.

position
integer
required

Display order within the family (ascending).