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.

Body

application/json

A new family: its code, which SKU patterns use as {family}, what its variants are, and its shared fields.

code
string
required
Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._\/-]*$
type
enum<string>
required

What kind of thing an item is.

Available options:
stocked,
non_stocked,
service
make_or_buy
enum<string>
required

Whether the organization builds an item, buys it or does both.

Available options:
make,
buy,
both
name
string
required
Maximum string length: 255
options
object[]
required
Required array length: 1 - 3 elements
description
string | null
Maximum string length: 5000
custom_fields
object

Custom field values the family's variants share: text, a number (a decimal string is exact), a YYYY-MM-DD date, a boolean or one of a select field's options.

Response

ItemFamilyPageResource

data
ItemFamilyPageResource · object
required