#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 /attributes Get all attributes in the system

Response status OK (200)

array : Attribute
Attribute
This model is an abstract type and can attain any of the below concrete models. The AttributeType property is used to define the actual model type
AttributeReferenceAttribute
Attribute used to create references to other attributes in the system
Property name Data type Description
AllowMultipleValues boolean

Indicates whether users can select more than one attribute

AllowedAttributeScopes array

Attribute scopes from which attributes can be selected

AllowedAttributeTypes array

The attribute types that is allowed to be referenced

UnfoldComplexTypes boolean

Indicates whether user can select sub attributes of complex attributes

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

BooleanAttribute
Checkbox attribute that can only obtain true of false values
Property name Data type Description
Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CategoryReferenceAttribute
Attribute used to create references to categories in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple categories can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CollectionReferenceAttribute
Attribute used to create references to collections in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple collections can be selected

AllowProductCollectionSelection boolean

Allow selection of product collections

AllowVariantCollectionSelection boolean

Allow selection of variant collections

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ComplexAttribute
Attribute used to wrap one or more sub attributes
Property name Data type Description
SubAttributes array : Attribute

Sub attributes wrapped in this complex attribute

RenderValuesForAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute

RenderValuesForBackofficeAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute to show in the backoffice

DefaultListViewAttributeFieldUids array

Uid paths of sub attributes to show by default in the list view interface of the backoffice

RenderedValueSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute

RenderedValueInBackofficeSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute to show in the backoffice

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

DateTimeAttribute
Attribute used to hold date time values
Property name Data type Description
ShowTime boolean

Indicate whether it is possible to select a time of day. If false, only a date can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

FixedListAttribute
Attribute used to create references to global list values
Property name Data type Description
GlobalListId integer

Id of global list to select values from

AllowMultipleValues boolean

Indicates whether multiple global list values can be selected

EnableTableView boolean

Show selected global list values in a table instead of default select input field

ReferencedAttribute object : Attribute

The definition of the attribute defining the referenced global list (Readonly)

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ListAttribute
Attribute used to hold a number of rows each with its own data defined by an attribute template
Property name Data type Description
Template object : Attribute

Attribute template for each row. Each row in the list will hold a data model defined by the attribute template

EnableTableView boolean

When enabled, rows are shown in searchable table instead of individual inline rows

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

MediaAttribute
Attribute used to hold references to media items
Property name Data type Description
AllowMultiselect boolean

Indicate whether multiple medias can be selected

AllowedSelectionTypes array

The media types that can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

NumberAttribute
Attribute used to hold a number value
Property name Data type Description
NumberOfDecimals integer

Max number of decimals to use for this number

Unit string

Fixed unit for all values of this attribute

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ProductReferenceAttribute
Attribute used to create references to products in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple products can be selected

LimitToProductStructures array

The product structures from which products can be selected. Leave empty to allow selection of products from all product structures

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

TextAttribute
Attribute used to hold text value
Property name Data type Description
UseMultiRowInput boolean

Show input as a text area instead of a single line input

InputHeight integer

The height of the text area in pixels, if UseMultiRowInput is set

UseRichText boolean

Use Rich Text Editor if UseMultiRowInput is set

RichTextToolbarOptions array

Available toolbar options on Rich Text Editor, if UseRichText is set. Available options are: coderemoveformatundoredocutcopystyleselectbolditalicunderlinestrikethroughalignleftalignrightalignjustifybullistnumlistoutdentindentlinkunlinkanchortablehrsupscriptsuperscriptcharmap

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Unit string

Fixed unit for value

ShowCharacterCount boolean

Show number of characters currently used

MaxLength integer

Max character length of attribute value

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

VariantReferenceAttribute
Variant reference attribute used to reference variants in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple variants can be selected

OnlyChildren boolean

When set, only variants of the product, to which this attribute is added, can be selected

LimitToProductStructures array

The product structures from which variants can be selected. Leave empty to allow selection of variants from all product structures Note: Will not be applied if OnlyChildren is true

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute


