Skip to main content

Bulk Attribute Descriptions

POST 
/v2/attribute-descriptions/bulk/name

Creates and/or updates Attribute Descriptions in bulk by name

Request​

Body

array

required

The Attribute Descriptions to create or update

  • Array [

    • 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​

A list of operations performed on the Attribute Descriptions

Schema

  • Array [

    • id stringnullablerequired

    ID of the created or updated attribute description

    name stringrequired

    Name of the created or updated attribute description

    message stringnullablerequired

    Success or error message

    action stringrequired

    Possible values: [update, create, ignored, delete]

    Action performed on the attribute description

    success booleanrequired

    Whether the action was successful or not

  • ]

Loading...