Bulk-updates and/or soft-deletes style custom field definitions in a single transaction.
curl --request PUT \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields \
--header 'Content-Type: application/json' \
--data '
[
{
"id": 123,
"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,
"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 = [
{
"id": 123,
"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,
"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.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
id: 123,
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,
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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'id' => 123,
'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,
'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 \"id\": 123,\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 \"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("PUT", 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.put("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields")
.header("Content-Type", "application/json")
.body("[\n {\n \"id\": 123,\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 \"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::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"id\": 123,\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 \"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": {
"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
Bulk-updates and/or soft-deletes style custom field definitions in a single transaction.
Bulk PUT with all-or-nothing semantics. Each item must include id. state=“deleted” routes that item through the soft-delete code path so delete-time rules fire; mixed update + delete batches commit together. Capped at 200 items per request.
PUT
/
api
/
style-custom-fields
Bulk-updates and/or soft-deletes style custom field definitions in a single transaction.
curl --request PUT \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields \
--header 'Content-Type: application/json' \
--data '
[
{
"id": 123,
"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,
"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 = [
{
"id": 123,
"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,
"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.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
id: 123,
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,
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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'id' => 123,
'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,
'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 \"id\": 123,\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 \"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("PUT", 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.put("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/style-custom-fields")
.header("Content-Type", "application/json")
.body("[\n {\n \"id\": 123,\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 \"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::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"id\": 123,\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 \"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": {
"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
Identifier of the style custom field to update. Required for every item in a bulk update.
New display name for the field. Required on a full replace.
User-defined identifier for referencing the field in imports, exports, and integrations.
New lifecycle state for the field. Required on a full replace. PUT and PATCH /api/style-custom-fields/{id} reject deleted with 400; on the bulk PUT /api/style-custom-fields, deleted soft-deletes the field.
Available options:
active, inactive, deleted Read-only ordering position; it cannot be changed here, and supplying a non-null value is rejected.
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.
Maximum number of characters allowed for the field's value. Null means no limit.
For numeric fields, the number of decimal places permitted, with 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 Complete set of allowed options for the field. On a full replace it replaces the existing options, and an empty array clears them all.
Show child attributes
Show child attributes
Complete set of brands the field is restricted to. On a full replace it replaces existing associations, and an empty array removes all brand restrictions.
Show child attributes
Show child attributes
Complete set of style groups the field is restricted to. On a full replace it replaces existing associations, and an empty array removes all group restrictions.
Show child attributes
Show child attributes
Complete set of style categories the field is restricted to. On a full replace it replaces existing associations, and an empty array removes all category restrictions.
Show child attributes
Show child attributes
Response
OK
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