# 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

[
  {
    "NumberOfDecimals": 2,
    "Unit": "kg",
    "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
    "Alias": "Weight",
    "BackofficeName": "Weight",
    "BackofficeDescription": "Add the net weight of the product",
    "Name": {
      "en-GB": "Weight",
      "da-DK": "Vægt"
    },
    "Description": {
      "en-GB": "Net weight of product",
      "da-DK": "Produktets nettovægt"
    },
    "AttributeGroupId": 1,
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [
      "94048b4a-172e-4f3a-9615-0e346ea605eb"
    ],
    "Localized": false,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "NumberAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  {
    "UseMultiRowInput": false,
    "UseRichText": false,
    "ShowCharacterCount": true,
    "MaxLength": 500,
    "EnableAIAssistant": false,
    "Uid": "7e978dcb-fb0a-44c0-a71c-a4bb785db979",
    "Alias": "ProductName",
    "BackofficeName": "Product name",
    "BackofficeDescription": "Add the name of the product",
    "Name": {
      "en-GB": "Weight",
      "da-DK": "Vægt"
    },
    "Description": {
      "en-GB": "Name of product",
      "da-DK": "Produktets navn"
    },
    "AttributeGroupId": 1,
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [
      "19e84b40-0380-4005-9611-25d54a07ed24"
    ],
    "Localized": true,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "TextAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  {
    "AllowMultiselect": false,
    "AllowedSelectionTypes": [
      "image"
    ],
    "Uid": "e1b8cb77-d709-4768-ae32-28165ba40494",
    "Alias": "PrimaryImage",
    "BackofficeName": "Primary image",
    "BackofficeDescription": "Select the primary image to display for the product",
    "Name": {
      "en-GB": "Image",
      "da-DK": "Billede"
    },
    "Description": {
      "en-GB": "Image of product",
      "da-DK": "Produktets billede"
    },
    "AttributeGroupId": 1,
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [
      "1ed76163-6627-4661-bc67-e5d5aecafecb"
    ],
    "Localized": true,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "MediaAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  }
]

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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
EnableAIAssistant	boolean	Enable the AI assisant on this attribute
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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing for this attribute

VariantGroupReferenceAttribute

Variant reference attribute used to reference variant groups in the system

Property name	Data type	Description
AllowMultiple	boolean	Indicates whether multiple variant groups can be selected
OnlyChildren	boolean	When set, only variant groups of the product, to which this attribute is added, can be selected
LimitToProductStructures	array	The product structures from which variant groups can be selected. Leave empty to allow selection of variant groups 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
LimitToVariationDefinitions	array	The variation definitions from which variants can be selected. Leave empty to allow selection of variants from all variation definitions 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing for this attribute

PUT /attributes Update an attribute

#Available from v.3.2.0

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
  "Alias": "Weight",
  "BackofficeName": "Weight",
  "BackofficeDescription": "Add the net weight of the product",
  "Name": {
    "en-GB": "Weight",
    "da-DK": "Vægt"
  },
  "Description": {
    "en-GB": "Net weight of product",
    "da-DK": "Produktets nettovægt"
  },
  "AttributeGroupId": 1,
  "AttributeScope": "00000000-0000-0000-0000-000000000000",
  "AttributeScopes": [
    "e488f789-faeb-432e-aafc-8432cec924db"
  ],
  "Localized": false,
  "ReadOnly": false,
  "Mandatory": false,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false
}

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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
EnableAIAssistant	boolean	Enable the AI assisant on this attribute
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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing for this attribute

VariantGroupReferenceAttribute

Variant reference attribute used to reference variant groups in the system

Property name	Data type	Description
AllowMultiple	boolean	Indicates whether multiple variant groups can be selected
OnlyChildren	boolean	When set, only variant groups of the product, to which this attribute is added, can be selected
LimitToProductStructures	array	The product structures from which variant groups can be selected. Leave empty to allow selection of variant groups 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
LimitToVariationDefinitions	array	The variation definitions from which variants can be selected. Leave empty to allow selection of variants from all variation definitions 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing for this attribute

Response status OK (200)

No body message is returned

POST /attributes Create an attribute

#Available from v.3.2.0

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
  "Alias": "Weight",
  "BackofficeName": "Weight",
  "BackofficeDescription": "Add the net weight of the product",
  "Name": {
    "en-GB": "Weight",
    "da-DK": "Vægt"
  },
  "Description": {
    "en-GB": "Net weight of product",
    "da-DK": "Produktets nettovægt"
  },
  "AttributeGroupId": 1,
  "AttributeScope": "00000000-0000-0000-0000-000000000000",
  "AttributeScopes": [
    "3e157b1e-2347-487a-ba4b-d4c69f51b11d"
  ],
  "Localized": false,
  "ReadOnly": false,
  "Mandatory": false,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false
}

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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
EnableAIAssistant	boolean	Enable the AI assisant on this attribute
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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing for this attribute

