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
line
string
required

Body

application/json

A line of a BOM, for adding it or editing it.

component
string
required

The id or SKU of an active item that is not a service.

Maximum string length: 64
quantity
string
required

How much of the component one build takes, as an exact decimal above zero.

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

A unit the component converts from, such as each or kg.

Maximum string length: 16
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
position
integer | null

Unique in the BOM; the next step of 10 after the last line when left out.

Required range: 1 <= x <= 999999
scrap_percent
string | null

Extra allowed for scrap, as a percent from 0 to 100. 0 when left out.

Pattern: ^(100(\.0{1,6})?|\d{1,2}(\.\d{1,6})?)$
reference_designators
string | null

Where the component goes on the assembly, such as "R1, R2, R5-R8".

Maximum string length: 2000
note
string | null
Maximum string length: 1000
phantom
boolean | null

A sub-assembly never stocked, whose own lines are built into this BOM. Its component needs a BOM. False when left out.

Response

BomResource

data
BomResource · object
required