curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"internal_sku": "RED-S",
"bom_name": "BOM-RED-S"
},
{
"internal_sku": "RED-M",
"bom_name": "BOM-RED-M"
}
],
"mode": "add"
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms"
payload = {
"items": [
{
"internal_sku": "RED-S",
"bom_name": "BOM-RED-S"
},
{
"internal_sku": "RED-M",
"bom_name": "BOM-RED-M"
}
],
"mode": "add"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{internal_sku: 'RED-S', bom_name: 'BOM-RED-S'},
{internal_sku: 'RED-M', bom_name: 'BOM-RED-M'}
],
mode: 'add'
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'internal_sku' => 'RED-S',
'bom_name' => 'BOM-RED-S'
],
[
'internal_sku' => 'RED-M',
'bom_name' => 'BOM-RED-M'
]
],
'mode' => 'add'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms"
payload := strings.NewReader("{\n \"items\": [\n {\n \"internal_sku\": \"RED-S\",\n \"bom_name\": \"BOM-RED-S\"\n },\n {\n \"internal_sku\": \"RED-M\",\n \"bom_name\": \"BOM-RED-M\"\n }\n ],\n \"mode\": \"add\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"internal_sku\": \"RED-S\",\n \"bom_name\": \"BOM-RED-S\"\n },\n {\n \"internal_sku\": \"RED-M\",\n \"bom_name\": \"BOM-RED-M\"\n }\n ],\n \"mode\": \"add\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"internal_sku\": \"RED-S\",\n \"bom_name\": \"BOM-RED-S\"\n },\n {\n \"internal_sku\": \"RED-M\",\n \"bom_name\": \"BOM-RED-M\"\n }\n ],\n \"mode\": \"add\"\n}"
response = http.request(request)
puts response.read_body{
"processed": 2,
"succeeded": 1,
"failed": 1,
"mode": "add",
"results": [
{
"internal_sku": "RED-S",
"bom_name": "BOM-RED-S",
"status": "attached"
},
{
"internal_sku": "RED-M",
"bom_name": "BOM-RED-M",
"status": "error",
"reason": "BOM not found"
}
]
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Bulk attach BOMs to products
Attach BOMs to many products in a single request by matching each
product’s internal_sku to a BOM bom_name. Each item is an independent
SKU + BOM pair (this is not a one-BOM-to-many-SKUs operation), and every
row is reported individually so partial success is possible.
Rows whose SKU or BOM cannot be resolved are skipped and returned with an
error status and a reason; the rest are still attached. The overall
request returns 200 even when some rows fail — inspect the results
array and the failed count to detect per-row problems.
Modes
add(default): preserves existing BOM attachments on each touched SKU (syncWithoutDetaching).replace: replaces all BOMs on each touched SKU with the ones supplied in this request (sync).
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"internal_sku": "RED-S",
"bom_name": "BOM-RED-S"
},
{
"internal_sku": "RED-M",
"bom_name": "BOM-RED-M"
}
],
"mode": "add"
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms"
payload = {
"items": [
{
"internal_sku": "RED-S",
"bom_name": "BOM-RED-S"
},
{
"internal_sku": "RED-M",
"bom_name": "BOM-RED-M"
}
],
"mode": "add"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{internal_sku: 'RED-S', bom_name: 'BOM-RED-S'},
{internal_sku: 'RED-M', bom_name: 'BOM-RED-M'}
],
mode: 'add'
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'internal_sku' => 'RED-S',
'bom_name' => 'BOM-RED-S'
],
[
'internal_sku' => 'RED-M',
'bom_name' => 'BOM-RED-M'
]
],
'mode' => 'add'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms"
payload := strings.NewReader("{\n \"items\": [\n {\n \"internal_sku\": \"RED-S\",\n \"bom_name\": \"BOM-RED-S\"\n },\n {\n \"internal_sku\": \"RED-M\",\n \"bom_name\": \"BOM-RED-M\"\n }\n ],\n \"mode\": \"add\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"internal_sku\": \"RED-S\",\n \"bom_name\": \"BOM-RED-S\"\n },\n {\n \"internal_sku\": \"RED-M\",\n \"bom_name\": \"BOM-RED-M\"\n }\n ],\n \"mode\": \"add\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/products/bulk-attach-boms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"internal_sku\": \"RED-S\",\n \"bom_name\": \"BOM-RED-S\"\n },\n {\n \"internal_sku\": \"RED-M\",\n \"bom_name\": \"BOM-RED-M\"\n }\n ],\n \"mode\": \"add\"\n}"
response = http.request(request)
puts response.read_body{
"processed": 2,
"succeeded": 1,
"failed": 1,
"mode": "add",
"results": [
{
"internal_sku": "RED-S",
"bom_name": "BOM-RED-S",
"status": "attached"
},
{
"internal_sku": "RED-M",
"bom_name": "BOM-RED-M",
"status": "error",
"reason": "BOM not found"
}
]
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Body
Response
Processing summary. Returned even when some rows fail; inspect
results and failed for per-row outcomes.
Total number of items in the request.
Number of SKU + BOM pairs successfully attached.
Number of pairs that could not be attached.
The mode used for this request.
add, replace Per-row outcome, one entry per input pair.
Show child attributes
Show child attributes