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

bom
string
required

Body

application/json

How much of its item a BOM yields.

yield_quantity
string
required

How much of the item one build makes, in its base unit, as an exact decimal above zero.

Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$

Response

BomResource

data
BomResource · object
required