Skip to main content

List Attribute Descriptions

GET 

/v2/attribute-descriptions

Lists all Attribute Descriptions, optionally by attributeClass

Request

Query Parameters

    attributeClass string

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

    The attributeClass to get the attribute for. Required when lookupKey is 'name'

    Example: product
    page any

    Pagination page number

    Example: 1
    offset any

    Pagination offset number

    Example: 12

Responses

A list of Attribute Descriptions

Schema

    iduuidrequired

    Attribute description primary identifier

    Example: e1de4af7-7301-44bc-a2d7-02342310ea34
    namestringrequired

    Descriptive identifier for this AttributeDescription

    Example: ATTRIBUTE_NAME

    descriptions

    object[]

    required

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

  • Array [

  • languagestringrequired

    Language is set as 2 character country code.

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

    Example: EN
    valuestring

    Localized field value

    Example: example value
  • ]

  • units

    object[]

    nullable

    required

    Attribute unit per language

  • Array [

  • languagestringrequired

    Language is set as 2 character country code.

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

    Example: EN
    valuestring

    Localized field value

    Example: example value
  • ]

  • attributeClassstringrequired

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

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

    typestringrequired

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

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

    valuesetIdinteger

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

    Example: 1234
    groupstring

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

    Example: ATTRIBUTE_GROUP
    isSearchablebooleanrequired

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

    Default value: false
    Example: true
    isPublicbooleanrequired

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

    Default value: true
    Example: true
    isSystembooleanrequired

    Flags whether this attribute is only available to system users

    Default value: false
    Example: false
    isHiddenbooleanrequired

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

    Default value: false
    Example: false
    createdAtdate-timerequired

    Attribute description creation date

    Example: 2022-01-01T00:00:00.000Z
    lastModifiedAtdate-timerequired

    Attribute description last modified date

    Example: 2022-01-02T00:00:00.000Z
    createdByintegernullablerequired

    The userId of the user that created the attribute description

    Example: 1234
    lastModifiedByintegernullablerequired

    The userId of the user that last modified the attribute description

    Example: 1234

    defaultValue

    object

    required

    The default value for this attribute

    oneOf

    iduuidrequired

    Unique identifier of the attribute value

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

    Example: e1de4af7-7301-44bc-a2d7-02342310ea34
    createdAtdate-time

    Attribute value creation date

    Default value: CURRENT_TIMESTAMP
    Example: 2022-01-01T00:00:00.000Z
    lastModifiedAtdate-time

    Attribute value last modified date

    Default value: CURRENT_TIMESTAMP
    Example: 2022-01-02T00:00:00.000Z
    createdByinteger

    The userId of the user that created the attribute value

    Example: 1234
    lastModifiedByinteger

    The userId of the user that last modified the attribute description

    Example: 1234

    textValues

    object[]

    required

    Attribute textValues per language

  • 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"]
  • ]