PUT /attributes Update an attribute

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
attribute body object : Attribute

Attribute to update (uid is used to match existing attribute)

Attribute
This model is an abstract type and can attain any of the below concrete models. The AttributeType property is used to define the actual model type
AttributeReferenceAttribute
Attribute used to create references to other attributes in the system
Property name Data type Description
AllowMultipleValues boolean

Indicates whether users can select more than one attribute

AllowedAttributeScopes array

Attribute scopes from which attributes can be selected

AllowedAttributeTypes array

The attribute types that is allowed to be referenced

UnfoldComplexTypes boolean

Indicates whether user can select sub attributes of complex attributes

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

BooleanAttribute
Checkbox attribute that can only obtain true of false values
Property name Data type Description
Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CategoryReferenceAttribute
Attribute used to create references to categories in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple categories can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CollectionReferenceAttribute
Attribute used to create references to collections in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple collections can be selected

AllowProductCollectionSelection boolean

Allow selection of product collections

AllowVariantCollectionSelection boolean

Allow selection of variant collections

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ComplexAttribute
Attribute used to wrap one or more sub attributes
Property name Data type Description
SubAttributes array : Attribute

Sub attributes wrapped in this complex attribute

RenderValuesForAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute

RenderValuesForBackofficeAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute to show in the backoffice

DefaultListViewAttributeFieldUids array

Uid paths of sub attributes to show by default in the list view interface of the backoffice

RenderedValueSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute

RenderedValueInBackofficeSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute to show in the backoffice

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

DateTimeAttribute
Attribute used to hold date time values
Property name Data type Description
ShowTime boolean

Indicate whether it is possible to select a time of day. If false, only a date can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

FixedListAttribute
Attribute used to create references to global list values
Property name Data type Description
GlobalListId integer

Id of global list to select values from

AllowMultipleValues boolean

Indicates whether multiple global list values can be selected

EnableTableView boolean

Show selected global list values in a table instead of default select input field

ReferencedAttribute object : Attribute

The definition of the attribute defining the referenced global list (Readonly)

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ListAttribute
Attribute used to hold a number of rows each with its own data defined by an attribute template
Property name Data type Description
Template object : Attribute

Attribute template for each row. Each row in the list will hold a data model defined by the attribute template

EnableTableView boolean

When enabled, rows are shown in searchable table instead of individual inline rows

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

MediaAttribute
Attribute used to hold references to media items
Property name Data type Description
AllowMultiselect boolean

Indicate whether multiple medias can be selected

AllowedSelectionTypes array

The media types that can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

NumberAttribute
Attribute used to hold a number value
Property name Data type Description
NumberOfDecimals integer

Max number of decimals to use for this number

Unit string

Fixed unit for all values of this attribute

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ProductReferenceAttribute
Attribute used to create references to products in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple products can be selected

LimitToProductStructures array

The product structures from which products can be selected. Leave empty to allow selection of products from all product structures

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

TextAttribute
Attribute used to hold text value
Property name Data type Description
UseMultiRowInput boolean

Show input as a text area instead of a single line input

InputHeight integer

The height of the text area in pixels, if UseMultiRowInput is set

UseRichText boolean

Use Rich Text Editor if UseMultiRowInput is set

RichTextToolbarOptions array

Available toolbar options on Rich Text Editor, if UseRichText is set. Available options are: coderemoveformatundoredocutcopystyleselectbolditalicunderlinestrikethroughalignleftalignrightalignjustifybullistnumlistoutdentindentlinkunlinkanchortablehrsupscriptsuperscriptcharmap

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Unit string

Fixed unit for value

ShowCharacterCount boolean

Show number of characters currently used

MaxLength integer

Max character length of attribute value

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

VariantReferenceAttribute
Variant reference attribute used to reference variants in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple variants can be selected

OnlyChildren boolean

When set, only variants of the product, to which this attribute is added, can be selected

LimitToProductStructures array