VariantGroupReferenceAttribute

Variant reference attribute used to reference variant groups in the system

Property name	Data type	Description
AllowMultiple	boolean	Indicates whether multiple variant groups can be selected
OnlyChildren	boolean	When set, only variant groups of the product, to which this attribute is added, can be selected
LimitToProductStructures	array	The product structures from which variant groups can be selected. Leave empty to allow selection of variant groups 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
LimitToVariationDefinitions	array	The variation definitions from which variants can be selected. Leave empty to allow selection of variants from all variation definitions 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
  "Alias": "Weight",
  "BackofficeName": "Weight",
  "BackofficeDescription": "Add the net weight of the product",
  "Name": {
    "en-GB": "Weight",
    "da-DK": "Vægt"
  },
  "Description": {
    "en-GB": "Net weight of product",
    "da-DK": "Produktets nettovægt"
  },
  "AttributeGroupId": 1,
  "AttributeScope": "00000000-0000-0000-0000-000000000000",
  "AttributeScopes": [
    "3619d0d1-615f-4083-9cd1-c40b2cd9d80d"
  ],
  "Localized": false,
  "ReadOnly": false,
  "Mandatory": false,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false
}

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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
EnableAIAssistant	boolean	Enable the AI assisant on this attribute
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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing for this attribute

VariantGroupReferenceAttribute

Variant reference attribute used to reference variant groups in the system

Property name	Data type	Description
AllowMultiple	boolean	Indicates whether multiple variant groups can be selected
OnlyChildren	boolean	When set, only variant groups of the product, to which this attribute is added, can be selected
LimitToProductStructures	array	The product structures from which variant groups can be selected. Leave empty to allow selection of variant groups 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
LimitToVariationDefinitions	array	The variation definitions from which variants can be selected. Leave empty to allow selection of variants from all variation definitions 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing for this attribute

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

#Available from v.3.5.0

{
  "AttributeUid": "8e3fdf5d-d2d0-405a-ade7-d1691abcd930",
  "ReferencingCategories": [
    10,
    22,
    31
  ],
  "ReferencesOnCategoryAttributes": [
    {
      "EntityId": 100,
      "AttributeUid": "1e39d50d-bbe9-4d89-bd8e-249bb89ea913"
    },
    {
      "EntityId": 101,
      "AttributeUid": "1e39d50d-bbe9-4d89-bd8e-249bb89ea913"
    }
  ],
  "ReferencesOnProductAttributes": [
    {
      "EntityId": 100010,
      "AttributeUid": "e99926cb-c78a-4b8f-a4ad-5025ceb08018"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "e99926cb-c78a-4b8f-a4ad-5025ceb08018"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "a7ec71b4-e879-4768-8a9b-0408b5d41293"
    }
  ],
  "ReferencesOnVariantAttributes": [
    {
      "EntityId": 100,
      "AttributeUid": "e99926cb-c78a-4b8f-a4ad-5025ceb08018"
    }
  ],
  "ReferencingGlobalListValues": [
    "5f992575-385d-44a1-b459-c13500c01ea4",
    "3f1a409d-38ee-4fb4-ade0-01f40a7ca38f"
  ],
  "ReferencingProductStructures": [
    "f892142c-3fdb-4efb-851a-95a5263be489"
  ],
  "ReferencingVariationDefinitions": [
    "08598e64-cf87-46f1-bcec-1121b4ce5e24",
    "498a292d-9f12-4c4e-a659-71fe862f5860"
  ]
}

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 example Response example

[
  "630d5c4d-770e-4095-a262-48637f18ad57",
  "7e978dcb-fb0a-44c0-a71c-a4bb785db979",
  "e1b8cb77-d709-4768-ae32-28165ba40494"
]

