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

The item a new BOM builds and how much of it one build yields.

item
string
required

The id or SKU of an active item whose make or buy is make or both.

Maximum string length: 64
yield_quantity
string | null

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

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

Response

BomResource

data
BomResource · object
required