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 [

    • 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

  • ]

    • group string

    Possible values: <= 64 characters

    The attribute group

    isSearchable boolean

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

    isPublic boolean

    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

    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​

Bad request

Loading...