[
  {
    "NumberOfDecimals": 2,
    "Unit": "kg",
    "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
    "Alias": "Weight",
    "BackofficeName": "Weight",
    "BackofficeDescription": "Add the net weight of the product",
    "Name": {
      "en-GB": "Weight",
      "da-DK": "Vægt"
    },
    "Description": {
      "en-GB": "Net weight of product",
      "da-DK": "Produktets nettovægt"
    },
    "AttributeGroupId": 1,
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [
      "b1903182-ca7d-447e-9103-87c0f306c41b"
    ],
    "Localized": false,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "NumberAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  {
    "UseMultiRowInput": false,
    "UseRichText": false,
    "ShowCharacterCount": true,
    "MaxLength": 500,
    "EnableAIAssistant": false,
    "Uid": "7e978dcb-fb0a-44c0-a71c-a4bb785db979",
    "Alias": "ProductName",
    "BackofficeName": "Product name",
    "BackofficeDescription": "Add the name of the product",
    "Name": {
      "en-GB": "Weight",
      "da-DK": "Vægt"
    },
    "Description": {
      "en-GB": "Name of product",
      "da-DK": "Produktets navn"
    },
    "AttributeGroupId": 1,
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [
      "2c44b0bf-dadf-4d1a-a899-b49566d0d52b"
    ],
    "Localized": true,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "TextAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  {
    "AllowMultiselect": false,
    "AllowedSelectionTypes": [
      "image"
    ],
    "Uid": "e1b8cb77-d709-4768-ae32-28165ba40494",
    "Alias": "PrimaryImage",
    "BackofficeName": "Primary image",
    "BackofficeDescription": "Select the primary image to display for the product",
    "Name": {
      "en-GB": "Image",
      "da-DK": "Billede"
    },
    "Description": {
      "en-GB": "Image of product",
      "da-DK": "Produktets billede"
    },
    "AttributeGroupId": 1,
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [
      "2144de92-0e3f-41c8-8e00-ff3af32ef170"
    ],
    "Localized": true,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "MediaAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  }
]

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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
EnableAIAssistant	boolean	Enable the AI assisant on this attribute
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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing for this attribute

VariantGroupReferenceAttribute

Variant reference attribute used to reference variant groups in the system

Property name	Data type	Description
AllowMultiple	boolean	Indicates whether multiple variant groups can be selected
OnlyChildren	boolean	When set, only variant groups of the product, to which this attribute is added, can be selected
LimitToProductStructures	array	The product structures from which variant groups can be selected. Leave empty to allow selection of variant groups 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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
LimitToVariationDefinitions	array	The variation definitions from which variants can be selected. Leave empty to allow selection of variants from all variation definitions 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
AttributeScopes	array	Unique ids of the attribute scopes 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
DisableIndexing	boolean	Disable indexing 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.

[
  {
    "AttributeUid": "90ee9dea-af86-4781-81cc-2ba870f8d04b",
    "ReferencingCategories": [
      10,
      22,
      31
    ],
    "ReferencesOnCategoryAttributes": [
      {
        "EntityId": 100,
        "AttributeUid": "6826e13d-6150-438f-91c1-a6454402262c"
      },
      {
        "EntityId": 101,
        "AttributeUid": "6826e13d-6150-438f-91c1-a6454402262c"
      }
    ],
    "ReferencesOnProductAttributes": [
      {
        "EntityId": 100010,
        "AttributeUid": "f5267c3a-e247-4910-bae0-67d869b7afd3"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "f5267c3a-e247-4910-bae0-67d869b7afd3"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "cb24c558-d099-466c-91a3-0f9adeea54df"
      }
    ],
    "ReferencesOnVariantAttributes": [
      {
        "EntityId": 100,
        "AttributeUid": "f5267c3a-e247-4910-bae0-67d869b7afd3"
      }
    ],
    "ReferencingGlobalListValues": [
      "86553acf-53ed-46c5-b7f6-626196689883",
      "9c9ef304-1c0c-47a9-b577-ff1b91dc41d7"
    ],
    "ReferencingProductStructures": [
      "c806213b-edbe-4508-b003-901a62d1381b"
    ],
    "ReferencingVariationDefinitions": [
      "77f1000e-f4ab-4cdd-b982-33149c2e9056",
      "7172d0f6-f864-4daa-87e2-bdb12cee3286"
    ]
  },
  {
    "AttributeUid": "fb68dceb-a01c-4f44-85c2-d8a04b997470",
    "ReferencingCategories": [
      10,
      31
    ],
    "ReferencesOnCategoryAttributes": [
      {
        "EntityId": 256,
        "AttributeUid": "6826e13d-6150-438f-91c1-a6454402262c"
      }
    ],
    "ReferencesOnProductAttributes": [
      {
        "EntityId": 24552,
        "AttributeUid": "f5267c3a-e247-4910-bae0-67d869b7afd3"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "cb24c558-d099-466c-91a3-0f9adeea54df"
      }
    ],
    "ReferencesOnVariantAttributes": [
      {
        "EntityId": 22,
        "AttributeUid": "f5267c3a-e247-4910-bae0-67d869b7afd3"
      }
    ],
    "ReferencingGlobalListValues": [
      "9bdd29b6-d4f9-4a7a-b48d-6a097c8f9f09"
    ],
    "ReferencingProductStructures": [
      "c20a3bb0-f735-46c0-b554-a50fd6260f82",
      "c527650e-75f9-4530-98c2-045fefde5eaa"
    ],
    "ReferencingVariationDefinitions": [
      "1fd0df36-a321-4cc6-9ee3-7585ccef8aef"
    ]
  }
]

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