Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

family
string
required

Body

application/json

A SKU pattern, such as {family}-{size}-{color}, and the combinations of option values to skip.

pattern
string
required

A SKU for each variant: {family} is the family's code, and each option is its name in lower case with spaces as underscores, such as {size}.

Maximum string length: 200
skip
object[]
Maximum array length: 1000

Response

ItemFamilyPageResource

data
ItemFamilyPageResource · object
required