The product structures from which variants can be selected. Leave empty to allow selection of variants from all product structures Note: Will not be applied if OnlyChildren is true

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

Response status OK (200)

No body message is returned

POST /attributes Create an attribute

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
attribute body object : Attribute

Attribute to create

Attribute
This model is an abstract type and can attain any of the below concrete models. The AttributeType property is used to define the actual model type
AttributeReferenceAttribute
Attribute used to create references to other attributes in the system
Property name Data type Description
AllowMultipleValues boolean

Indicates whether users can select more than one attribute

AllowedAttributeScopes array

Attribute scopes from which attributes can be selected

AllowedAttributeTypes array

The attribute types that is allowed to be referenced

UnfoldComplexTypes boolean

Indicates whether user can select sub attributes of complex attributes

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

BooleanAttribute
Checkbox attribute that can only obtain true of false values
Property name Data type Description
Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CategoryReferenceAttribute
Attribute used to create references to categories in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple categories can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CollectionReferenceAttribute
Attribute used to create references to collections in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple collections can be selected

AllowProductCollectionSelection boolean

Allow selection of product collections

AllowVariantCollectionSelection boolean

Allow selection of variant collections

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ComplexAttribute
Attribute used to wrap one or more sub attributes
Property name Data type Description
SubAttributes array : Attribute

Sub attributes wrapped in this complex attribute

RenderValuesForAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute

RenderValuesForBackofficeAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute to show in the backoffice

DefaultListViewAttributeFieldUids array

Uid paths of sub attributes to show by default in the list view interface of the backoffice

RenderedValueSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute

RenderedValueInBackofficeSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute to show in the backoffice

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

DateTimeAttribute
Attribute used to hold date time values
Property name Data type Description
ShowTime boolean

Indicate whether it is possible to select a time of day. If false, only a date can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

FixedListAttribute
Attribute used to create references to global list values
Property name Data type Description
GlobalListId integer

Id of global list to select values from

AllowMultipleValues boolean

Indicates whether multiple global list values can be selected

EnableTableView boolean

Show selected global list values in a table instead of default select input field

ReferencedAttribute object : Attribute

The definition of the attribute defining the referenced global list (Readonly)

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ListAttribute
Attribute used to hold a number of rows each with its own data defined by an attribute template
Property name Data type Description
Template object : Attribute

Attribute template for each row. Each row in the list will hold a data model defined by the attribute template

EnableTableView boolean

When enabled, rows are shown in searchable table instead of individual inline rows

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

MediaAttribute
Attribute used to hold references to media items
Property name Data type Description
AllowMultiselect boolean

Indicate whether multiple medias can be selected

AllowedSelectionTypes array

The media types that can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

NumberAttribute
Attribute used to hold a number value
Property name Data type Description
NumberOfDecimals integer

Max number of decimals to use for this number

Unit string

Fixed unit for all values of this attribute

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ProductReferenceAttribute
Attribute used to create references to products in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple products can be selected

LimitToProductStructures array

The product structures from which products can be selected. Leave empty to allow selection of products from all product structures

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

TextAttribute
Attribute used to hold text value
Property name Data type Description
UseMultiRowInput boolean

Show input as a text area instead of a single line input

InputHeight integer

The height of the text area in pixels, if UseMultiRowInput is set

UseRichText boolean

Use Rich Text Editor if UseMultiRowInput is set

RichTextToolbarOptions array

Available toolbar options on Rich Text Editor, if UseRichText is set. Available options are: coderemoveformatundoredocutcopystyleselectbolditalicunderlinestrikethroughalignleftalignrightalignjustifybullistnumlistoutdentindentlinkunlinkanchortablehrsupscriptsuperscriptcharmap

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Unit string

Fixed unit for value

ShowCharacterCount boolean

Show number of characters currently used

MaxLength integer

Max character length of attribute value

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

VariantReferenceAttribute
Variant reference attribute used to reference variants in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple variants can be selected

OnlyChildren boolean

