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 item's fields, and optionally the barcode it was scanned by, which becomes its first barcode.

sku
string
required
Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._\/-]*$
name
string
required
Maximum string length: 255
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
description
string | null
Maximum string length: 5000
brand
string | null

The brand the item is sold under.

Maximum string length: 255
custom_fields
object

Custom field values by key: text, a number (a decimal string is exact), a YYYY-MM-DD date, a boolean or one of a select field's options. Fields left out are cleared.

weight
string | null

One unit's weight, for rating and labelling shipments; up to four decimal places.

Pattern: ^\d{1,8}(\.\d{1,4})?$
weight_unit
enum<string> | null

g, kg, oz or lb; required with a weight.

Available options:
g,
kg,
oz,
lb
length
string | null

One unit's size: give length, width and height together, or none of them.

Pattern: ^\d{1,8}(\.\d{1,4})?$
width
string | null
Pattern: ^\d{1,8}(\.\d{1,4})?$
height
string | null
Pattern: ^\d{1,8}(\.\d{1,4})?$
dimension_unit
enum<string> | null

mm, cm or in; required with the dimensions.

Available options:
mm,
cm,
in
hs_code
string | null

The harmonized system code customs classifies the item by: 6 to 10 digits, no dots.

Pattern: ^\d{6,10}$
barcode
string | null

A GTIN, checked by its check digit, or a Code 128 code of printable characters.

Pattern: ^[\x20-\x7E]{1,80}$

Response

ItemResource

data
ItemResource · object
required