Skip to main content
PUT
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

item
string
required

Body

application/json

One of the unit is factor of the item's base unit: an exact decimal greater than zero.

unit
string
required
Maximum string length: 16
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
factor
string
required
Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$

Response

ItemConversionResource

data
ItemConversionResource · object
required