When set, only variants of the product, to which this attribute is added, can be selected

LimitToProductStructures array

The product structures from which variants can be selected. Leave empty to allow selection of variants from all product structures Note: Will not be applied if OnlyChildren is true

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

Response status OK (200)

No body message is returned

DELETE /attributes Delete an attribute

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
uid query string

Unique id of attribute to delete

Response status OK (200)

No body message is returned

GET /attributes/{uid} Get a specific attribute

Request parameters

Property name Parameter type Data type Description
uid path string

Unique id of attribute to get

Response status OK (200)

object : Attribute
Attribute
This model is an abstract type and can attain any of the below concrete models. The AttributeType property is used to define the actual model type
AttributeReferenceAttribute
Attribute used to create references to other attributes in the system
Property name Data type Description
AllowMultipleValues boolean

Indicates whether users can select more than one attribute

AllowedAttributeScopes array

Attribute scopes from which attributes can be selected

AllowedAttributeTypes array

The attribute types that is allowed to be referenced

UnfoldComplexTypes boolean

Indicates whether user can select sub attributes of complex attributes

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

BooleanAttribute
Checkbox attribute that can only obtain true of false values
Property name Data type Description
Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CategoryReferenceAttribute
Attribute used to create references to categories in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple categories can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CollectionReferenceAttribute
Attribute used to create references to collections in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple collections can be selected

AllowProductCollectionSelection boolean

Allow selection of product collections

AllowVariantCollectionSelection boolean

Allow selection of variant collections

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ComplexAttribute
Attribute used to wrap one or more sub attributes
Property name Data type Description
SubAttributes array : Attribute

Sub attributes wrapped in this complex attribute

RenderValuesForAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute

RenderValuesForBackofficeAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute to show in the backoffice

DefaultListViewAttributeFieldUids array

Uid paths of sub attributes to show by default in the list view interface of the backoffice

RenderedValueSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute

RenderedValueInBackofficeSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute to show in the backoffice

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

DateTimeAttribute
Attribute used to hold date time values
Property name Data type Description
ShowTime boolean

Indicate whether it is possible to select a time of day. If false, only a date can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

FixedListAttribute
Attribute used to create references to global list values
Property name Data type Description
GlobalListId integer

Id of global list to select values from

AllowMultipleValues boolean

Indicates whether multiple global list values can be selected

EnableTableView boolean

Show selected global list values in a table instead of default select input field

ReferencedAttribute object : Attribute

The definition of the attribute defining the referenced global list (Readonly)

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ListAttribute
Attribute used to hold a number of rows each with its own data defined by an attribute template
Property name Data type Description
Template object : Attribute

Attribute template for each row. Each row in the list will hold a data model defined by the attribute template

EnableTableView boolean

When enabled, rows are shown in searchable table instead of individual inline rows

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

MediaAttribute
Attribute used to hold references to media items
Property name Data type Description
AllowMultiselect boolean

Indicate whether multiple medias can be selected

AllowedSelectionTypes array

The media types that can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

NumberAttribute
Attribute used to hold a number value
Property name Data type Description
NumberOfDecimals integer

Max number of decimals to use for this number

Unit string

Fixed unit for all values of this attribute

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ProductReferenceAttribute
Attribute used to create references to products in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple products can be selected

LimitToProductStructures array

The product structures from which products can be selected. Leave empty to allow selection of products from all product structures

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

TextAttribute
Attribute used to hold text value
Property name Data type Description
UseMultiRowInput boolean

Show input as a text area instead of a single line input

InputHeight integer

The height of the text area in pixels, if UseMultiRowInput is set

UseRichText boolean

Use Rich Text Editor if UseMultiRowInput is set

RichTextToolbarOptions array

Available toolbar options on Rich Text Editor, if UseRichText is set. Available options are: coderemoveformatundoredocutcopystyleselectbolditalicunderlinestrikethroughalignleftalignrightalignjustifybullistnumlistoutdentindentlinkunlinkanchortablehrsupscriptsuperscriptcharmap

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Unit string

