Update a product builder profile
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"is_active": true,
"config": {
"sku_format": {
"regex": "<string>",
"hint": "<string>"
},
"required_variant_template": {
"variant_template_id": 123
},
"required_distribution_template": {
"grid_template_id": 123
},
"required_category": {
"category_id": 123,
"sub_category_id": 123
},
"required_custom_field_ids": [
123
],
"hidden_defaults": {},
"fields": {
"visible": [
"<string>"
],
"hidden": [
"<string>"
],
"order": [
"<string>"
],
"labels": {},
"required_overrides": {}
},
"context": {}
}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}"
payload = {
"name": "<string>",
"slug": "<string>",
"is_active": True,
"config": {
"sku_format": {
"regex": "<string>",
"hint": "<string>"
},
"required_variant_template": { "variant_template_id": 123 },
"required_distribution_template": { "grid_template_id": 123 },
"required_category": {
"category_id": 123,
"sub_category_id": 123
},
"required_custom_field_ids": [123],
"hidden_defaults": {},
"fields": {
"visible": ["<string>"],
"hidden": ["<string>"],
"order": ["<string>"],
"labels": {},
"required_overrides": {}
},
"context": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
is_active: true,
config: {
sku_format: {regex: '<string>', hint: '<string>'},
required_variant_template: {variant_template_id: 123},
required_distribution_template: {grid_template_id: 123},
required_category: {category_id: 123, sub_category_id: 123},
required_custom_field_ids: [123],
hidden_defaults: {},
fields: {
visible: ['<string>'],
hidden: ['<string>'],
order: ['<string>'],
labels: {},
required_overrides: {}
},
context: {}
}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}', 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/product-profiles/{productProfileId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'is_active' => true,
'config' => [
'sku_format' => [
'regex' => '<string>',
'hint' => '<string>'
],
'required_variant_template' => [
'variant_template_id' => 123
],
'required_distribution_template' => [
'grid_template_id' => 123
],
'required_category' => [
'category_id' => 123,
'sub_category_id' => 123
],
'required_custom_field_ids' => [
123
],
'hidden_defaults' => [
],
'fields' => [
'visible' => [
'<string>'
],
'hidden' => [
'<string>'
],
'order' => [
'<string>'
],
'labels' => [
],
'required_overrides' => [
]
],
'context' => [
]
]
]),
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/product-profiles/{productProfileId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"<string>\",\n \"hint\": \"<string>\"\n },\n \"required_variant_template\": {\n \"variant_template_id\": 123\n },\n \"required_distribution_template\": {\n \"grid_template_id\": 123\n },\n \"required_category\": {\n \"category_id\": 123,\n \"sub_category_id\": 123\n },\n \"required_custom_field_ids\": [\n 123\n ],\n \"hidden_defaults\": {},\n \"fields\": {\n \"visible\": [\n \"<string>\"\n ],\n \"hidden\": [\n \"<string>\"\n ],\n \"order\": [\n \"<string>\"\n ],\n \"labels\": {},\n \"required_overrides\": {}\n },\n \"context\": {}\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"<string>\",\n \"hint\": \"<string>\"\n },\n \"required_variant_template\": {\n \"variant_template_id\": 123\n },\n \"required_distribution_template\": {\n \"grid_template_id\": 123\n },\n \"required_category\": {\n \"category_id\": 123,\n \"sub_category_id\": 123\n },\n \"required_custom_field_ids\": [\n 123\n ],\n \"hidden_defaults\": {},\n \"fields\": {\n \"visible\": [\n \"<string>\"\n ],\n \"hidden\": [\n \"<string>\"\n ],\n \"order\": [\n \"<string>\"\n ],\n \"labels\": {},\n \"required_overrides\": {}\n },\n \"context\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"<string>\",\n \"hint\": \"<string>\"\n },\n \"required_variant_template\": {\n \"variant_template_id\": 123\n },\n \"required_distribution_template\": {\n \"grid_template_id\": 123\n },\n \"required_category\": {\n \"category_id\": 123,\n \"sub_category_id\": 123\n },\n \"required_custom_field_ids\": [\n 123\n ],\n \"hidden_defaults\": {},\n \"fields\": {\n \"visible\": [\n \"<string>\"\n ],\n \"hidden\": [\n \"<string>\"\n ],\n \"order\": [\n \"<string>\"\n ],\n \"labels\": {},\n \"required_overrides\": {}\n },\n \"context\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"slug": "<string>",
"is_active": true,
"config": {
"sku_format": {
"regex": "<string>",
"hint": "<string>"
},
"required_variant_template": {
"mode": "must_pick",
"variant_template_id": 123
},
"required_distribution_template": {
"mode": "must_pick",
"grid_template_id": 123
},
"required_category": {
"mode": "must_pick",
"category_id": 123,
"sub_category_id": 123
},
"required_custom_field_ids": [
123
],
"hidden_defaults": {},
"fields": {
"visible": [
"<string>"
],
"hidden": [
"<string>"
],
"order": [
"<string>"
],
"labels": {},
"required_overrides": {}
},
"context": {}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Product Builder Profiles
Update a product builder profile
Full update of a Product Builder Profile. Same body shape as create; the name/slug
uniqueness checks ignore the profile being edited. Only name, slug, config, and
is_active are persisted.
PUT
/
product-profiles
/
{productProfileId}
Update a product builder profile
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"is_active": true,
"config": {
"sku_format": {
"regex": "<string>",
"hint": "<string>"
},
"required_variant_template": {
"variant_template_id": 123
},
"required_distribution_template": {
"grid_template_id": 123
},
"required_category": {
"category_id": 123,
"sub_category_id": 123
},
"required_custom_field_ids": [
123
],
"hidden_defaults": {},
"fields": {
"visible": [
"<string>"
],
"hidden": [
"<string>"
],
"order": [
"<string>"
],
"labels": {},
"required_overrides": {}
},
"context": {}
}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}"
payload = {
"name": "<string>",
"slug": "<string>",
"is_active": True,
"config": {
"sku_format": {
"regex": "<string>",
"hint": "<string>"
},
"required_variant_template": { "variant_template_id": 123 },
"required_distribution_template": { "grid_template_id": 123 },
"required_category": {
"category_id": 123,
"sub_category_id": 123
},
"required_custom_field_ids": [123],
"hidden_defaults": {},
"fields": {
"visible": ["<string>"],
"hidden": ["<string>"],
"order": ["<string>"],
"labels": {},
"required_overrides": {}
},
"context": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
is_active: true,
config: {
sku_format: {regex: '<string>', hint: '<string>'},
required_variant_template: {variant_template_id: 123},
required_distribution_template: {grid_template_id: 123},
required_category: {category_id: 123, sub_category_id: 123},
required_custom_field_ids: [123],
hidden_defaults: {},
fields: {
visible: ['<string>'],
hidden: ['<string>'],
order: ['<string>'],
labels: {},
required_overrides: {}
},
context: {}
}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}', 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/product-profiles/{productProfileId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'is_active' => true,
'config' => [
'sku_format' => [
'regex' => '<string>',
'hint' => '<string>'
],
'required_variant_template' => [
'variant_template_id' => 123
],
'required_distribution_template' => [
'grid_template_id' => 123
],
'required_category' => [
'category_id' => 123,
'sub_category_id' => 123
],
'required_custom_field_ids' => [
123
],
'hidden_defaults' => [
],
'fields' => [
'visible' => [
'<string>'
],
'hidden' => [
'<string>'
],
'order' => [
'<string>'
],
'labels' => [
],
'required_overrides' => [
]
],
'context' => [
]
]
]),
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/product-profiles/{productProfileId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"<string>\",\n \"hint\": \"<string>\"\n },\n \"required_variant_template\": {\n \"variant_template_id\": 123\n },\n \"required_distribution_template\": {\n \"grid_template_id\": 123\n },\n \"required_category\": {\n \"category_id\": 123,\n \"sub_category_id\": 123\n },\n \"required_custom_field_ids\": [\n 123\n ],\n \"hidden_defaults\": {},\n \"fields\": {\n \"visible\": [\n \"<string>\"\n ],\n \"hidden\": [\n \"<string>\"\n ],\n \"order\": [\n \"<string>\"\n ],\n \"labels\": {},\n \"required_overrides\": {}\n },\n \"context\": {}\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"<string>\",\n \"hint\": \"<string>\"\n },\n \"required_variant_template\": {\n \"variant_template_id\": 123\n },\n \"required_distribution_template\": {\n \"grid_template_id\": 123\n },\n \"required_category\": {\n \"category_id\": 123,\n \"sub_category_id\": 123\n },\n \"required_custom_field_ids\": [\n 123\n ],\n \"hidden_defaults\": {},\n \"fields\": {\n \"visible\": [\n \"<string>\"\n ],\n \"hidden\": [\n \"<string>\"\n ],\n \"order\": [\n \"<string>\"\n ],\n \"labels\": {},\n \"required_overrides\": {}\n },\n \"context\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"<string>\",\n \"hint\": \"<string>\"\n },\n \"required_variant_template\": {\n \"variant_template_id\": 123\n },\n \"required_distribution_template\": {\n \"grid_template_id\": 123\n },\n \"required_category\": {\n \"category_id\": 123,\n \"sub_category_id\": 123\n },\n \"required_custom_field_ids\": [\n 123\n ],\n \"hidden_defaults\": {},\n \"fields\": {\n \"visible\": [\n \"<string>\"\n ],\n \"hidden\": [\n \"<string>\"\n ],\n \"order\": [\n \"<string>\"\n ],\n \"labels\": {},\n \"required_overrides\": {}\n },\n \"context\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"slug": "<string>",
"is_active": true,
"config": {
"sku_format": {
"regex": "<string>",
"hint": "<string>"
},
"required_variant_template": {
"mode": "must_pick",
"variant_template_id": 123
},
"required_distribution_template": {
"mode": "must_pick",
"grid_template_id": 123
},
"required_category": {
"mode": "must_pick",
"category_id": 123,
"sub_category_id": 123
},
"required_custom_field_ids": [
123
],
"hidden_defaults": {},
"fields": {
"visible": [
"<string>"
],
"hidden": [
"<string>"
],
"order": [
"<string>"
],
"labels": {},
"required_overrides": {}
},
"context": {}
},
"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.
Path Parameters
ID of the product profile to update
Body
application/json
Profile name (unique among non-deleted profiles, ignoring this profile)
Maximum string length:
255Optional URL-friendly identifier (unique among non-deleted profiles, ignoring this profile)
Maximum string length:
255Whether the profile is active
The heterogeneous builder specification for a Product Builder Profile. Unknown keys are permitted so the schema can grow without a code change; the keys enforcement and the builder screen actually read are documented below.
Show child attributes
Show child attributes
Response
The updated product profile
A Product Builder Profile — a reusable configuration that drives a simplified product-create screen and, when referenced from a product create, enforces its constraints (SKU format, required variant preset / distribution group / custom fields) and stamps its fixed defaults.
Unique identifier for the profile
Human-readable profile name (unique among non-deleted profiles)
Optional URL-friendly identifier (unique among non-deleted profiles). Can be used in place of profile_id when referencing the profile from a product create via profile_slug.
Whether the profile is active. Inactive profiles are ignored by enforcement.
The heterogeneous builder specification for a Product Builder Profile. Unknown keys are permitted so the schema can grow without a code change; the keys enforcement and the builder screen actually read are documented below.
Show child attributes
Show child attributes