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

multipart/form-data
file
file
required

A CSV file with a header row, of at most 20 MB and 10,000 rows.

mapping_id
string<uuid> | null

A saved mapping to start from.

format
enum<string> | null

What the file is: lines (BOM lines, the default) or a CAD tool's BOM table, solidworks, fusion, onshape or levels (any table with a level column). CAD formats need a plan with CAD import.

Available options:
lines,
solidworks,
fusion,
onshape,
levels

Response

BomImportResource

data
BomImportResource · object
required