Fixed unit for value

ShowCharacterCount boolean

Show number of characters currently used

MaxLength integer

Max character length of attribute value

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

VariantReferenceAttribute
Variant reference attribute used to reference variants in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple variants can be selected

OnlyChildren boolean

When set, only variants of the product, to which this attribute is added, can be selected

LimitToProductStructures array

The product structures from which variants can be selected. Leave empty to allow selection of variants from all product structures Note: Will not be applied if OnlyChildren is true

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute


GET /attributes/{uid}/references Get references to a attribute from other attributes

#Available from v.3.5.0

Request parameters

Property name Parameter type Data type Description
uid path string

Uid of attribute

Response status OK (200)

object : AttributeReferences
AttributeReferences
Property name Data type Description
AttributeUid string

Id of the referenced attribute

ReferencingCategories array

List of categories referencing this attribute for product attribute templating

ReferencesOnCategoryAttributes array : EntityReferenceDetail

List of categories referencing this attribute from another attribute

ReferencesOnProductAttributes array : EntityReferenceDetail

List of products referencing this attribute from another attribute

ReferencesOnVariantAttributes array : EntityReferenceDetail

List of variants referencing this attribute from another attribute

ReferencingGlobalListValues array

List of global list values referencing this attribute

ReferencingProductStructures array

List of product structures referencing this attribute

ReferencingVariationDefinitions array

List of variation definitions referencing this attribute

EntityReferenceDetail
Property name Data type Description
EntityId integer

The id of the referencing entity

AttributeUid string

The attribute on the referencing entity that holds the reference


POST /attributes/batch Get a batch of attributes

Request parameters

Property name Parameter type Data type Description
uids body array : string

Uids of attributes to get

Response status OK (200)

array : Attribute
Attribute
This model is an abstract type and can attain any of the below concrete models. The AttributeType property is used to define the actual model type
AttributeReferenceAttribute
Attribute used to create references to other attributes in the system
Property name Data type Description
AllowMultipleValues boolean

Indicates whether users can select more than one attribute

AllowedAttributeScopes array

Attribute scopes from which attributes can be selected

AllowedAttributeTypes array

The attribute types that is allowed to be referenced

UnfoldComplexTypes boolean

Indicates whether user can select sub attributes of complex attributes

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

BooleanAttribute
Checkbox attribute that can only obtain true of false values
Property name Data type Description
Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CategoryReferenceAttribute
Attribute used to create references to categories in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple categories can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

CollectionReferenceAttribute
Attribute used to create references to collections in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple collections can be selected

AllowProductCollectionSelection boolean

Allow selection of product collections

AllowVariantCollectionSelection boolean

Allow selection of variant collections

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ComplexAttribute
Attribute used to wrap one or more sub attributes
Property name Data type Description
SubAttributes array : Attribute

Sub attributes wrapped in this complex attribute

RenderValuesForAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute

RenderValuesForBackofficeAttributeFieldUids array

Uids of sub attributes to use when rendering an aggregate value for this complex attribute to show in the backoffice

DefaultListViewAttributeFieldUids array

Uid paths of sub attributes to show by default in the list view interface of the backoffice

RenderedValueSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute

RenderedValueInBackofficeSeparator string

Separator to use between sub attribute values when rendering an aggregate value for this complex attribute to show in the backoffice

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

DateTimeAttribute
Attribute used to hold date time values
Property name Data type Description
ShowTime boolean

Indicate whether it is possible to select a time of day. If false, only a date can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

FixedListAttribute
Attribute used to create references to global list values
Property name Data type Description
GlobalListId integer

Id of global list to select values from

AllowMultipleValues boolean

Indicates whether multiple global list values can be selected

EnableTableView boolean

Show selected global list values in a table instead of default select input field

ReferencedAttribute object : Attribute

The definition of the attribute defining the referenced global list (Readonly)

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ListAttribute
Attribute used to hold a number of rows each with its own data defined by an attribute template
Property name Data type Description
Template object : Attribute

