Attributes
Attributes are the central element in the system. They describe the data fields available on entities such as products, variants, categories and global list values. A range of attribute types exist to allow for flexible modelling of your data structure.
GET /v1/attributes HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
[
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
}
]
Represents an attribute in Struct PIM which can be attached to product, variant or category data models
Unique id of attribute
Unique alias of attribute. Max length is 50 characters and can only consist of letters a-z/A-Z and numbers 0-9 (but cannot start with a number)
The name of the attribute displayed to the editor in the PIM backoffice
The description of the attribute displayed to the editor in the PIM backoffice
The id of the attribute group this attribute is placed within
Unique ids of the attribute scopes this attribute is placed within
Indicates whether values of this attribute are localized
Indicates a fallback language in case attribute is localized and no value is added to a specific language
Unique id of Dimension to segment values of this attribute on
Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension
Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
The number of columns this attribute should span in the PIM backoffice (1-12)
Indicates whether this attribute cannot change its value, once it has a value assigned. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
Type of attribute
Disable all revision logging for this attribute
Disable indexing for this attribute
POST /v1/attributes HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 592
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"DisableRevisionLogging": true,
"DisableIndexing": true
}
No content
Represents an attribute in Struct PIM which can be attached to product, variant or category data models
Unique id of attribute
Unique alias of attribute. Max length is 50 characters and can only consist of letters a-z/A-Z and numbers 0-9 (but cannot start with a number)
The name of the attribute displayed to the editor in the PIM backoffice
The description of the attribute displayed to the editor in the PIM backoffice
The id of the attribute group this attribute is placed within
Unique ids of the attribute scopes this attribute is placed within
Indicates whether values of this attribute are localized
Indicates a fallback language in case attribute is localized and no value is added to a specific language
Unique id of Dimension to segment values of this attribute on
Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension
Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
The number of columns this attribute should span in the PIM backoffice (1-12)
Indicates whether this attribute cannot change its value, once it has a value assigned. NOTE: Only applied when attribute is a sub attribute of a complex attribute.
Type of attribute
Disable all revision logging for this attribute
Disable indexing for this attribute
PUT /v1/attributes HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 592
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"DisableRevisionLogging": true,
"DisableIndexing": true
}
No content
Unique id of attribute to get
GET /v1/attributes/{uid} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
}
POST /v1/attributes/batch HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 40
[
"123e4567-e89b-12d3-a456-426614174000"
]
[
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
}
]
#Available from v.3.5.0
Uid of attribute
GET /v1/attributes/{uid}/references HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
{
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000",
"ReferencingCategories": [
1
],
"ReferencesOnCategoryAttributes": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencesOnProductAttributes": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencesOnVariantAttributes": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingGlobalListValues": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ReferencingProductStructures": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ReferencingVariationDefinitions": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
#Available from v.3.5.0 No more than 5000 values can be requested at a time.
POST /v1/attributes/batch/references HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 40
[
"123e4567-e89b-12d3-a456-426614174000"
]
OK
[
{
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000",
"ReferencingCategories": [
1
],
"ReferencesOnCategoryAttributes": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencesOnProductAttributes": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencesOnVariantAttributes": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingGlobalListValues": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ReferencingProductStructures": [
"123e4567-e89b-12d3-a456-426614174000"
],
"ReferencingVariationDefinitions": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
]