Bulk Attribute Descriptions

POST 
/v2/attribute-descriptions/bulk/name

Creates and/or updates Attribute Descriptions in bulk by name

Request

application/json

Body

array

required

The Attribute Descriptions to create or update

• Array [

namestringrequired
Descriptive identifier (Screaming Snake Case)
Example: ATTRIBUTE_NAME

descriptions

object[]

required

Attribute descriptions per language

Array [

languagestringrequired

Localized field language code

Possible values: >= 2 characters and <= 2 characters

Example: EN

valuestringnullablerequired

Localized field value

Example: example value

]

units

object[]

Attribute unit per language

Array [

languagestringrequired

Localized field language code

Possible values: >= 2 characters and <= 2 characters

Example: EN

valuestringnullablerequired

Localized field value

Example: example value

]

typestringrequired
Attribute type. One of: [text, enum, color, datetime, integer, decimal]
Possible values: [text, enum, color, datetime, integer, decimal]
Example: color
attributeClassstringrequired
Attribute class. One of: [product, category, cluster, customer, contact, company]
Possible values: [product, category, cluster, customer, contact, company]
Example: customer
valuesetIdinteger
Unique identifier for the connected valueset
Example: 1234
groupstring
The attribute group
Possible values: <= 64 characters
Example: GROUP_NAME
isSearchableboolean
Flags whether this attribute should be used when generating catalog page filters
Default value: true
Example: true
isPublicboolean
Flags whether this attribute should be used when generating product specifications.
Default value: true
Example: true
isSystemboolean
Flags whether this attribute is only available to system users
Default value: false
Example: false
isHiddenboolean
Flags whether this attribute is hidden and should only be used for background operations.
Default value: false
Example: false

defaultValue

object

required

textValues

object[]

Attribute value descriptions per language, required for TEXT type attributes

Array [

languagestringrequired

Language is set as 2 character country code.

Possible values: >= 2 characters and <= 2 characters

Example: EN

valuesarray[]

List of localized string values

Example: ["Hello","World"]

]

enumValuesstring[]

Attribute enum values, required for ENUM type attributes

Example: ["VALUE_1","VALUE_2"]

intValueinteger

Attribute integer value, required for INTEGER type attributes

Example: 42

decimalValuenumber

Attribute decimal value, required for DECIMAL type attributes

Example: 9.99

dateTimeValuedate-timenullable

Attribute datetime value, required for DATETIME type attributes

Example: 2021-01-01T00:00:00Z

colorValuestring

Attribute color value, required for COLOR type attributes

Example: #000000

• ]

Responses

200

A list of operations performed on the Attribute Descriptions

application/json

Schema

Schema

• Array [

idstringnullablerequired

ID of the created or updated attribute description

namestringrequired

Name of the created or updated attribute description

messagestringnullablerequired

Success or error message

actionstringrequired
Action performed on the attribute description
Possible values: [update, create, ignored, delete]
Example: create
successbooleanrequired
Whether the action was successful or not
Example: true

• ]

Example (from schema)

[
  {
    "id": "string",
    "name": "string",
    "message": "string",
    "action": "create",
    "success": true
  }
]