Attribute template for each row. Each row in the list will hold a data model defined by the attribute template

EnableTableView boolean

When enabled, rows are shown in searchable table instead of individual inline rows

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

MediaAttribute
Attribute used to hold references to media items
Property name Data type Description
AllowMultiselect boolean

Indicate whether multiple medias can be selected

AllowedSelectionTypes array

The media types that can be selected

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

NumberAttribute
Attribute used to hold a number value
Property name Data type Description
NumberOfDecimals integer

Max number of decimals to use for this number

Unit string

Fixed unit for all values of this attribute

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

ProductReferenceAttribute
Attribute used to create references to products in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple products can be selected

LimitToProductStructures array

The product structures from which products can be selected. Leave empty to allow selection of products from all product structures

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

TextAttribute
Attribute used to hold text value
Property name Data type Description
UseMultiRowInput boolean

Show input as a text area instead of a single line input

InputHeight integer

The height of the text area in pixels, if UseMultiRowInput is set

UseRichText boolean

Use Rich Text Editor if UseMultiRowInput is set

RichTextToolbarOptions array

Available toolbar options on Rich Text Editor, if UseRichText is set. Available options are: coderemoveformatundoredocutcopystyleselectbolditalicunderlinestrikethroughalignleftalignrightalignjustifybullistnumlistoutdentindentlinkunlinkanchortablehrsupscriptsuperscriptcharmap

RegEx string

RegEx validation to run when users enters data for this attribute

RegExDescription string

Error message to show to users when RegEx does not match

Unit string

Fixed unit for value

ShowCharacterCount boolean

Show number of characters currently used

MaxLength integer

Max character length of attribute value

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute

VariantReferenceAttribute
Variant reference attribute used to reference variants in the system
Property name Data type Description
AllowMultiple boolean

Indicates whether multiple variants can be selected

OnlyChildren boolean

When set, only variants of the product, to which this attribute is added, can be selected

LimitToProductStructures array

The product structures from which variants can be selected. Leave empty to allow selection of variants from all product structures Note: Will not be applied if OnlyChildren is true

Uid string

Unique id of attribute

Alias string

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)

BackofficeName string

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescription string

The description of the attribute displayed to the editor in the PIM backoffice

Name object

The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)

Description object

The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)

AttributeGroupId integer

The id of the attribute group this attribute is placed within

AttributeScope string

Unique id of the attribute scope this attribute is placed within

Localized boolean

Indicates whether values of this attribute are localized

FallbackLanguage integer

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUid string

Unique id of Dimension to segment values of this attribute on

FallbackSegment string

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnly boolean

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Mandatory boolean

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Unchangeable boolean

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.

AttributeType string

Type of attribute

DisableRevisionLogging boolean

Disable all revision logging for this attribute


POST /attributes/batch/references Get references from other attributes to a batch of attributes

#Available from v.3.5.0 No more than 5000 values can be requested at a time.

Request parameters

Property name Parameter type Data type Description
uids body array : string

Uids of attributes

Response status OK (200)

array : AttributeReferences
AttributeReferences
Property name Data type Description
AttributeUid string

Id of the referenced attribute

ReferencingCategories array

List of categories referencing this attribute for product attribute templating

ReferencesOnCategoryAttributes array : EntityReferenceDetail

List of categories referencing this attribute from another attribute

ReferencesOnProductAttributes array : EntityReferenceDetail

List of products referencing this attribute from another attribute

ReferencesOnVariantAttributes array : EntityReferenceDetail

List of variants referencing this attribute from another attribute

ReferencingGlobalListValues array

List of global list values referencing this attribute

ReferencingProductStructures array

List of product structures referencing this attribute

ReferencingVariationDefinitions array

List of variation definitions referencing this attribute

EntityReferenceDetail
Property name Data type Description
EntityId integer

The id of the referencing entity

AttributeUid string

The attribute on the referencing entity that holds the reference