curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved', 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}/resolved",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"profile": {
"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"
},
"metadata": {
"variant_templates": [
{}
],
"distribution_templates": [
{}
],
"custom_fields": [
{
"id": 123,
"label": "<string>",
"type": "<string>",
"options": "<unknown>",
"category": "<string>"
}
],
"field_catalog": [
{
"key": "<string>",
"label": "<string>",
"group": "<string>",
"type": "<string>",
"required_capable": true,
"default_capable": true,
"options_key": "<string>",
"parent": "<string>"
}
],
"options": {
"product_types": [
{}
],
"categories": [
{}
],
"subcategories": {},
"unit_classes": [
{}
],
"units": {},
"suppliers": [
{}
],
"supply_methods": [
{}
],
"priority_lists": [
{}
],
"boms": [
{}
],
"variant_templates": [
{}
],
"distribution_templates": [
{}
]
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}Get a product profile with builder metadata
Return a Product Builder Profile together with the metadata a builder screen needs to render in a single round-trip: the available variant presets and distribution groups, the profile’s required custom-field definitions, and the catalog of product fields an author can show/hide/label.
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved', 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}/resolved",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/product-profiles/{productProfileId}/resolved")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"profile": {
"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"
},
"metadata": {
"variant_templates": [
{}
],
"distribution_templates": [
{}
],
"custom_fields": [
{
"id": 123,
"label": "<string>",
"type": "<string>",
"options": "<unknown>",
"category": "<string>"
}
],
"field_catalog": [
{
"key": "<string>",
"label": "<string>",
"group": "<string>",
"type": "<string>",
"required_capable": true,
"default_capable": true,
"options_key": "<string>",
"parent": "<string>"
}
],
"options": {
"product_types": [
{}
],
"categories": [
{}
],
"subcategories": {},
"unit_classes": [
{}
],
"units": {},
"suppliers": [
{}
],
"supply_methods": [
{}
],
"priority_lists": [
{}
],
"boms": [
{}
],
"variant_templates": [
{}
],
"distribution_templates": [
{}
]
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}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 resolve
Response
The profile plus builder metadata
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.
Show child attributes
Show child attributes
Everything the builder screen needs to populate its pickers.
Show child attributes
Show child attributes