Creates one or more style custom field definitions.
curl --request POST \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"userDefinedId": "<string>",
"position": 123,
"internalOnly": true,
"isMandatory": true,
"isSupplierEditable": true,
"isMultiLine": true,
"isSortByAllowedValueId": true,
"diffPerColor": true,
"diffPerSize": true,
"useInThumbnailViewGroupBy": true,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"isDefaultValue": true,
"parentAllowedValueId": 123
}
],
"associatedBrands": [
{
"id": 123,
"customId": "<string>",
"name": "<string>",
"contactPersonId": "<string>",
"contactPersonName": "<string>"
}
],
"associatedGroups": [
{
"id": 123,
"customId": "<string>",
"name": "<string>"
}
],
"associatedStyleCategories": [
{
"id": 123,
"customId": "<string>",
"name": "<string>"
}
]
}
]
'import requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields"
payload = [
{
"name": "<string>",
"userDefinedId": "<string>",
"position": 123,
"internalOnly": True,
"isMandatory": True,
"isSupplierEditable": True,
"isMultiLine": True,
"isSortByAllowedValueId": True,
"diffPerColor": True,
"diffPerSize": True,
"useInThumbnailViewGroupBy": True,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"isDefaultValue": True,
"parentAllowedValueId": 123
}
],
"associatedBrands": [
{
"id": 123,
"customId": "<string>",
"name": "<string>",
"contactPersonId": "<string>",
"contactPersonName": "<string>"
}
],
"associatedGroups": [
{
"id": 123,
"customId": "<string>",
"name": "<string>"
}
],
"associatedStyleCategories": [
{
"id": 123,
"customId": "<string>",
"name": "<string>"
}
]
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
name: '<string>',
userDefinedId: '<string>',
position: 123,
internalOnly: true,
isMandatory: true,
isSupplierEditable: true,
isMultiLine: true,
isSortByAllowedValueId: true,
diffPerColor: true,
diffPerSize: true,
useInThumbnailViewGroupBy: true,
maxChar: 123,
allowedDecimals: 123,
parentCustomFieldId: 123,
allowedValues: [
{
id: 123,
value: '<string>',
userDefinedId: '<string>',
isDefaultValue: true,
parentAllowedValueId: 123
}
],
associatedBrands: [
{
id: 123,
customId: '<string>',
name: '<string>',
contactPersonId: '<string>',
contactPersonName: '<string>'
}
],
associatedGroups: [{id: 123, customId: '<string>', name: '<string>'}],
associatedStyleCategories: [{id: 123, customId: '<string>', name: '<string>'}]
}
])
};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields', 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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields",
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>',
'userDefinedId' => '<string>',
'position' => 123,
'internalOnly' => true,
'isMandatory' => true,
'isSupplierEditable' => true,
'isMultiLine' => true,
'isSortByAllowedValueId' => true,
'diffPerColor' => true,
'diffPerSize' => true,
'useInThumbnailViewGroupBy' => true,
'maxChar' => 123,
'allowedDecimals' => 123,
'parentCustomFieldId' => 123,
'allowedValues' => [
[
'id' => 123,
'value' => '<string>',
'userDefinedId' => '<string>',
'isDefaultValue' => true,
'parentAllowedValueId' => 123
]
],
'associatedBrands' => [
[
'id' => 123,
'customId' => '<string>',
'name' => '<string>',
'contactPersonId' => '<string>',
'contactPersonName' => '<string>'
]
],
'associatedGroups' => [
[
'id' => 123,
'customId' => '<string>',
'name' => '<string>'
]
],
'associatedStyleCategories' => [
[
'id' => 123,
'customId' => '<string>',
'name' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields"
payload := strings.NewReader("[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isSupplierEditable\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"diffPerColor\": true,\n \"diffPerSize\": true,\n \"useInThumbnailViewGroupBy\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true,\n \"parentAllowedValueId\": 123\n }\n ],\n \"associatedBrands\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\",\n \"contactPersonId\": \"<string>\",\n \"contactPersonName\": \"<string>\"\n }\n ],\n \"associatedGroups\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"associatedStyleCategories\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields")
.header("Content-Type", "application/json")
.body("[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isSupplierEditable\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"diffPerColor\": true,\n \"diffPerSize\": true,\n \"useInThumbnailViewGroupBy\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true,\n \"parentAllowedValueId\": 123\n }\n ],\n \"associatedBrands\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\",\n \"contactPersonId\": \"<string>\",\n \"contactPersonName\": \"<string>\"\n }\n ],\n \"associatedGroups\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"associatedStyleCategories\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isSupplierEditable\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"diffPerColor\": true,\n \"diffPerSize\": true,\n \"useInThumbnailViewGroupBy\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true,\n \"parentAllowedValueId\": 123\n }\n ],\n \"associatedBrands\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\",\n \"contactPersonId\": \"<string>\",\n \"contactPersonName\": \"<string>\"\n }\n ],\n \"associatedGroups\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"associatedStyleCategories\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"name": "<string>",
"userDefinedId": "<string>",
"type": "allowedValue",
"state": "active",
"position": 123,
"maxChar": 123,
"allowedDecimals": 123,
"numericVariantCalculationFormula": "none",
"parentCustomFieldId": 123,
"parentCustomFieldName": "<string>",
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"parentAllowedValueId": 123,
"properties": [
"<string>"
]
}
],
"associatedBrands": [
{
"id": 123,
"name": "<string>"
}
],
"associatedGroups": [
{
"id": 123,
"name": "<string>"
}
],
"associatedStyleCategories": [
{
"id": 123,
"name": "<string>"
}
],
"properties": [
"<string>"
]
}
]
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}StyleCustomFields
Creates one or more style custom field definitions.
Body is always an array, even for a single item. All items are persisted in a single transaction (all-or-nothing). Capped at 200 items per request.
POST
/
api
/
style-custom-fields
Creates one or more style custom field definitions.
curl --request POST \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"userDefinedId": "<string>",
"position": 123,
"internalOnly": true,
"isMandatory": true,
"isSupplierEditable": true,
"isMultiLine": true,
"isSortByAllowedValueId": true,
"diffPerColor": true,
"diffPerSize": true,
"useInThumbnailViewGroupBy": true,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"isDefaultValue": true,
"parentAllowedValueId": 123
}
],
"associatedBrands": [
{
"id": 123,
"customId": "<string>",
"name": "<string>",
"contactPersonId": "<string>",
"contactPersonName": "<string>"
}
],
"associatedGroups": [
{
"id": 123,
"customId": "<string>",
"name": "<string>"
}
],
"associatedStyleCategories": [
{
"id": 123,
"customId": "<string>",
"name": "<string>"
}
]
}
]
'import requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields"
payload = [
{
"name": "<string>",
"userDefinedId": "<string>",
"position": 123,
"internalOnly": True,
"isMandatory": True,
"isSupplierEditable": True,
"isMultiLine": True,
"isSortByAllowedValueId": True,
"diffPerColor": True,
"diffPerSize": True,
"useInThumbnailViewGroupBy": True,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"isDefaultValue": True,
"parentAllowedValueId": 123
}
],
"associatedBrands": [
{
"id": 123,
"customId": "<string>",
"name": "<string>",
"contactPersonId": "<string>",
"contactPersonName": "<string>"
}
],
"associatedGroups": [
{
"id": 123,
"customId": "<string>",
"name": "<string>"
}
],
"associatedStyleCategories": [
{
"id": 123,
"customId": "<string>",
"name": "<string>"
}
]
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
name: '<string>',
userDefinedId: '<string>',
position: 123,
internalOnly: true,
isMandatory: true,
isSupplierEditable: true,
isMultiLine: true,
isSortByAllowedValueId: true,
diffPerColor: true,
diffPerSize: true,
useInThumbnailViewGroupBy: true,
maxChar: 123,
allowedDecimals: 123,
parentCustomFieldId: 123,
allowedValues: [
{
id: 123,
value: '<string>',
userDefinedId: '<string>',
isDefaultValue: true,
parentAllowedValueId: 123
}
],
associatedBrands: [
{
id: 123,
customId: '<string>',
name: '<string>',
contactPersonId: '<string>',
contactPersonName: '<string>'
}
],
associatedGroups: [{id: 123, customId: '<string>', name: '<string>'}],
associatedStyleCategories: [{id: 123, customId: '<string>', name: '<string>'}]
}
])
};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields', 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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields",
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>',
'userDefinedId' => '<string>',
'position' => 123,
'internalOnly' => true,
'isMandatory' => true,
'isSupplierEditable' => true,
'isMultiLine' => true,
'isSortByAllowedValueId' => true,
'diffPerColor' => true,
'diffPerSize' => true,
'useInThumbnailViewGroupBy' => true,
'maxChar' => 123,
'allowedDecimals' => 123,
'parentCustomFieldId' => 123,
'allowedValues' => [
[
'id' => 123,
'value' => '<string>',
'userDefinedId' => '<string>',
'isDefaultValue' => true,
'parentAllowedValueId' => 123
]
],
'associatedBrands' => [
[
'id' => 123,
'customId' => '<string>',
'name' => '<string>',
'contactPersonId' => '<string>',
'contactPersonName' => '<string>'
]
],
'associatedGroups' => [
[
'id' => 123,
'customId' => '<string>',
'name' => '<string>'
]
],
'associatedStyleCategories' => [
[
'id' => 123,
'customId' => '<string>',
'name' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields"
payload := strings.NewReader("[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isSupplierEditable\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"diffPerColor\": true,\n \"diffPerSize\": true,\n \"useInThumbnailViewGroupBy\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true,\n \"parentAllowedValueId\": 123\n }\n ],\n \"associatedBrands\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\",\n \"contactPersonId\": \"<string>\",\n \"contactPersonName\": \"<string>\"\n }\n ],\n \"associatedGroups\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"associatedStyleCategories\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields")
.header("Content-Type", "application/json")
.body("[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isSupplierEditable\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"diffPerColor\": true,\n \"diffPerSize\": true,\n \"useInThumbnailViewGroupBy\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true,\n \"parentAllowedValueId\": 123\n }\n ],\n \"associatedBrands\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\",\n \"contactPersonId\": \"<string>\",\n \"contactPersonName\": \"<string>\"\n }\n ],\n \"associatedGroups\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"associatedStyleCategories\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isSupplierEditable\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"diffPerColor\": true,\n \"diffPerSize\": true,\n \"useInThumbnailViewGroupBy\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true,\n \"parentAllowedValueId\": 123\n }\n ],\n \"associatedBrands\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\",\n \"contactPersonId\": \"<string>\",\n \"contactPersonName\": \"<string>\"\n }\n ],\n \"associatedGroups\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"associatedStyleCategories\": [\n {\n \"id\": 123,\n \"customId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"name": "<string>",
"userDefinedId": "<string>",
"type": "allowedValue",
"state": "active",
"position": 123,
"maxChar": 123,
"allowedDecimals": 123,
"numericVariantCalculationFormula": "none",
"parentCustomFieldId": 123,
"parentCustomFieldName": "<string>",
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"parentAllowedValueId": 123,
"properties": [
"<string>"
]
}
],
"associatedBrands": [
{
"id": 123,
"name": "<string>"
}
],
"associatedGroups": [
{
"id": 123,
"name": "<string>"
}
],
"associatedStyleCategories": [
{
"id": 123,
"name": "<string>"
}
],
"properties": [
"<string>"
]
}
]
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Headers
Body
application/jsontext/jsonapplication/*+json
Display name of the custom field. Required.
Optional user-defined identifier for referencing the field in imports, exports, and integrations.
Field type that determines the input control and the kind of value the field accepts.
Available options:
allowedValue, date, text, nestedAllowedValue, numeric, divider Ordering position of the field among the style custom fields. Lower values appear first.
Initial lifecycle state of the field. Defaults to active, and the deleted state is rejected on create.
Available options:
active, inactive, deleted When true, the field is hidden from supplier users.
When true, the field must be filled in before a style can be marked ready for export.
When true, supplier users are allowed to edit this field's value on a style.
For text fields, when true the field is shown as a multi-line text box instead of a single-line input.
For allowed-value fields, when true the options are ordered by their user-defined code rather than by display text.
When true, the field can hold a separate value for each color of a style.
When true, the field can hold a separate value for each size of a style.
When true, styles can be grouped by this field's value in the thumbnail view.
Optional maximum number of characters allowed for the field's value. Must be positive when set.
For numeric fields, the number of decimal places permitted. Defaults to 0 for whole numbers only.
For numeric fields differentiated per color or size, controls how the per-variant values are aggregated in reporting.
Available options:
none, average, sum For a nested allowed-value field, the identifier of the parent field that supplies the top-level options. Null for top-level fields.
Selectable options for an allowed-value or nested allowed-value field. Omit or send null to create the field with no options.
Show child attributes
Show child attributes
Brands to restrict the field to. Omit or send null to make the field available on styles of any brand.
Show child attributes
Show child attributes
Style groups to restrict the field to. Omit or send null to make the field available on styles in any group.
Show child attributes
Show child attributes
Style categories to restrict the field to. Omit or send null to make the field available on styles in any category.
Show child attributes
Show child attributes
Response
Created
The coarse outcome of the request, indicating whether it succeeded or failed.
Available options:
success, error The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.
The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.
Show child attributes
Show child attributes