Create Attribute Description
POST/v2/attribute-descriptions
Creates a new Attribute Description
Request
- application/json
Body
required
The Attribute Description to create
Array [
]
Array [
]
Array [
]
Descriptive identifier (Screaming Snake Case)
ATTRIBUTE_NAME
descriptions
object[]
required
Attribute descriptions per language
Localized field language code
Possible values: >= 2 characters
and <= 2 characters
EN
Localized field value
example value
units
object[]
Attribute unit per language
Localized field language code
Possible values: >= 2 characters
and <= 2 characters
EN
Localized field value
example value
Attribute type. One of: [text, enum, color, datetime, integer, decimal]
Possible values: [text
, enum
, color
, datetime
, integer
, decimal
]
color
Attribute class. One of: [product, category, cluster, customer, contact, company]
Possible values: [product
, category
, cluster
, customer
, contact
, company
]
customer
Unique identifier for the connected valueset
1234
The attribute group
Possible values: <= 64 characters
GROUP_NAME
Flags whether this attribute should be used when generating catalog page filters
true
true
Flags whether this attribute should be used when generating product specifications.
true
true
Flags whether this attribute is only available to system users
false
false
Flags whether this attribute is hidden and should only be used for background operations.
false
false
defaultValue
object
required
textValues
object[]
Attribute value descriptions per language, required for TEXT type attributes
Language is set as 2 character country code.
Possible values: >= 2 characters
and <= 2 characters
EN
List of localized string values
["Hello","World"]
Attribute enum values, required for ENUM type attributes
["VALUE_1","VALUE_2"]
Attribute integer value, required for INTEGER type attributes
42
Attribute decimal value, required for DECIMAL type attributes
9.99
Attribute datetime value, required for DATETIME type attributes
2021-01-01T00:00:00Z
Attribute color value, required for COLOR type attributes
#000000
Responses
- 201
- 400
- 401
- 409
- 500
The created Attribute description
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
- AttributeTextValue
- AttributeEnumValue
- AttributeIntValue
- AttributeDecimalValue
- AttributeColorValue
- AttributeDateTimeValue
Array [
]
Attribute description primary identifier
e1de4af7-7301-44bc-a2d7-02342310ea34
Descriptive identifier for this AttributeDescription
ATTRIBUTE_NAME
descriptions
object[]
required
The human readable description of the attribute's name. This is a language specific value.
Language is set as 2 character country code.
Possible values: >= 2 characters
and <= 2 characters
EN
Localized field value
example value
units
object[]
nullable
required
Attribute unit per language
Language is set as 2 character country code.
Possible values: >= 2 characters
and <= 2 characters
EN
Localized field value
example value
The class for this attribute. One of: [product, category, cluster, customer, contact, company]
Possible values: [text
, enum
, color
, datetime
, integer
, decimal
]
Attribute class. One of: [product, category, cluster, customer, contact, company]
Possible values: [product
, category
, cluster
, customer
, contact
, company
]
The ID of the connected valueset to use when type is ENUM
1234
The group this attribute belongs to, generally linked to a valueset.
ATTRIBUTE_GROUP
Flags whether this attribute should be used when generating catalog page filters
false
true
Flags whether this attribute should be used when generating product specifications.
true
true
Flags whether this attribute is only available to system users
false
false
Flags whether this attribute is hidden and should only be used for background operations.
false
false
Attribute description creation date
2022-01-01T00:00:00.000Z
Attribute description last modified date
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute description
1234
The userId of the user that last modified the attribute description
1234
defaultValue
object
required
The default value for this attribute
oneOf
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
textValues
object[]
required
Attribute textValues per language
Language is set as 2 character country code.
Possible values: >= 2 characters
and <= 2 characters
EN
List of localized string values
["Hello","World"]
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute enum values
["VALUE_1","VALUE_2"]
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute integer value
1234
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute decimal value
1234.5678
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute color value, stored as a hex string
#FFFFFF
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute decimal value
2020-01-01T00:00:00.000Z
{
"id": "e1de4af7-7301-44bc-a2d7-02342310ea34",
"name": "ATTRIBUTE_NAME",
"descriptions": [
{
"language": "NL",
"value": "Dutch desc."
},
{
"language": "DE",
"value": "German desc."
}
],
"units": [
{
"language": "NL",
"value": "Dutch unit."
},
{
"language": "DE",
"value": "German unit."
}
],
"attributeClass": "text",
"type": "product",
"valuesetId": 1234,
"group": "ATTRIBUTE_GROUP",
"isSearchable": true,
"isPublic": true,
"isSystem": false,
"isHidden": false,
"createdAt": "2022-01-01T00:00:00.000Z",
"lastModifiedAt": "2022-01-02T00:00:00.000Z",
"createdBy": 1234,
"lastModifiedBy": 1234,
"defaultValue": {}
}
Bad request
Unauthorized
- application/json
- Schema
- invalid_client_id
- invalid_client_cred
Schema
any
{
"ErrorCode": "invalid_client",
"Error": "ClientId is Invalid"
}
{
"ErrorCode": "invalid_client",
"Error": "Client credentials are invalid"
}
Attribute Description already exists
Unknown create Attribute Description error