Skip to main content

Update Attribute Description

PATCH 
/v2/attribute-descriptions/:lookupKey/:lookupValue

Updates an Attribute Description by lookupKey and lookupValue

Request​

Path Parameters

    lookupKey stringrequired

    Possible values: [id, name]

    The lookupKey to find the Attribute Description by, either 'id' or 'name'

    Example: id
    lookupValue stringrequired

    The lookupValue to find the Attribute Description by, i.e. the id or the name

    Example: 1234

Query Parameters

    resourceType string

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

    The resourceType to get the Attribute Description for. Required when lookupKey is 'name'

    Example: product

Body

required

The Attribute Description to update

    descriptions

    object[]

    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

  • ]

    • groupstring

    The attribute group

    Possible values: <= 64 characters

    Example: group
    isSearchableboolean

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

    Example: true
    isPublicboolean

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

    Example: true
    isSystemboolean

    Flags whether this attribute is only available to system users

    Example: false
    isHiddenboolean

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

    Example: false

    defaultValue

    object

    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​

Bad request