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

import
string
required

Body

application/json
mapping
object
required

Each column's field by the column's name. For BOM lines: parent, component, quantity, unit, position, scrap_percent, reference_designators, note or phantom, with the parent, component, quantity and unit mapped. For a CAD BOM: level, part_number, name, description, quantity, unit or note, with the level, part number and quantity mapped. A column left out is not imported.

save_as
string | null

Saves the mapping under this name, for the next file.

Maximum string length: 100
assembly
string | null

For a CAD BOM, the SKU of the assembly the file is for: its top-level parts become that assembly's lines. Without it, top-level parts with parts under them become BOMs of their own.

Maximum string length: 64

Response

BomImportResource

data
BomImportResource · object
required