Create Attribute Description

POST 
/v2/attribute-descriptions

Creates a new Attribute Description

Request

application/json

Body

required

The Attribute Description to create

name stringrequired

Descriptive identifier (Screaming Snake Case)

descriptions

object[]

required

Attribute descriptions per language

Array [

language stringrequired

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

Localized field language code

value stringnullablerequired

Localized field value

]

units

object[]

Attribute unit per language

Array [

language stringrequired

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

Localized field language code

value stringnullablerequired

Localized field value

]

type stringrequired

Possible values: [text, enum, color, datetime, integer, decimal]

Attribute type. One of: [text, enum, color, datetime, integer, decimal]

attributeClass stringrequired

Possible values: [product, category, cluster, customer, contact, company]

Attribute class. One of: [product, category, cluster, customer, contact, company]

valuesetId integer

Unique identifier for the connected valueset

group string

Possible values: <= 64 characters

The attribute group

isSearchable boolean

Default value: true

Flags whether this attribute should be used when generating catalog page filters

isPublic boolean

Default value: true

Flags whether this attribute should be used when generating product specifications.

isSystem boolean

Flags whether this attribute is only available to system users

isHidden boolean

Flags whether this attribute is hidden and should only be used for background operations.

defaultValue

object

required

textValues

object[]

Attribute value descriptions per language, required for TEXT type attributes

Array [

language stringrequired

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

Language is set as 2 character country code.

values array[]

List of localized string values

]

enumValues string[]

Attribute enum values, required for ENUM type attributes

intValue integer

Attribute integer value, required for INTEGER type attributes

decimalValue number

Attribute decimal value, required for DECIMAL type attributes

dateTimeValue date-timenullable

Attribute datetime value, required for DATETIME type attributes

colorValue string

Attribute color value, required for COLOR type attributes

Responses

201

The created Attribute description

application/json

Schema

Schema

id uuidrequired

Attribute description primary identifier

name stringrequired

Descriptive identifier for this AttributeDescription

descriptions

object[]

required

The human readable description of the attribute's name. This is a language specific value.

Array [

language stringrequired

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

Language is set as 2 character country code.

value string

Localized field value

]

units

object[]

nullable

required

Attribute unit per language

Array [

language stringrequired

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

Language is set as 2 character country code.

value string

Localized field value

]

attributeClass stringrequired

Possible values: [text, enum, color, datetime, integer, decimal]

The class for this attribute. One of: [product, category, cluster, customer, contact, company]

type stringrequired

Possible values: [product, category, cluster, customer, contact, company]

Attribute class. One of: [product, category, cluster, customer, contact, company]

valuesetId integer

The ID of the connected valueset to use when type is ENUM

group string

The group this attribute belongs to, generally linked to a valueset.

isSearchable booleanrequired

Flags whether this attribute should be used when generating catalog page filters

isPublic booleanrequired

Default value: true

Flags whether this attribute should be used when generating product specifications.

isSystem booleanrequired

Flags whether this attribute is only available to system users

isHidden booleanrequired

Flags whether this attribute is hidden and should only be used for background operations.

createdAt date-timerequired

Attribute description creation date

lastModifiedAt date-timerequired

Attribute description last modified date

createdBy integernullablerequired

The userId of the user that created the attribute description

lastModifiedBy integernullablerequired

The userId of the user that last modified the attribute description

defaultValue

object

required

The default value for this attribute

oneOf

AttributeTextValue

id uuidrequired

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

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

textValues

object[]

required

Attribute textValues per language

Array [

language stringrequired

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

Language is set as 2 character country code.

values array[]

List of localized string values

]

AttributeEnumValue

id uuidrequired

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

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

enumValues string[]required

Attribute enum values

AttributeIntValue

id uuidrequired

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

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

intValue integerrequired

Attribute integer value

AttributeDecimalValue

id uuidrequired

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

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

id uuidrequired

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

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

id uuidrequired

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

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

dateTimeValue date-timenullablerequired

Attribute decimal value

Example (from schema)

{
  "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": {}
}

400

Bad request

401

Unauthorized

application/json

Schema

Schema

any

invalid_client_id

{
  "ErrorCode": "invalid_client",
  "Error": "ClientId is Invalid"
}

invalid_client_cred

{
  "ErrorCode": "invalid_client",
  "Error": "Client credentials are invalid"
}

409

Attribute Description already exists

500

Unknown create Attribute Description error

Loading...