List Attribute Descriptions
GET/v2/attribute-descriptions
Lists all Attribute Descriptions, optionally by attributeClass
Request
Query Parameters
Possible values: [product
, category
, cluster
, customer
, contact
, company
]
The attributeClass to get the attribute for. Required when lookupKey is 'name'
Pagination page number
Pagination offset number
Responses
- 200
- 401
A list of Attribute Descriptions
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
- AttributeTextValue
- AttributeEnumValue
- AttributeIntValue
- AttributeDecimalValue
- AttributeColorValue
- AttributeDateTimeValue
Array [
]
Attribute description primary identifier
e1de4af7-7301-44bc-a2d7-02342310ea34
Descriptive identifier for this AttributeDescription
ATTRIBUTE_NAME
descriptions
object[]
required
The human readable description of the attribute's name. This is a language specific value.
Language is set as 2 character country code.
Possible values: >= 2 characters
and <= 2 characters
EN
Localized field value
example value
units
object[]
nullable
required
Attribute unit per language
Language is set as 2 character country code.
Possible values: >= 2 characters
and <= 2 characters
EN
Localized field value
example value
The class for this attribute. One of: [product, category, cluster, customer, contact, company]
Possible values: [text
, enum
, color
, datetime
, integer
, decimal
]
Attribute class. One of: [product, category, cluster, customer, contact, company]
Possible values: [product
, category
, cluster
, customer
, contact
, company
]
The ID of the connected valueset to use when type is ENUM
1234
The group this attribute belongs to, generally linked to a valueset.
ATTRIBUTE_GROUP
Flags whether this attribute should be used when generating catalog page filters
false
true
Flags whether this attribute should be used when generating product specifications.
true
true
Flags whether this attribute is only available to system users
false
false
Flags whether this attribute is hidden and should only be used for background operations.
false
false
Attribute description creation date
2022-01-01T00:00:00.000Z
Attribute description last modified date
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute description
1234
The userId of the user that last modified the attribute description
1234
defaultValue
object
required
The default value for this attribute
oneOf
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
textValues
object[]
required
Attribute textValues per language
Language is set as 2 character country code.
Possible values: >= 2 characters
and <= 2 characters
EN
List of localized string values
["Hello","World"]
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute enum values
["VALUE_1","VALUE_2"]
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute integer value
1234
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute decimal value
1234.5678
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute color value, stored as a hex string
#FFFFFF
Unique identifier of the attribute value
Possible values: >= 36 characters
and <= 36 characters
e1de4af7-7301-44bc-a2d7-02342310ea34
Attribute value creation date
CURRENT_TIMESTAMP
2022-01-01T00:00:00.000Z
Attribute value last modified date
CURRENT_TIMESTAMP
2022-01-02T00:00:00.000Z
The userId of the user that created the attribute value
1234
The userId of the user that last modified the attribute description
1234
Attribute decimal value
2020-01-01T00:00:00.000Z
{
"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": {}
}
Unauthorized
- application/json
- Schema
- invalid_client_id
- invalid_client_cred
Schema
any
{
"ErrorCode": "invalid_client",
"Error": "ClientId is Invalid"
}
{
"ErrorCode": "invalid_client",
"Error": "Client credentials are invalid"
}