Update a product
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"category_id": 123,
"category": {
"name": "<string>"
},
"sku": "<string>",
"qty_low_alert": 123,
"qty_reorder_threshold": 123,
"qty_minimum": 123,
"supplier_id": 123,
"supplier": {
"name": "<string>"
},
"image_url": "<string>",
"sellable": true,
"lot_tracking": true,
"sub_category_id": 123,
"subcategory": {
"name": "<string>"
},
"default_receiving_location_id": 123,
"description": "<string>",
"wholesale_price": 1,
"retail_price": 1,
"unit_cost": 1,
"manufacturing_fee": 1,
"product_weight": {
"value": 1
},
"dimensional_weight": {
"value": 1
},
"product_length": 1,
"product_width": 1,
"product_height": 1,
"box_weight": {
"value": 1
},
"box_length": 1,
"box_width": 1,
"box_height": 1,
"carton_weight": {
"value": 1
},
"carton_length": 1,
"carton_width": 1,
"carton_height": 1,
"shipping_weight": {
"value": 1
},
"shipping_length": 1,
"shipping_width": 1,
"shipping_height": 1,
"pallet_weight": {
"value": 1
},
"pallet_length": 1,
"pallet_width": 1,
"pallet_height": 1,
"upc": "<string>",
"priority_list_id": 123,
"custom_fields": {},
"tags": [
"<string>"
],
"product_variants": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"variants": [
{
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"qty_low_alert": 123,
"qty_reorder_threshold": 123,
"qty_minimum": 123,
"supplier_id": 123,
"supplier": {
"name": "<string>"
},
"sellable": true,
"discontinued": true,
"default_receiving_location_id": 123,
"description": "<string>",
"wholesale_price": 1,
"retail_price": 1,
"unit_cost": 1,
"product_weight": {
"value": 1
},
"dimensional_weight": {
"value": 1
},
"product_length": 1,
"product_width": 1,
"product_height": 1,
"box_weight": {
"value": 1
},
"box_length": 1,
"box_width": 1,
"box_height": 1,
"carton_weight": {
"value": 1
},
"carton_length": 1,
"carton_width": 1,
"carton_height": 1,
"shipping_weight": {
"value": 1
},
"shipping_length": 1,
"shipping_width": 1,
"shipping_height": 1,
"pallet_weight": {
"value": 1
},
"pallet_length": 1,
"pallet_width": 1,
"pallet_height": 1,
"upc": "<string>",
"custom_fields": {},
"tags": [
"<string>"
],
"product_variants": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
]
}
],
"boms": [
123
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/products/{id}"
payload = {
"name": "<string>",
"category_id": 123,
"category": { "name": "<string>" },
"sku": "<string>",
"qty_low_alert": 123,
"qty_reorder_threshold": 123,
"qty_minimum": 123,
"supplier_id": 123,
"supplier": { "name": "<string>" },
"image_url": "<string>",
"sellable": True,
"lot_tracking": True,
"sub_category_id": 123,
"subcategory": { "name": "<string>" },
"default_receiving_location_id": 123,
"description": "<string>",
"wholesale_price": 1,
"retail_price": 1,
"unit_cost": 1,
"manufacturing_fee": 1,
"product_weight": { "value": 1 },
"dimensional_weight": { "value": 1 },
"product_length": 1,
"product_width": 1,
"product_height": 1,
"box_weight": { "value": 1 },
"box_length": 1,
"box_width": 1,
"box_height": 1,
"carton_weight": { "value": 1 },
"carton_length": 1,
"carton_width": 1,
"carton_height": 1,
"shipping_weight": { "value": 1 },
"shipping_length": 1,
"shipping_width": 1,
"shipping_height": 1,
"pallet_weight": { "value": 1 },
"pallet_length": 1,
"pallet_width": 1,
"pallet_height": 1,
"upc": "<string>",
"priority_list_id": 123,
"custom_fields": {},
"tags": ["<string>"],
"product_variants": [
{
"variant_name": "<string>",
"variant_terms": ["<string>"]
}
],
"variants": [
{
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"qty_low_alert": 123,
"qty_reorder_threshold": 123,
"qty_minimum": 123,
"supplier_id": 123,
"supplier": { "name": "<string>" },
"sellable": True,
"discontinued": True,
"default_receiving_location_id": 123,
"description": "<string>",
"wholesale_price": 1,
"retail_price": 1,
"unit_cost": 1,
"product_weight": { "value": 1 },
"dimensional_weight": { "value": 1 },
"product_length": 1,
"product_width": 1,
"product_height": 1,
"box_weight": { "value": 1 },
"box_length": 1,
"box_width": 1,
"box_height": 1,
"carton_weight": { "value": 1 },
"carton_length": 1,
"carton_width": 1,
"carton_height": 1,
"shipping_weight": { "value": 1 },
"shipping_length": 1,
"shipping_width": 1,
"shipping_height": 1,
"pallet_weight": { "value": 1 },
"pallet_length": 1,
"pallet_width": 1,
"pallet_height": 1,
"upc": "<string>",
"custom_fields": {},
"tags": ["<string>"],
"product_variants": [
{
"variant_name": "<string>",
"variant_terms": ["<string>"]
}
]
}
],
"boms": [123]
}
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({
name: '<string>',
category_id: 123,
category: {name: '<string>'},
sku: '<string>',
qty_low_alert: 123,
qty_reorder_threshold: 123,
qty_minimum: 123,
supplier_id: 123,
supplier: {name: '<string>'},
image_url: '<string>',
sellable: true,
lot_tracking: true,
sub_category_id: 123,
subcategory: {name: '<string>'},
default_receiving_location_id: 123,
description: '<string>',
wholesale_price: 1,
retail_price: 1,
unit_cost: 1,
manufacturing_fee: 1,
product_weight: {value: 1},
dimensional_weight: {value: 1},
product_length: 1,
product_width: 1,
product_height: 1,
box_weight: {value: 1},
box_length: 1,
box_width: 1,
box_height: 1,
carton_weight: {value: 1},
carton_length: 1,
carton_width: 1,
carton_height: 1,
shipping_weight: {value: 1},
shipping_length: 1,
shipping_width: 1,
shipping_height: 1,
pallet_weight: {value: 1},
pallet_length: 1,
pallet_width: 1,
pallet_height: 1,
upc: '<string>',
priority_list_id: 123,
custom_fields: {},
tags: ['<string>'],
product_variants: [{variant_name: '<string>', variant_terms: ['<string>']}],
variants: [
{
sku: '<string>',
name: '<string>',
image_url: '<string>',
qty_low_alert: 123,
qty_reorder_threshold: 123,
qty_minimum: 123,
supplier_id: 123,
supplier: {name: '<string>'},
sellable: true,
discontinued: true,
default_receiving_location_id: 123,
description: '<string>',
wholesale_price: 1,
retail_price: 1,
unit_cost: 1,
product_weight: {value: 1},
dimensional_weight: {value: 1},
product_length: 1,
product_width: 1,
product_height: 1,
box_weight: {value: 1},
box_length: 1,
box_width: 1,
box_height: 1,
carton_weight: {value: 1},
carton_length: 1,
carton_width: 1,
carton_height: 1,
shipping_weight: {value: 1},
shipping_length: 1,
shipping_width: 1,
shipping_height: 1,
pallet_weight: {value: 1},
pallet_length: 1,
pallet_width: 1,
pallet_height: 1,
upc: '<string>',
custom_fields: {},
tags: ['<string>'],
product_variants: [{variant_name: '<string>', variant_terms: ['<string>']}]
}
],
boms: [123]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/products/{id}', 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/{id}",
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([
'name' => '<string>',
'category_id' => 123,
'category' => [
'name' => '<string>'
],
'sku' => '<string>',
'qty_low_alert' => 123,
'qty_reorder_threshold' => 123,
'qty_minimum' => 123,
'supplier_id' => 123,
'supplier' => [
'name' => '<string>'
],
'image_url' => '<string>',
'sellable' => true,
'lot_tracking' => true,
'sub_category_id' => 123,
'subcategory' => [
'name' => '<string>'
],
'default_receiving_location_id' => 123,
'description' => '<string>',
'wholesale_price' => 1,
'retail_price' => 1,
'unit_cost' => 1,
'manufacturing_fee' => 1,
'product_weight' => [
'value' => 1
],
'dimensional_weight' => [
'value' => 1
],
'product_length' => 1,
'product_width' => 1,
'product_height' => 1,
'box_weight' => [
'value' => 1
],
'box_length' => 1,
'box_width' => 1,
'box_height' => 1,
'carton_weight' => [
'value' => 1
],
'carton_length' => 1,
'carton_width' => 1,
'carton_height' => 1,
'shipping_weight' => [
'value' => 1
],
'shipping_length' => 1,
'shipping_width' => 1,
'shipping_height' => 1,
'pallet_weight' => [
'value' => 1
],
'pallet_length' => 1,
'pallet_width' => 1,
'pallet_height' => 1,
'upc' => '<string>',
'priority_list_id' => 123,
'custom_fields' => [
],
'tags' => [
'<string>'
],
'product_variants' => [
[
'variant_name' => '<string>',
'variant_terms' => [
'<string>'
]
]
],
'variants' => [
[
'sku' => '<string>',
'name' => '<string>',
'image_url' => '<string>',
'qty_low_alert' => 123,
'qty_reorder_threshold' => 123,
'qty_minimum' => 123,
'supplier_id' => 123,
'supplier' => [
'name' => '<string>'
],
'sellable' => true,
'discontinued' => true,
'default_receiving_location_id' => 123,
'description' => '<string>',
'wholesale_price' => 1,
'retail_price' => 1,
'unit_cost' => 1,
'product_weight' => [
'value' => 1
],
'dimensional_weight' => [
'value' => 1
],
'product_length' => 1,
'product_width' => 1,
'product_height' => 1,
'box_weight' => [
'value' => 1
],
'box_length' => 1,
'box_width' => 1,
'box_height' => 1,
'carton_weight' => [
'value' => 1
],
'carton_length' => 1,
'carton_width' => 1,
'carton_height' => 1,
'shipping_weight' => [
'value' => 1
],
'shipping_length' => 1,
'shipping_width' => 1,
'shipping_height' => 1,
'pallet_weight' => [
'value' => 1
],
'pallet_length' => 1,
'pallet_width' => 1,
'pallet_height' => 1,
'upc' => '<string>',
'custom_fields' => [
],
'tags' => [
'<string>'
],
'product_variants' => [
[
'variant_name' => '<string>',
'variant_terms' => [
'<string>'
]
]
]
]
],
'boms' => [
123
]
]),
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/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category_id\": 123,\n \"category\": {\n \"name\": \"<string>\"\n },\n \"sku\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"image_url\": \"<string>\",\n \"sellable\": true,\n \"lot_tracking\": true,\n \"sub_category_id\": 123,\n \"subcategory\": {\n \"name\": \"<string>\"\n },\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"manufacturing_fee\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"priority_list_id\": 123,\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ],\n \"variants\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"sellable\": true,\n \"discontinued\": true,\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"boms\": [\n 123\n ]\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/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category_id\": 123,\n \"category\": {\n \"name\": \"<string>\"\n },\n \"sku\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"image_url\": \"<string>\",\n \"sellable\": true,\n \"lot_tracking\": true,\n \"sub_category_id\": 123,\n \"subcategory\": {\n \"name\": \"<string>\"\n },\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"manufacturing_fee\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"priority_list_id\": 123,\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ],\n \"variants\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"sellable\": true,\n \"discontinued\": true,\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"boms\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/products/{id}")
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 \"name\": \"<string>\",\n \"category_id\": 123,\n \"category\": {\n \"name\": \"<string>\"\n },\n \"sku\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"image_url\": \"<string>\",\n \"sellable\": true,\n \"lot_tracking\": true,\n \"sub_category_id\": 123,\n \"subcategory\": {\n \"name\": \"<string>\"\n },\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"manufacturing_fee\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"priority_list_id\": 123,\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ],\n \"variants\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"sellable\": true,\n \"discontinued\": true,\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"boms\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"landed_cost": 123,
"manufacturing_fee": 123,
"product_weight": [
{
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"box_weight": [
{
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"box_length": 123,
"box_width": 123,
"box_height": 123,
"carton_weight": [
{
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"carton_length": 123,
"carton_width": 123,
"carton_height": 123,
"shipping_weight": [
{
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"shipping_length": 123,
"shipping_width": 123,
"shipping_height": 123,
"pallet_weight": [
{
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"pallet_length": 123,
"pallet_width": 123,
"pallet_height": 123,
"sellable": true,
"discontinued": true,
"lot_tracking": true,
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"attachments": [
{
"id": 123,
"name": "<string>",
"type": "<string>",
"size": 123,
"full_url": "<string>",
"thumb_url": "<string>"
}
],
"variants": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"product_weight": [
{
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"box_weight": [
{
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"carton_weight": [
{
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"shipping_weight": [
{
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"pallet_weight": [
{
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"attachments": [
{
"id": 123,
"name": "<string>",
"type": "<string>",
"size": 123,
"full_url": "<string>",
"thumb_url": "<string>"
}
],
"retail_price": 123,
"wholesale_price": 123,
"custom_fields": [
{}
],
"variant_attributes": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"sku": "<string>",
"upc": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"variant_attributes": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"substitutions": [
{
"id": 123,
"priority": 123,
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": [
{
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"box_weight": [
{
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"box_length": 123,
"box_width": 123,
"box_height": 123,
"carton_weight": [
{
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"carton_length": 123,
"carton_width": 123,
"carton_height": 123,
"shipping_weight": [
{
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"shipping_length": 123,
"shipping_width": 123,
"shipping_height": 123,
"pallet_weight": [
{
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"pallet_length": 123,
"pallet_width": 123,
"pallet_height": 123,
"sellable": true,
"discontinued": true,
"image_url": "<string>",
"sku": "<string>",
"upc": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"supplier": {},
"kit_items": [
{
"id": 123,
"product_id": 123,
"quantity": 123,
"uom_id": 123,
"base_uom_quantity": 123,
"price": 123,
"original_price": 123,
"total": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123
},
"unit_of_measure": {
"id": 123,
"name": "<string>",
"description": "<string>",
"base_unit": true
}
}
],
"priority_list": {
"id": 123,
"name": "<string>",
"description": "<string>"
},
"boms": [
{
"id": 123,
"name": "<string>",
"items": [
{
"id": 123,
"bom_id": 123,
"product_id": 123,
"quantity": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>"
},
"base_quantity": 123,
"note": "<string>",
"uom_id": 123,
"unit_of_measure": {
"id": 123,
"name": "<string>"
},
"order": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"extra_costs": [
{
"id": 123,
"name": "<string>",
"quantity": 123,
"unit_price": 123,
"line_total": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Products
Update a product
Update a specific product’s information. Both POST and PUT are accepted
against this path and behave identically.
Adding or updating variants
The variants array upserts by sku (or id) — include a child to create or update it,
and omit children you don’t want to change (they’re left untouched, not deleted).
To add a new variant to an existing product, send just the new entry in variants[]. To
change a variant’s option assignment, send that child’s sku plus its new product_variants
axis/terms — the parent’s taxonomy will pick up any new terms automatically. See
Working with variants under POST /products for the full parent/child model and a worked
example.
POST
/
products
/
{id}
Update a product
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"category_id": 123,
"category": {
"name": "<string>"
},
"sku": "<string>",
"qty_low_alert": 123,
"qty_reorder_threshold": 123,
"qty_minimum": 123,
"supplier_id": 123,
"supplier": {
"name": "<string>"
},
"image_url": "<string>",
"sellable": true,
"lot_tracking": true,
"sub_category_id": 123,
"subcategory": {
"name": "<string>"
},
"default_receiving_location_id": 123,
"description": "<string>",
"wholesale_price": 1,
"retail_price": 1,
"unit_cost": 1,
"manufacturing_fee": 1,
"product_weight": {
"value": 1
},
"dimensional_weight": {
"value": 1
},
"product_length": 1,
"product_width": 1,
"product_height": 1,
"box_weight": {
"value": 1
},
"box_length": 1,
"box_width": 1,
"box_height": 1,
"carton_weight": {
"value": 1
},
"carton_length": 1,
"carton_width": 1,
"carton_height": 1,
"shipping_weight": {
"value": 1
},
"shipping_length": 1,
"shipping_width": 1,
"shipping_height": 1,
"pallet_weight": {
"value": 1
},
"pallet_length": 1,
"pallet_width": 1,
"pallet_height": 1,
"upc": "<string>",
"priority_list_id": 123,
"custom_fields": {},
"tags": [
"<string>"
],
"product_variants": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"variants": [
{
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"qty_low_alert": 123,
"qty_reorder_threshold": 123,
"qty_minimum": 123,
"supplier_id": 123,
"supplier": {
"name": "<string>"
},
"sellable": true,
"discontinued": true,
"default_receiving_location_id": 123,
"description": "<string>",
"wholesale_price": 1,
"retail_price": 1,
"unit_cost": 1,
"product_weight": {
"value": 1
},
"dimensional_weight": {
"value": 1
},
"product_length": 1,
"product_width": 1,
"product_height": 1,
"box_weight": {
"value": 1
},
"box_length": 1,
"box_width": 1,
"box_height": 1,
"carton_weight": {
"value": 1
},
"carton_length": 1,
"carton_width": 1,
"carton_height": 1,
"shipping_weight": {
"value": 1
},
"shipping_length": 1,
"shipping_width": 1,
"shipping_height": 1,
"pallet_weight": {
"value": 1
},
"pallet_length": 1,
"pallet_width": 1,
"pallet_height": 1,
"upc": "<string>",
"custom_fields": {},
"tags": [
"<string>"
],
"product_variants": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
]
}
],
"boms": [
123
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/products/{id}"
payload = {
"name": "<string>",
"category_id": 123,
"category": { "name": "<string>" },
"sku": "<string>",
"qty_low_alert": 123,
"qty_reorder_threshold": 123,
"qty_minimum": 123,
"supplier_id": 123,
"supplier": { "name": "<string>" },
"image_url": "<string>",
"sellable": True,
"lot_tracking": True,
"sub_category_id": 123,
"subcategory": { "name": "<string>" },
"default_receiving_location_id": 123,
"description": "<string>",
"wholesale_price": 1,
"retail_price": 1,
"unit_cost": 1,
"manufacturing_fee": 1,
"product_weight": { "value": 1 },
"dimensional_weight": { "value": 1 },
"product_length": 1,
"product_width": 1,
"product_height": 1,
"box_weight": { "value": 1 },
"box_length": 1,
"box_width": 1,
"box_height": 1,
"carton_weight": { "value": 1 },
"carton_length": 1,
"carton_width": 1,
"carton_height": 1,
"shipping_weight": { "value": 1 },
"shipping_length": 1,
"shipping_width": 1,
"shipping_height": 1,
"pallet_weight": { "value": 1 },
"pallet_length": 1,
"pallet_width": 1,
"pallet_height": 1,
"upc": "<string>",
"priority_list_id": 123,
"custom_fields": {},
"tags": ["<string>"],
"product_variants": [
{
"variant_name": "<string>",
"variant_terms": ["<string>"]
}
],
"variants": [
{
"sku": "<string>",
"name": "<string>",
"image_url": "<string>",
"qty_low_alert": 123,
"qty_reorder_threshold": 123,
"qty_minimum": 123,
"supplier_id": 123,
"supplier": { "name": "<string>" },
"sellable": True,
"discontinued": True,
"default_receiving_location_id": 123,
"description": "<string>",
"wholesale_price": 1,
"retail_price": 1,
"unit_cost": 1,
"product_weight": { "value": 1 },
"dimensional_weight": { "value": 1 },
"product_length": 1,
"product_width": 1,
"product_height": 1,
"box_weight": { "value": 1 },
"box_length": 1,
"box_width": 1,
"box_height": 1,
"carton_weight": { "value": 1 },
"carton_length": 1,
"carton_width": 1,
"carton_height": 1,
"shipping_weight": { "value": 1 },
"shipping_length": 1,
"shipping_width": 1,
"shipping_height": 1,
"pallet_weight": { "value": 1 },
"pallet_length": 1,
"pallet_width": 1,
"pallet_height": 1,
"upc": "<string>",
"custom_fields": {},
"tags": ["<string>"],
"product_variants": [
{
"variant_name": "<string>",
"variant_terms": ["<string>"]
}
]
}
],
"boms": [123]
}
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({
name: '<string>',
category_id: 123,
category: {name: '<string>'},
sku: '<string>',
qty_low_alert: 123,
qty_reorder_threshold: 123,
qty_minimum: 123,
supplier_id: 123,
supplier: {name: '<string>'},
image_url: '<string>',
sellable: true,
lot_tracking: true,
sub_category_id: 123,
subcategory: {name: '<string>'},
default_receiving_location_id: 123,
description: '<string>',
wholesale_price: 1,
retail_price: 1,
unit_cost: 1,
manufacturing_fee: 1,
product_weight: {value: 1},
dimensional_weight: {value: 1},
product_length: 1,
product_width: 1,
product_height: 1,
box_weight: {value: 1},
box_length: 1,
box_width: 1,
box_height: 1,
carton_weight: {value: 1},
carton_length: 1,
carton_width: 1,
carton_height: 1,
shipping_weight: {value: 1},
shipping_length: 1,
shipping_width: 1,
shipping_height: 1,
pallet_weight: {value: 1},
pallet_length: 1,
pallet_width: 1,
pallet_height: 1,
upc: '<string>',
priority_list_id: 123,
custom_fields: {},
tags: ['<string>'],
product_variants: [{variant_name: '<string>', variant_terms: ['<string>']}],
variants: [
{
sku: '<string>',
name: '<string>',
image_url: '<string>',
qty_low_alert: 123,
qty_reorder_threshold: 123,
qty_minimum: 123,
supplier_id: 123,
supplier: {name: '<string>'},
sellable: true,
discontinued: true,
default_receiving_location_id: 123,
description: '<string>',
wholesale_price: 1,
retail_price: 1,
unit_cost: 1,
product_weight: {value: 1},
dimensional_weight: {value: 1},
product_length: 1,
product_width: 1,
product_height: 1,
box_weight: {value: 1},
box_length: 1,
box_width: 1,
box_height: 1,
carton_weight: {value: 1},
carton_length: 1,
carton_width: 1,
carton_height: 1,
shipping_weight: {value: 1},
shipping_length: 1,
shipping_width: 1,
shipping_height: 1,
pallet_weight: {value: 1},
pallet_length: 1,
pallet_width: 1,
pallet_height: 1,
upc: '<string>',
custom_fields: {},
tags: ['<string>'],
product_variants: [{variant_name: '<string>', variant_terms: ['<string>']}]
}
],
boms: [123]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/products/{id}', 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/{id}",
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([
'name' => '<string>',
'category_id' => 123,
'category' => [
'name' => '<string>'
],
'sku' => '<string>',
'qty_low_alert' => 123,
'qty_reorder_threshold' => 123,
'qty_minimum' => 123,
'supplier_id' => 123,
'supplier' => [
'name' => '<string>'
],
'image_url' => '<string>',
'sellable' => true,
'lot_tracking' => true,
'sub_category_id' => 123,
'subcategory' => [
'name' => '<string>'
],
'default_receiving_location_id' => 123,
'description' => '<string>',
'wholesale_price' => 1,
'retail_price' => 1,
'unit_cost' => 1,
'manufacturing_fee' => 1,
'product_weight' => [
'value' => 1
],
'dimensional_weight' => [
'value' => 1
],
'product_length' => 1,
'product_width' => 1,
'product_height' => 1,
'box_weight' => [
'value' => 1
],
'box_length' => 1,
'box_width' => 1,
'box_height' => 1,
'carton_weight' => [
'value' => 1
],
'carton_length' => 1,
'carton_width' => 1,
'carton_height' => 1,
'shipping_weight' => [
'value' => 1
],
'shipping_length' => 1,
'shipping_width' => 1,
'shipping_height' => 1,
'pallet_weight' => [
'value' => 1
],
'pallet_length' => 1,
'pallet_width' => 1,
'pallet_height' => 1,
'upc' => '<string>',
'priority_list_id' => 123,
'custom_fields' => [
],
'tags' => [
'<string>'
],
'product_variants' => [
[
'variant_name' => '<string>',
'variant_terms' => [
'<string>'
]
]
],
'variants' => [
[
'sku' => '<string>',
'name' => '<string>',
'image_url' => '<string>',
'qty_low_alert' => 123,
'qty_reorder_threshold' => 123,
'qty_minimum' => 123,
'supplier_id' => 123,
'supplier' => [
'name' => '<string>'
],
'sellable' => true,
'discontinued' => true,
'default_receiving_location_id' => 123,
'description' => '<string>',
'wholesale_price' => 1,
'retail_price' => 1,
'unit_cost' => 1,
'product_weight' => [
'value' => 1
],
'dimensional_weight' => [
'value' => 1
],
'product_length' => 1,
'product_width' => 1,
'product_height' => 1,
'box_weight' => [
'value' => 1
],
'box_length' => 1,
'box_width' => 1,
'box_height' => 1,
'carton_weight' => [
'value' => 1
],
'carton_length' => 1,
'carton_width' => 1,
'carton_height' => 1,
'shipping_weight' => [
'value' => 1
],
'shipping_length' => 1,
'shipping_width' => 1,
'shipping_height' => 1,
'pallet_weight' => [
'value' => 1
],
'pallet_length' => 1,
'pallet_width' => 1,
'pallet_height' => 1,
'upc' => '<string>',
'custom_fields' => [
],
'tags' => [
'<string>'
],
'product_variants' => [
[
'variant_name' => '<string>',
'variant_terms' => [
'<string>'
]
]
]
]
],
'boms' => [
123
]
]),
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/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category_id\": 123,\n \"category\": {\n \"name\": \"<string>\"\n },\n \"sku\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"image_url\": \"<string>\",\n \"sellable\": true,\n \"lot_tracking\": true,\n \"sub_category_id\": 123,\n \"subcategory\": {\n \"name\": \"<string>\"\n },\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"manufacturing_fee\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"priority_list_id\": 123,\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ],\n \"variants\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"sellable\": true,\n \"discontinued\": true,\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"boms\": [\n 123\n ]\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/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category_id\": 123,\n \"category\": {\n \"name\": \"<string>\"\n },\n \"sku\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"image_url\": \"<string>\",\n \"sellable\": true,\n \"lot_tracking\": true,\n \"sub_category_id\": 123,\n \"subcategory\": {\n \"name\": \"<string>\"\n },\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"manufacturing_fee\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"priority_list_id\": 123,\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ],\n \"variants\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"sellable\": true,\n \"discontinued\": true,\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"boms\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/products/{id}")
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 \"name\": \"<string>\",\n \"category_id\": 123,\n \"category\": {\n \"name\": \"<string>\"\n },\n \"sku\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"image_url\": \"<string>\",\n \"sellable\": true,\n \"lot_tracking\": true,\n \"sub_category_id\": 123,\n \"subcategory\": {\n \"name\": \"<string>\"\n },\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"manufacturing_fee\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"priority_list_id\": 123,\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ],\n \"variants\": [\n {\n \"sku\": \"<string>\",\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"qty_low_alert\": 123,\n \"qty_reorder_threshold\": 123,\n \"qty_minimum\": 123,\n \"supplier_id\": 123,\n \"supplier\": {\n \"name\": \"<string>\"\n },\n \"sellable\": true,\n \"discontinued\": true,\n \"default_receiving_location_id\": 123,\n \"description\": \"<string>\",\n \"wholesale_price\": 1,\n \"retail_price\": 1,\n \"unit_cost\": 1,\n \"product_weight\": {\n \"value\": 1\n },\n \"dimensional_weight\": {\n \"value\": 1\n },\n \"product_length\": 1,\n \"product_width\": 1,\n \"product_height\": 1,\n \"box_weight\": {\n \"value\": 1\n },\n \"box_length\": 1,\n \"box_width\": 1,\n \"box_height\": 1,\n \"carton_weight\": {\n \"value\": 1\n },\n \"carton_length\": 1,\n \"carton_width\": 1,\n \"carton_height\": 1,\n \"shipping_weight\": {\n \"value\": 1\n },\n \"shipping_length\": 1,\n \"shipping_width\": 1,\n \"shipping_height\": 1,\n \"pallet_weight\": {\n \"value\": 1\n },\n \"pallet_length\": 1,\n \"pallet_width\": 1,\n \"pallet_height\": 1,\n \"upc\": \"<string>\",\n \"custom_fields\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"product_variants\": [\n {\n \"variant_name\": \"<string>\",\n \"variant_terms\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"boms\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"landed_cost": 123,
"manufacturing_fee": 123,
"product_weight": [
{
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"box_weight": [
{
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"box_length": 123,
"box_width": 123,
"box_height": 123,
"carton_weight": [
{
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"carton_length": 123,
"carton_width": 123,
"carton_height": 123,
"shipping_weight": [
{
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"shipping_length": 123,
"shipping_width": 123,
"shipping_height": 123,
"pallet_weight": [
{
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"pallet_length": 123,
"pallet_width": 123,
"pallet_height": 123,
"sellable": true,
"discontinued": true,
"lot_tracking": true,
"image_url": "<string>",
"category": {
"id": 123,
"name": "<string>"
},
"subcategory": {
"id": 123,
"name": "<string>"
},
"custom_fields": {},
"attachments": [
{
"id": 123,
"name": "<string>",
"type": "<string>",
"size": 123,
"full_url": "<string>",
"thumb_url": "<string>"
}
],
"variants": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"product_weight": [
{
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"box_weight": [
{
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"carton_weight": [
{
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"shipping_weight": [
{
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"pallet_weight": [
{
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"attachments": [
{
"id": 123,
"name": "<string>",
"type": "<string>",
"size": 123,
"full_url": "<string>",
"thumb_url": "<string>"
}
],
"retail_price": 123,
"wholesale_price": 123,
"custom_fields": [
{}
],
"variant_attributes": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"sku": "<string>",
"upc": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"variant_attributes": [
{
"variant_name": "<string>",
"variant_terms": [
"<string>"
]
}
],
"sku": "<string>",
"alternate_skus": [
{
"id": 123,
"sku": "<string>"
}
],
"upc": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"substitutions": [
{
"id": 123,
"priority": 123,
"product": {
"id": 123,
"name": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123,
"unit_cost": 123,
"product_weight": [
{
"value": 1
}
],
"product_weight_oz": 123,
"product_weight_lb": 123,
"dimensional_weight": [
{
"value": 1
}
],
"dimensional_weight_oz": 123,
"dimensional_weight_lb": 123,
"product_length": 123,
"product_width": 123,
"product_height": 123,
"box_weight": [
{
"value": 1
}
],
"box_weight_oz": 123,
"box_weight_lb": 123,
"box_length": 123,
"box_width": 123,
"box_height": 123,
"carton_weight": [
{
"value": 1
}
],
"carton_weight_oz": 123,
"carton_weight_lb": 123,
"carton_length": 123,
"carton_width": 123,
"carton_height": 123,
"shipping_weight": [
{
"value": 1
}
],
"shipping_weight_oz": 123,
"shipping_weight_lb": 123,
"shipping_length": 123,
"shipping_width": 123,
"shipping_height": 123,
"pallet_weight": [
{
"value": 1
}
],
"pallet_weight_oz": 123,
"pallet_weight_lb": 123,
"pallet_length": 123,
"pallet_width": 123,
"pallet_height": 123,
"sellable": true,
"discontinued": true,
"image_url": "<string>",
"sku": "<string>",
"upc": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"supplier": {},
"kit_items": [
{
"id": 123,
"product_id": 123,
"quantity": 123,
"uom_id": 123,
"base_uom_quantity": 123,
"price": 123,
"original_price": 123,
"total": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>",
"retail_price": 123,
"wholesale_price": 123
},
"unit_of_measure": {
"id": 123,
"name": "<string>",
"description": "<string>",
"base_unit": true
}
}
],
"priority_list": {
"id": 123,
"name": "<string>",
"description": "<string>"
},
"boms": [
{
"id": 123,
"name": "<string>",
"items": [
{
"id": 123,
"bom_id": 123,
"product_id": 123,
"quantity": 123,
"product": {
"id": 123,
"name": "<string>",
"sku": "<string>",
"description": "<string>"
},
"base_quantity": 123,
"note": "<string>",
"uom_id": 123,
"unit_of_measure": {
"id": 123,
"name": "<string>"
},
"order": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"extra_costs": [
{
"id": 123,
"name": "<string>",
"quantity": 123,
"unit_price": 123,
"line_total": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"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
application/json
Product name
Maximum string length:
200ID of the product category
Product category information
Show child attributes
Show child attributes
Internal SKU
Maximum string length:
100Quantity threshold for low stock alerts
Quantity threshold for reordering
Minimum quantity to maintain
ID of the preferred supplier
Product preferred supplier information
Show child attributes
Show child attributes
URL to product image
Maximum string length:
255Whether the product can be sold
Whether to track product by lots
ID of the product subcategory
Product sub-category information
Show child attributes
Show child attributes
Default location ID for receiving this product
Product description
Wholesale price
Required range:
x >= 0Retail price
Required range:
x >= 0Cost per unit
Required range:
x >= 0Manufacturing fee per unit
Required range:
x >= 0- object
- object[]
Show child attributes
Show child attributes
- object
- object[]
Show child attributes
Show child attributes
Length of the product (in inches)
Required range:
x >= 0Width of the product (in inches)
Required range:
x >= 0Height of the product (in inches)
Required range:
x >= 0- object
- object[]
Show child attributes
Show child attributes
Length of the box (in inches)
Required range:
x >= 0Width of the box (in inches)
Required range:
x >= 0Height of the box (in inches)
Required range:
x >= 0- object
- object[]
Show child attributes
Show child attributes
Length of the carton (in inches)
Required range:
x >= 0Width of the carton (in inches)
Required range:
x >= 0Height of the carton (in inches)
Required range:
x >= 0- object
- object[]
Show child attributes
Show child attributes
Shipping length (in inches)
Required range:
x >= 0Shipping width (in inches)
Required range:
x >= 0Shipping height (in inches)
Required range:
x >= 0- object
- object[]
Show child attributes
Show child attributes
Length of the pallet (in inches)
Required range:
x >= 0Width of the pallet (in inches)
Required range:
x >= 0Height of the pallet (in inches)
Required range:
x >= 0UPC/Barcode
Default supply mode used when planning replenishment for this product. Determines whether the system expects to purchase, drop-ship, assemble, or pull from on-hand stock when supplying demand.
Available options:
purchase, vendor_supplied, assemble, on_hand, assembly_order, buy_and_ship, brand_supplied Maximum string length:
50ID of the fulfillment priority list to assign to this product
Custom field values
Show child attributes
Show child attributes
Tags to associate with the product
Variant option taxonomy for the product — the axes (e.g. Size, Color) and the allowed terms on each axis.
You almost never need to set this. Tag each child SKU under variants[].product_variants
with the terms it represents instead, and Luminous will extend the parent taxonomy
automatically as the union of every term used by the children. Setting this directly is only
useful as an escape hatch (e.g. seeding an empty option set, or pruning a term no child uses).
Returned on the response as variant_attributes (same shape).
Show child attributes
Show child attributes
Product variants
Show child attributes
Show child attributes
Array of BOM IDs to attach to the product. If null or empty array, all BOMs will be detached. When updating, this will replace all existing BOM associations.
BOM ID
Response
Successful response
Show child attributes
Show child attributes
⌘I