Skip to main content
POST
Create product family

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /families.

name
string
required

Display name for the family concept, e.g. Oatly Oat Milk.

Required string length: 1 - 255
Pattern: ^[^\x00]{1,255}$
organization_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}$
brand
string
default:""

Brand name as display text.

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

Family-level description.

Pattern: ^[^\x00]{0,}$
external_ref
string
default:""

Caller-supplied id from the source system (e.g. sephora:P123456), unique within the organization. List with ?external_ref= to find a family again on a re-run. 409 if taken.

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$
owning_brand_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}$
category_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}$
country_of_origin
string
default:""

ISO 3166-1 alpha-2 code copied down to members that don't set their own.

Maximum string length: 2
Pattern: ^([A-Z]{2})?$
axes
ProductFamilyAxisIn · object[] | null

The dimensions the family varies along, in display order.

Response

Created

A product family with its members in display order.

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 this family.

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

Display name for the family concept, e.g. Oatly Oat Milk.

brand
string
required

Brand name as display text. Empty string when unset.

description
string
required

Family-level description. Empty string when unset.

external_ref
string
required

Caller-supplied id from the source system (e.g. sephora:P123456), unique within the organization. Empty string when unset.

members
ProductFamilyMemberOut · object[]
required

The family's variants, in display order.

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

owning_brand_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}$
slug
string | null

URL key of the family page, unique within the brand. Null while the family has no brand.

url
string | null

Path of the public family page, /brands/{brand-slug}/{family-slug}/. Null without one.

category_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}$
country_of_origin
string
default:""

ISO 3166-1 alpha-2 code copied down to members that don't set their own. Empty when unset.

axes
ProductFamilyAxisOut · object[]

The dimensions the family varies along, in display order.