Skip to main content
POST
Bulk attach BOMs to products

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
items
object[]
required

SKU + BOM name pairs to attach.

Required array length: 1 - 10000 elements
mode
enum<string> | null
default:add

Attachment mode. add (default) preserves existing BOM attachments; replace replaces all BOMs on each touched SKU.

Available options:
add,
replace

Response

Processing summary. Returned even when some rows fail; inspect results and failed for per-row outcomes.

processed
integer

Total number of items in the request.

succeeded
integer

Number of SKU + BOM pairs successfully attached.

failed
integer

Number of pairs that could not be attached.

mode
enum<string>

The mode used for this request.

Available options:
add,
replace
results
object[]

Per-row outcome, one entry per input pair.