curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Apparel — Simplified",
"slug": "apparel-simplified",
"is_active": true,
"config": {
"sku_format": {
"regex": "^APP-[A-Z0-9]{4,}$",
"hint": "APP- followed by 4+ letters or digits"
},
"required_variant_template": {
"mode": "must_pick"
},
"required_custom_field_ids": [
42,
51
]
}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles"
payload = {
"name": "Apparel — Simplified",
"slug": "apparel-simplified",
"is_active": True,
"config": {
"sku_format": {
"regex": "^APP-[A-Z0-9]{4,}$",
"hint": "APP- followed by 4+ letters or digits"
},
"required_variant_template": { "mode": "must_pick" },
"required_custom_field_ids": [42, 51]
}
}
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: 'Apparel — Simplified',
slug: 'apparel-simplified',
is_active: true,
config: {
sku_format: {regex: '^APP-[A-Z0-9]{4,}$', hint: 'APP- followed by 4+ letters or digits'},
required_variant_template: {mode: 'must_pick'},
required_custom_field_ids: [42, 51]
}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles', 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",
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' => 'Apparel — Simplified',
'slug' => 'apparel-simplified',
'is_active' => true,
'config' => [
'sku_format' => [
'regex' => '^APP-[A-Z0-9]{4,}$',
'hint' => 'APP- followed by 4+ letters or digits'
],
'required_variant_template' => [
'mode' => 'must_pick'
],
'required_custom_field_ids' => [
42,
51
]
]
]),
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"
payload := strings.NewReader("{\n \"name\": \"Apparel — Simplified\",\n \"slug\": \"apparel-simplified\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"^APP-[A-Z0-9]{4,}$\",\n \"hint\": \"APP- followed by 4+ letters or digits\"\n },\n \"required_variant_template\": {\n \"mode\": \"must_pick\"\n },\n \"required_custom_field_ids\": [\n 42,\n 51\n ]\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/product-profiles")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Apparel — Simplified\",\n \"slug\": \"apparel-simplified\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"^APP-[A-Z0-9]{4,}$\",\n \"hint\": \"APP- followed by 4+ letters or digits\"\n },\n \"required_variant_template\": {\n \"mode\": \"must_pick\"\n },\n \"required_custom_field_ids\": [\n 42,\n 51\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles")
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\": \"Apparel — Simplified\",\n \"slug\": \"apparel-simplified\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"^APP-[A-Z0-9]{4,}$\",\n \"hint\": \"APP- followed by 4+ letters or digits\"\n },\n \"required_variant_template\": {\n \"mode\": \"must_pick\"\n },\n \"required_custom_field_ids\": [\n 42,\n 51\n ]\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>",
"errors": {}
}Create a product builder profile
Create a Product Builder Profile. The heterogeneous builder specification lives under
config; unknown config keys are permitted so the schema can grow without a code change.
name must be unique among non-deleted profiles, and slug (if provided) likewise.
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Apparel — Simplified",
"slug": "apparel-simplified",
"is_active": true,
"config": {
"sku_format": {
"regex": "^APP-[A-Z0-9]{4,}$",
"hint": "APP- followed by 4+ letters or digits"
},
"required_variant_template": {
"mode": "must_pick"
},
"required_custom_field_ids": [
42,
51
]
}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles"
payload = {
"name": "Apparel — Simplified",
"slug": "apparel-simplified",
"is_active": True,
"config": {
"sku_format": {
"regex": "^APP-[A-Z0-9]{4,}$",
"hint": "APP- followed by 4+ letters or digits"
},
"required_variant_template": { "mode": "must_pick" },
"required_custom_field_ids": [42, 51]
}
}
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: 'Apparel — Simplified',
slug: 'apparel-simplified',
is_active: true,
config: {
sku_format: {regex: '^APP-[A-Z0-9]{4,}$', hint: 'APP- followed by 4+ letters or digits'},
required_variant_template: {mode: 'must_pick'},
required_custom_field_ids: [42, 51]
}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles', 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",
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' => 'Apparel — Simplified',
'slug' => 'apparel-simplified',
'is_active' => true,
'config' => [
'sku_format' => [
'regex' => '^APP-[A-Z0-9]{4,}$',
'hint' => 'APP- followed by 4+ letters or digits'
],
'required_variant_template' => [
'mode' => 'must_pick'
],
'required_custom_field_ids' => [
42,
51
]
]
]),
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"
payload := strings.NewReader("{\n \"name\": \"Apparel — Simplified\",\n \"slug\": \"apparel-simplified\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"^APP-[A-Z0-9]{4,}$\",\n \"hint\": \"APP- followed by 4+ letters or digits\"\n },\n \"required_variant_template\": {\n \"mode\": \"must_pick\"\n },\n \"required_custom_field_ids\": [\n 42,\n 51\n ]\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/product-profiles")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Apparel — Simplified\",\n \"slug\": \"apparel-simplified\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"^APP-[A-Z0-9]{4,}$\",\n \"hint\": \"APP- followed by 4+ letters or digits\"\n },\n \"required_variant_template\": {\n \"mode\": \"must_pick\"\n },\n \"required_custom_field_ids\": [\n 42,\n 51\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles")
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\": \"Apparel — Simplified\",\n \"slug\": \"apparel-simplified\",\n \"is_active\": true,\n \"config\": {\n \"sku_format\": {\n \"regex\": \"^APP-[A-Z0-9]{4,}$\",\n \"hint\": \"APP- followed by 4+ letters or digits\"\n },\n \"required_variant_template\": {\n \"mode\": \"must_pick\"\n },\n \"required_custom_field_ids\": [\n 42,\n 51\n ]\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>",
"errors": {}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Body
Profile name (unique among non-deleted profiles)
255Optional URL-friendly identifier (unique among non-deleted profiles)
255Whether the profile is active. Defaults to the model default when omitted.
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
Profile created
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