GET /GlobalLists Get all global lists created in the system

[
  {
    "Id": 10,
    "Uid": "cdc85c03-38d2-4cda-a572-6f50c00d04a1",
    "Attribute": {
      "SubAttributes": [
        {
          "UseMultiRowInput": false,
          "UseRichText": false,
          "ShowCharacterCount": false,
          "EnableAIAssistant": false,
          "Uid": "926cefa3-24f7-41fc-9177-382de41ded06",
          "Alias": "Name",
          "BackofficeName": "Name",
          "BackofficeDescription": "Localized name of color",
          "Name": {
            "en-GB": "Name",
            "da-DK": "Navn"
          },
          "AttributeScope": "00000000-0000-0000-0000-000000000000",
          "AttributeScopes": [],
          "Localized": true,
          "ReadOnly": false,
          "Mandatory": false,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        },
        {
          "UseMultiRowInput": false,
          "UseRichText": false,
          "ShowCharacterCount": false,
          "EnableAIAssistant": false,
          "Uid": "2442884b-1d97-419c-b070-555c7adf0639",
          "Alias": "HEXcolor",
          "BackofficeName": "HEX color",
          "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
          "AttributeScope": "00000000-0000-0000-0000-000000000000",
          "AttributeScopes": [],
          "Localized": false,
          "ReadOnly": false,
          "Mandatory": false,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        }
      ],
      "RenderValuesForAttributeFieldUids": [
        "926cefa3-24f7-41fc-9177-382de41ded06"
      ],
      "RenderValuesForBackofficeAttributeFieldUids": [
        "926cefa3-24f7-41fc-9177-382de41ded06"
      ],
      "DefaultListViewAttributeFieldUids": [
        "cdc85c03-38d2-4cda-a572-6f50c00d04a1_926cefa3-24f7-41fc-9177-382de41ded06"
      ],
      "Uid": "cdc85c03-38d2-4cda-a572-6f50c00d04a1",
      "Alias": "Colors",
      "BackofficeName": "Colors",
      "BackofficeDescription": "Colors variants in the system",
      "Name": {
        "en-GB": "Colors",
        "da-DK": "Farver"
      },
      "Description": {
        "en-GB": "Colors that products can take",
        "da-DK": "Farver produkter kan antage"
      },
      "AttributeScope": "00000000-0000-0000-0000-000000000000",
      "AttributeScopes": [],
      "Localized": false,
      "ReadOnly": false,
      "Mandatory": false,
      "Unchangeable": false,
      "AttributeType": "ComplexAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": true,
    "ViewPermission": "86390cb9-773d-4de2-9cb1-f43a27b81240",
    "ManageRequiresPermission": true,
    "CreateRequiresPermission": true,
    "EditRequiresPermission": true,
    "DeleteRequiresPermission": true,
    "ManagePermission": "5410ed88-05ed-49e5-860e-b93718f3a66f",
    "CreatePermission": "5410ed88-05ed-49e5-860e-b93718f3a66f",
    "EditPermission": "5353bdc0-af12-4906-86f8-db29066ee36a",
    "DeletePermission": "8b2bb1f1-dd9c-4cb9-b713-b359bb926462",
    "FolderUid": "0e21c407-009c-4184-a6b3-e53879ed139f",
    "RequiresSorting": false,
    "KeyIsCaseInsensitive": false
  },
  {
    "Id": 11,
    "Uid": "cb85ea06-76b0-4af2-9306-d2520a9863a6",
    "Attribute": {
      "UseMultiRowInput": false,
      "UseRichText": false,
      "ShowCharacterCount": false,
      "EnableAIAssistant": false,
      "Uid": "cb85ea06-76b0-4af2-9306-d2520a9863a6",
      "Alias": "ProductStatusses",
      "BackofficeName": "Product statusses",
      "BackofficeDescription": "Manage statusses that products can have",
      "AttributeScope": "00000000-0000-0000-0000-000000000000",
      "AttributeScopes": [],
      "Localized": false,
      "ReadOnly": false,
      "Mandatory": false,
      "Unchangeable": false,
      "AttributeType": "TextAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": false,
    "ManageRequiresPermission": false,
    "CreateRequiresPermission": false,
    "EditRequiresPermission": false,
    "DeleteRequiresPermission": false,
    "RequiresSorting": false,
    "KeyIsCaseInsensitive": false
  }
]

Response status OK (200)

array : GlobalList

GlobalList

Property name	Data type	Description
Id	integer	Id of global list (readonly)
Uid	string	Unique id of global list
Attribute	object : Attribute	Attribute defining the data model for values of the global list
ViewRequiresPermission	boolean	Indicates whether a special permission is required to view the global list
ViewPermission	string	Permission required to view the global list, if ViewRequiresPermission is set
ManageRequiresPermission	boolean	Indicates whether a special permission is required in order to create or update values in the global list
CreateRequiresPermission	boolean	Indicates whether a special permission is required in order to create values in the global list
EditRequiresPermission	boolean	Indicates whether a special permission is required in order to update values in the global list
DeleteRequiresPermission	boolean	Indicates whether a special permission is required in order to delete values in the global list
ManagePermission	string	Permission required to create or update values in the global list, if ManageRequiresPermission is set
CreatePermission	string	Permission required to create values in the global list, if CreateRequiresPermission is set
EditPermission	string	Permission required to update values in the global list, if EditRequiresPermission is set
DeletePermission	string	Permission required to delete values in the global list, if DeleteRequiresPermission is set
FolderUid	string	Uid of folder to place global list in
RequiresSorting	boolean	Defines if values on a global list values should be sorted on creation
GlobalListKeys	array	Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)
KeyIsCaseInsensitive	boolean	Defines if key value for a global list value is case insensitive

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 /GlobalLists Update a global list

{
  "Id": 10,
  "Uid": "932de096-43e1-4394-beec-6c2e31b59e35",
  "Attribute": {
    "SubAttributes": [
      {
        "UseMultiRowInput": false,
        "UseRichText": false,
        "ShowCharacterCount": false,
        "EnableAIAssistant": false,
        "Uid": "3c7482bf-cc31-43c6-9d00-ac894bf0d05e",
        "Alias": "Name",
        "BackofficeName": "Name",
        "BackofficeDescription": "Localized name of color",
        "Name": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "AttributeScope": "00000000-0000-0000-0000-000000000000",
        "AttributeScopes": [],
        "Localized": true,
        "ReadOnly": false,
        "Mandatory": false,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      },
      {
        "UseMultiRowInput": false,
        "UseRichText": false,
        "ShowCharacterCount": false,
        "EnableAIAssistant": false,
        "Uid": "946b9e9f-e2c7-403c-8bcb-6122ac6c83cb",
        "Alias": "HEXcolor",
        "BackofficeName": "HEX color",
        "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
        "AttributeScope": "00000000-0000-0000-0000-000000000000",
        "AttributeScopes": [],
        "Localized": false,
        "ReadOnly": false,
        "Mandatory": false,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      }
    ],
    "RenderValuesForAttributeFieldUids": [
      "3c7482bf-cc31-43c6-9d00-ac894bf0d05e"
    ],
    "RenderValuesForBackofficeAttributeFieldUids": [
      "3c7482bf-cc31-43c6-9d00-ac894bf0d05e"
    ],
    "DefaultListViewAttributeFieldUids": [
      "932de096-43e1-4394-beec-6c2e31b59e35_3c7482bf-cc31-43c6-9d00-ac894bf0d05e"
    ],
    "Uid": "932de096-43e1-4394-beec-6c2e31b59e35",
    "Alias": "Colors",
    "BackofficeName": "Colors",
    "BackofficeDescription": "Colors variants in the system",
    "Name": {
      "en-GB": "Colors",
      "da-DK": "Farver"
    },
    "Description": {
      "en-GB": "Colors that products can take",
      "da-DK": "Farver produkter kan antage"
    },
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [],
    "Localized": false,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "ComplexAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  "ViewRequiresPermission": true,
  "ViewPermission": "53acf4af-3515-4139-b51d-e54e55682b05",
  "ManageRequiresPermission": true,
  "CreateRequiresPermission": true,
  "EditRequiresPermission": true,
  "DeleteRequiresPermission": true,
  "ManagePermission": "f3430c06-df44-4f19-a720-48e650eb79f4",
  "CreatePermission": "f3430c06-df44-4f19-a720-48e650eb79f4",
  "EditPermission": "88dc16d0-7d43-4c34-97de-c41da578fb9a",
  "DeletePermission": "4023190c-aa72-4fc2-adbc-a1ab38e42149",
  "FolderUid": "10c9acde-3681-45d1-9dac-174974697979",
  "RequiresSorting": false,
  "KeyIsCaseInsensitive": false
}

Request parameters

Property name	Parameter type	Data type	Description
globalList	body	object : GlobalList	Global List model

GlobalList

Property name	Data type	Description
Id	integer	Id of global list (readonly)
Uid	string	Unique id of global list
Attribute	object : Attribute	Attribute defining the data model for values of the global list
ViewRequiresPermission	boolean	Indicates whether a special permission is required to view the global list
ViewPermission	string	Permission required to view the global list, if ViewRequiresPermission is set
ManageRequiresPermission	boolean	Indicates whether a special permission is required in order to create or update values in the global list
CreateRequiresPermission	boolean	Indicates whether a special permission is required in order to create values in the global list
EditRequiresPermission	boolean	Indicates whether a special permission is required in order to update values in the global list
DeleteRequiresPermission	boolean	Indicates whether a special permission is required in order to delete values in the global list
ManagePermission	string	Permission required to create or update values in the global list, if ManageRequiresPermission is set
CreatePermission	string	Permission required to create values in the global list, if CreateRequiresPermission is set
EditPermission	string	Permission required to update values in the global list, if EditRequiresPermission is set
DeletePermission	string	Permission required to delete values in the global list, if DeleteRequiresPermission is set
FolderUid	string	Uid of folder to place global list in
RequiresSorting	boolean	Defines if values on a global list values should be sorted on creation
GlobalListKeys	array	Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)
KeyIsCaseInsensitive	boolean	Defines if key value for a global list value is case insensitive

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 /GlobalLists Create a new global list

Request example Response example

{
  "Id": 10,
  "Uid": "c63e3b4c-ee08-4806-9ea2-b5bdde32de72",
  "Attribute": {
    "SubAttributes": [
      {
        "UseMultiRowInput": false,
        "UseRichText": false,
        "ShowCharacterCount": false,
        "EnableAIAssistant": false,
        "Uid": "49828d70-55ca-4c3c-b0e2-5f2dc5790666",
        "Alias": "Name",
        "BackofficeName": "Name",
        "BackofficeDescription": "Localized name of color",
        "Name": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "AttributeScope": "00000000-0000-0000-0000-000000000000",
        "AttributeScopes": [],
        "Localized": true,
        "ReadOnly": false,
        "Mandatory": false,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      },
      {
        "UseMultiRowInput": false,
        "UseRichText": false,
        "ShowCharacterCount": false,
        "EnableAIAssistant": false,
        "Uid": "bd6676d7-b341-4201-a3c4-8518ad07276a",
        "Alias": "HEXcolor",
        "BackofficeName": "HEX color",
        "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
        "AttributeScope": "00000000-0000-0000-0000-000000000000",
        "AttributeScopes": [],
        "Localized": false,
        "ReadOnly": false,
        "Mandatory": false,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      }
    ],
    "RenderValuesForAttributeFieldUids": [
      "49828d70-55ca-4c3c-b0e2-5f2dc5790666"
    ],
    "RenderValuesForBackofficeAttributeFieldUids": [
      "49828d70-55ca-4c3c-b0e2-5f2dc5790666"
    ],
    "DefaultListViewAttributeFieldUids": [
      "c63e3b4c-ee08-4806-9ea2-b5bdde32de72_49828d70-55ca-4c3c-b0e2-5f2dc5790666"
    ],
    "Uid": "c63e3b4c-ee08-4806-9ea2-b5bdde32de72",
    "Alias": "Colors",
    "BackofficeName": "Colors",
    "BackofficeDescription": "Colors variants in the system",
    "Name": {
      "en-GB": "Colors",
      "da-DK": "Farver"
    },
    "Description": {
      "en-GB": "Colors that products can take",
      "da-DK": "Farver produkter kan antage"
    },
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [],
    "Localized": false,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "ComplexAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  "ViewRequiresPermission": true,
  "ViewPermission": "17503847-55a4-479c-894b-7c67f9f29bd4",
  "ManageRequiresPermission": true,
  "CreateRequiresPermission": true,
  "EditRequiresPermission": true,
  "DeleteRequiresPermission": true,
  "ManagePermission": "33159214-b805-4762-85bc-6e6bff02a593",
  "CreatePermission": "33159214-b805-4762-85bc-6e6bff02a593",
  "EditPermission": "d7ad1500-f65d-4b0b-96db-4b4606445f0a",
  "DeletePermission": "1963d959-b22d-4528-a3bb-72fb5111c224",
  "FolderUid": "32c83a4e-748d-4d72-80e8-9e4fea63b2e4",
  "RequiresSorting": false,
  "KeyIsCaseInsensitive": false
}

[
  {
    "Id": 10,
    "Uid": "3454f29c-fe5b-4512-b498-f9b848a82ea3",
    "Attribute": {
      "SubAttributes": [
        {
          "UseMultiRowInput": false,
          "UseRichText": false,
          "ShowCharacterCount": false,
          "EnableAIAssistant": false,
          "Uid": "f725cb6a-ce63-497f-835f-cee5cb1419cc",
          "Alias": "Name",
          "BackofficeName": "Name",
          "BackofficeDescription": "Localized name of color",
          "Name": {
            "en-GB": "Name",
            "da-DK": "Navn"
          },
          "AttributeScope": "00000000-0000-0000-0000-000000000000",
          "AttributeScopes": [],
          "Localized": true,
          "ReadOnly": false,
          "Mandatory": false,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        },
        {
          "UseMultiRowInput": false,
          "UseRichText": false,
          "ShowCharacterCount": false,
          "EnableAIAssistant": false,
          "Uid": "6a0d0c97-5a2f-4be0-b619-159f07a00199",
          "Alias": "HEXcolor",
          "BackofficeName": "HEX color",
          "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
          "AttributeScope": "00000000-0000-0000-0000-000000000000",
          "AttributeScopes": [],
          "Localized": false,
          "ReadOnly": false,
          "Mandatory": false,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        }
      ],
      "RenderValuesForAttributeFieldUids": [
        "f725cb6a-ce63-497f-835f-cee5cb1419cc"
      ],
      "RenderValuesForBackofficeAttributeFieldUids": [
        "f725cb6a-ce63-497f-835f-cee5cb1419cc"
      ],
      "DefaultListViewAttributeFieldUids": [
        "3454f29c-fe5b-4512-b498-f9b848a82ea3_f725cb6a-ce63-497f-835f-cee5cb1419cc"
      ],
      "Uid": "3454f29c-fe5b-4512-b498-f9b848a82ea3",
      "Alias": "Colors",
      "BackofficeName": "Colors",
      "BackofficeDescription": "Colors variants in the system",
      "Name": {
        "en-GB": "Colors",
        "da-DK": "Farver"
      },
      "Description": {
        "en-GB": "Colors that products can take",
        "da-DK": "Farver produkter kan antage"
      },
      "AttributeScope": "00000000-0000-0000-0000-000000000000",
      "AttributeScopes": [],
      "Localized": false,
      "ReadOnly": false,
      "Mandatory": false,
      "Unchangeable": false,
      "AttributeType": "ComplexAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": true,
    "ViewPermission": "f0d9af65-795a-460d-9b68-0c5ff99c8990",
    "ManageRequiresPermission": true,
    "CreateRequiresPermission": true,
    "EditRequiresPermission": true,
    "DeleteRequiresPermission": true,
    "ManagePermission": "3ddf3944-0100-4778-b512-9ab4d89151ba",
    "CreatePermission": "3ddf3944-0100-4778-b512-9ab4d89151ba",
    "EditPermission": "bd8554fe-7ae7-42bc-8338-80c5bbd6909e",
    "DeletePermission": "10c2db6b-1da7-4f5e-a78a-9b300307d350",
    "FolderUid": "be66e1be-73c0-42c5-9e66-4b4d39daa20a",
    "RequiresSorting": false,
    "KeyIsCaseInsensitive": false
  },
  {
    "Id": 11,
    "Uid": "bf88df25-4348-4976-87d9-0441c0b0e6e5",
    "Attribute": {
      "UseMultiRowInput": false,
      "UseRichText": false,
      "ShowCharacterCount": false,
      "EnableAIAssistant": false,
      "Uid": "bf88df25-4348-4976-87d9-0441c0b0e6e5",
      "Alias": "ProductStatusses",
      "BackofficeName": "Product statusses",
      "BackofficeDescription": "Manage statusses that products can have",
      "AttributeScope": "00000000-0000-0000-0000-000000000000",
      "AttributeScopes": [],
      "Localized": false,
      "ReadOnly": false,
      "Mandatory": false,
      "Unchangeable": false,
      "AttributeType": "TextAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": false,
    "ManageRequiresPermission": false,
    "CreateRequiresPermission": false,
    "EditRequiresPermission": false,
    "DeleteRequiresPermission": false,
    "RequiresSorting": false,
    "KeyIsCaseInsensitive": false
  }
]

Request parameters

Property name	Parameter type	Data type	Description
globalList	body	object : GlobalList	Global list model

GlobalList

Property name	Data type	Description
Id	integer	Id of global list (readonly)
Uid	string	Unique id of global list
Attribute	object : Attribute	Attribute defining the data model for values of the global list
ViewRequiresPermission	boolean	Indicates whether a special permission is required to view the global list
ViewPermission	string	Permission required to view the global list, if ViewRequiresPermission is set
ManageRequiresPermission	boolean	Indicates whether a special permission is required in order to create or update values in the global list
CreateRequiresPermission	boolean	Indicates whether a special permission is required in order to create values in the global list
EditRequiresPermission	boolean	Indicates whether a special permission is required in order to update values in the global list
DeleteRequiresPermission	boolean	Indicates whether a special permission is required in order to delete values in the global list
ManagePermission	string	Permission required to create or update values in the global list, if ManageRequiresPermission is set
CreatePermission	string	Permission required to create values in the global list, if CreateRequiresPermission is set
EditPermission	string	Permission required to update values in the global list, if EditRequiresPermission is set
DeletePermission	string	Permission required to delete values in the global list, if DeleteRequiresPermission is set
FolderUid	string	Uid of folder to place global list in
RequiresSorting	boolean	Defines if values on a global list values should be sorted on creation
GlobalListKeys	array	Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)
KeyIsCaseInsensitive	boolean	Defines if key value for a global list value is case insensitive

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)

object

DELETE /GlobalLists Delete a global list

Request parameters

Property name	Parameter type	Data type	Description
uid	query	string	the Unique id of the global list

Response status OK (200)

No body message is returned

GET /GlobalLists/{uid} Get a specific global list

{
  "Id": 10,
  "Uid": "2578356b-7b35-48c6-bbc5-4e407c385710",
  "Attribute": {
    "SubAttributes": [
      {
        "UseMultiRowInput": false,
        "UseRichText": false,
        "ShowCharacterCount": false,
        "EnableAIAssistant": false,
        "Uid": "f88fa411-50c2-4747-9be5-16f3524edfdb",
        "Alias": "Name",
        "BackofficeName": "Name",
        "BackofficeDescription": "Localized name of color",
        "Name": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "AttributeScope": "00000000-0000-0000-0000-000000000000",
        "AttributeScopes": [],
        "Localized": true,
        "ReadOnly": false,
        "Mandatory": false,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      },
      {
        "UseMultiRowInput": false,
        "UseRichText": false,
        "ShowCharacterCount": false,
        "EnableAIAssistant": false,
        "Uid": "281a3ac8-e118-490b-b9c6-912669914a36",
        "Alias": "HEXcolor",
        "BackofficeName": "HEX color",
        "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
        "AttributeScope": "00000000-0000-0000-0000-000000000000",
        "AttributeScopes": [],
        "Localized": false,
        "ReadOnly": false,
        "Mandatory": false,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      }
    ],
    "RenderValuesForAttributeFieldUids": [
      "f88fa411-50c2-4747-9be5-16f3524edfdb"
    ],
    "RenderValuesForBackofficeAttributeFieldUids": [
      "f88fa411-50c2-4747-9be5-16f3524edfdb"
    ],
    "DefaultListViewAttributeFieldUids": [
      "2578356b-7b35-48c6-bbc5-4e407c385710_f88fa411-50c2-4747-9be5-16f3524edfdb"
    ],
    "Uid": "2578356b-7b35-48c6-bbc5-4e407c385710",
    "Alias": "Colors",
    "BackofficeName": "Colors",
    "BackofficeDescription": "Colors variants in the system",
    "Name": {
      "en-GB": "Colors",
      "da-DK": "Farver"
    },
    "Description": {
      "en-GB": "Colors that products can take",
      "da-DK": "Farver produkter kan antage"
    },
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [],
    "Localized": false,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "ComplexAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  "ViewRequiresPermission": true,
  "ViewPermission": "9d478029-5c04-48a6-9f2a-7950097f5949",
  "ManageRequiresPermission": true,
  "CreateRequiresPermission": true,
  "EditRequiresPermission": true,
  "DeleteRequiresPermission": true,
  "ManagePermission": "7ccda528-3c2b-4ee0-b373-7ebccfb6eacd",
  "CreatePermission": "7ccda528-3c2b-4ee0-b373-7ebccfb6eacd",
  "EditPermission": "1e91e243-4a43-4e8c-9d1f-3dd3f1905f1f",
  "DeletePermission": "3f1f631c-b5be-4d6c-adb0-e719ca90f192",
  "FolderUid": "8990712a-b9ab-4025-a4c5-feb441773997",
  "RequiresSorting": false,
  "KeyIsCaseInsensitive": false
}

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of global list

Response status OK (200)

object : GlobalList

GlobalList

Property name	Data type	Description
Id	integer	Id of global list (readonly)
Uid	string	Unique id of global list
Attribute	object : Attribute	Attribute defining the data model for values of the global list
ViewRequiresPermission	boolean	Indicates whether a special permission is required to view the global list
ViewPermission	string	Permission required to view the global list, if ViewRequiresPermission is set
ManageRequiresPermission	boolean	Indicates whether a special permission is required in order to create or update values in the global list
CreateRequiresPermission	boolean	Indicates whether a special permission is required in order to create values in the global list
EditRequiresPermission	boolean	Indicates whether a special permission is required in order to update values in the global list
DeleteRequiresPermission	boolean	Indicates whether a special permission is required in order to delete values in the global list
ManagePermission	string	Permission required to create or update values in the global list, if ManageRequiresPermission is set
CreatePermission	string	Permission required to create values in the global list, if CreateRequiresPermission is set
EditPermission	string	Permission required to update values in the global list, if EditRequiresPermission is set
DeletePermission	string	Permission required to delete values in the global list, if DeleteRequiresPermission is set
FolderUid	string	Uid of folder to place global list in
RequiresSorting	boolean	Defines if values on a global list values should be sorted on creation
GlobalListKeys	array	Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)
KeyIsCaseInsensitive	boolean	Defines if key value for a global list value is case insensitive

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 /GlobalLists/{uid}/values Get values for a specific global list

{
  "Total": 201,
  "Remaining": 199,
  "LastId": "08ee3ca5-7a8d-4281-816d-48aa48a90fb0",
  "GlobalListValues": [
    {
      "Uid": "e9f9bf1b-e141-4a0b-ab02-34508d6e2568",
      "SortOrder": 1,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Blue"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Blå"
          }
        ],
        "HEXColor": "0000FF"
      }
    },
    {
      "Uid": "6bb5c7bb-8e39-467f-9ebe-0c4b49645aa8",
      "SortOrder": 2,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Green"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Grøn"
          }
        ],
        "HEXColor": "00FF00"
      }
    },
    {
      "Uid": "08ee3ca5-7a8d-4281-816d-48aa48a90fb0",
      "SortOrder": 2,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Red"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Rød"
          }
        ],
        "HEXColor": "FF0000"
      }
    }
  ]
}

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of global list to get values for
limit	query	integer	Max number of items to return
afterId	query	string	Only get values sorted after this id

Response status OK (200)

object : GlobalListValueResultSet

GlobalListValueResultSet

Property name	Data type	Description
Total	integer	Total number of global list values in global list
Remaining	integer	Remaining values after the LastId in this result set
LastId	string	Last id of values in this resultset. Use as pointer to fetch next batch of values
GlobalListValues	array : GlobalListValue	The global list values in this resultset

GlobalListValue

Property name

Data type

Description

Uid

string

Unique id of global list value

SortOrder

integer

Sort order of this value compared to other values in the same global list

Value

object

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

The table below shows how different attributes translates to this value model.

Attribute type	data type
Text attribute	string
Number attribute	decimal
Boolean attribute	bool
Fixedlist attribute	value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute	string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute	DateTimeOffset
Category attribute	int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute	int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute	int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute	uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute	string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute	object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute	value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)

PUT /GlobalLists/{uid}/values Update values in a global list

[
  {
    "Uid": "951a9070-892f-4f09-8651-4c2c62bc0e8e",
    "SortOrder": 1,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Blue"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Blå"
        }
      ],
      "HEXColor": "0000FF"
    }
  },
  {
    "Uid": "7145215a-f359-47de-8a18-9ec96cf06978",
    "SortOrder": 2,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Green"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Grøn"
        }
      ],
      "HEXColor": "00FF00"
    }
  },
  {
    "Uid": "1d77bdbb-ae54-4f71-b377-6ee376a27209",
    "SortOrder": 2,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Red"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Rød"
        }
      ],
      "HEXColor": "FF0000"
    }
  }
]

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of global list to update values in
globalListValues	body	array : GlobalListValue	The values to update

GlobalListValue

Property name

Data type

Description

Uid

string

Unique id of global list value

SortOrder

integer

Sort order of this value compared to other values in the same global list

Value

object

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

The table below shows how different attributes translates to this value model.

Attribute type	data type
Text attribute	string
Number attribute	decimal
Boolean attribute	bool
Fixedlist attribute	value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute	string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute	DateTimeOffset
Category attribute	int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute	int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute	int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute	uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute	string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute	object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute	value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)

Response status OK (200)

No body message is returned

POST /GlobalLists/{uid}/values Create values in a global list

[
  {
    "Uid": "1b84c531-1126-4a8b-ba45-af6b0ec86388",
    "SortOrder": 1,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Blue"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Blå"
        }
      ],
      "HEXColor": "0000FF"
    }
  },
  {
    "Uid": "ee0da5b8-d2f6-4e8b-ae4e-a6e5a7b7f362",
    "SortOrder": 2,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Green"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Grøn"
        }
      ],
      "HEXColor": "00FF00"
    }
  },
  {
    "Uid": "c27048f5-e507-438d-bf17-5bc7ce838555",
    "SortOrder": 2,
    "Value": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Red"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Rød"
        }
      ],
      "HEXColor": "FF0000"
    }
  }
]

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of global list to create values in
globalListValues	body	array : GlobalListValue	Values to create in global list

GlobalListValue

Property name

Data type

Description

Uid

string

Unique id of global list value

SortOrder

integer

Sort order of this value compared to other values in the same global list

Value

object

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

The table below shows how different attributes translates to this value model.

Attribute type	data type
Text attribute	string
Number attribute	decimal
Boolean attribute	bool
Fixedlist attribute	value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute	string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute	DateTimeOffset
Category attribute	int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute	int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute	int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute	uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute	string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute	object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute	value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)

Response status OK (200)

No body message is returned

POST /GlobalLists/batch Get a batch of global lists

[
  {
    "Id": 10,
    "Uid": "ad119f15-5ff7-40f3-b30b-63e4892d4bc1",
    "Attribute": {
      "SubAttributes": [
        {
          "UseMultiRowInput": false,
          "UseRichText": false,
          "ShowCharacterCount": false,
          "EnableAIAssistant": false,
          "Uid": "370f64f4-cb51-42f9-bd99-d115a9d65ee1",
          "Alias": "Name",
          "BackofficeName": "Name",
          "BackofficeDescription": "Localized name of color",
          "Name": {
            "en-GB": "Name",
            "da-DK": "Navn"
          },
          "AttributeScope": "00000000-0000-0000-0000-000000000000",
          "AttributeScopes": [],
          "Localized": true,
          "ReadOnly": false,
          "Mandatory": false,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        },
        {
          "UseMultiRowInput": false,
          "UseRichText": false,
          "ShowCharacterCount": false,
          "EnableAIAssistant": false,
          "Uid": "7b5235a5-3c7b-452b-a38a-8aec6fc87fc8",
          "Alias": "HEXcolor",
          "BackofficeName": "HEX color",
          "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
          "AttributeScope": "00000000-0000-0000-0000-000000000000",
          "AttributeScopes": [],
          "Localized": false,
          "ReadOnly": false,
          "Mandatory": false,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        }
      ],
      "RenderValuesForAttributeFieldUids": [
        "370f64f4-cb51-42f9-bd99-d115a9d65ee1"
      ],
      "RenderValuesForBackofficeAttributeFieldUids": [
        "370f64f4-cb51-42f9-bd99-d115a9d65ee1"
      ],
      "DefaultListViewAttributeFieldUids": [
        "ad119f15-5ff7-40f3-b30b-63e4892d4bc1_370f64f4-cb51-42f9-bd99-d115a9d65ee1"
      ],
      "Uid": "ad119f15-5ff7-40f3-b30b-63e4892d4bc1",
      "Alias": "Colors",
      "BackofficeName": "Colors",
      "BackofficeDescription": "Colors variants in the system",
      "Name": {
        "en-GB": "Colors",
        "da-DK": "Farver"
      },
      "Description": {
        "en-GB": "Colors that products can take",
        "da-DK": "Farver produkter kan antage"
      },
      "AttributeScope": "00000000-0000-0000-0000-000000000000",
      "AttributeScopes": [],
      "Localized": false,
      "ReadOnly": false,
      "Mandatory": false,
      "Unchangeable": false,
      "AttributeType": "ComplexAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": true,
    "ViewPermission": "0be68e7a-07f9-4a24-af31-804017918028",
    "ManageRequiresPermission": true,
    "CreateRequiresPermission": true,
    "EditRequiresPermission": true,
    "DeleteRequiresPermission": true,
    "ManagePermission": "8c7a4fe6-a846-438b-93c0-5c2490192df3",
    "CreatePermission": "8c7a4fe6-a846-438b-93c0-5c2490192df3",
    "EditPermission": "f13b49bb-694b-401c-bc8d-d50a40a6623c",
    "DeletePermission": "459bfd17-a96b-442a-a8e2-0ac2e8510bc5",
    "FolderUid": "81991603-0641-4712-9f01-1587b99d8ff0",
    "RequiresSorting": false,
    "KeyIsCaseInsensitive": false
  },
  {
    "Id": 11,
    "Uid": "b5553fc9-2cd9-442f-b1eb-12b0b8cc7d15",
    "Attribute": {
      "UseMultiRowInput": false,
      "UseRichText": false,
      "ShowCharacterCount": false,
      "EnableAIAssistant": false,
      "Uid": "b5553fc9-2cd9-442f-b1eb-12b0b8cc7d15",
      "Alias": "ProductStatusses",
      "BackofficeName": "Product statusses",
      "BackofficeDescription": "Manage statusses that products can have",
      "AttributeScope": "00000000-0000-0000-0000-000000000000",
      "AttributeScopes": [],
      "Localized": false,
      "ReadOnly": false,
      "Mandatory": false,
      "Unchangeable": false,
      "AttributeType": "TextAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": false,
    "ManageRequiresPermission": false,
    "CreateRequiresPermission": false,
    "EditRequiresPermission": false,
    "DeleteRequiresPermission": false,
    "RequiresSorting": false,
    "KeyIsCaseInsensitive": false
  }
]

Request parameters

Property name	Parameter type	Data type	Description
uids	body	array : string	Array with unique ids of global lists to return

Response status OK (200)

array : GlobalList

GlobalList

Property name	Data type	Description
Id	integer	Id of global list (readonly)
Uid	string	Unique id of global list
Attribute	object : Attribute	Attribute defining the data model for values of the global list
ViewRequiresPermission	boolean	Indicates whether a special permission is required to view the global list
ViewPermission	string	Permission required to view the global list, if ViewRequiresPermission is set
ManageRequiresPermission	boolean	Indicates whether a special permission is required in order to create or update values in the global list
CreateRequiresPermission	boolean	Indicates whether a special permission is required in order to create values in the global list
EditRequiresPermission	boolean	Indicates whether a special permission is required in order to update values in the global list
DeleteRequiresPermission	boolean	Indicates whether a special permission is required in order to delete values in the global list
ManagePermission	string	Permission required to create or update values in the global list, if ManageRequiresPermission is set
CreatePermission	string	Permission required to create values in the global list, if CreateRequiresPermission is set
EditPermission	string	Permission required to update values in the global list, if EditRequiresPermission is set
DeletePermission	string	Permission required to delete values in the global list, if DeleteRequiresPermission is set
FolderUid	string	Uid of folder to place global list in
RequiresSorting	boolean	Defines if values on a global list values should be sorted on creation
GlobalListKeys	array	Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)
KeyIsCaseInsensitive	boolean	Defines if key value for a global list value is case insensitive

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 /GlobalLists/ByAlias/{alias} Get a specific global list by its alias

{
  "Id": 10,
  "Uid": "18d6656a-3ebb-4ff2-b828-da982d9bbe59",
  "Attribute": {
    "SubAttributes": [
      {
        "UseMultiRowInput": false,
        "UseRichText": false,
        "ShowCharacterCount": false,
        "EnableAIAssistant": false,
        "Uid": "0f147b9f-6aa8-4c41-ac37-fc2b96da4641",
        "Alias": "Name",
        "BackofficeName": "Name",
        "BackofficeDescription": "Localized name of color",
        "Name": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "AttributeScope": "00000000-0000-0000-0000-000000000000",
        "AttributeScopes": [],
        "Localized": true,
        "ReadOnly": false,
        "Mandatory": false,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      },
      {
        "UseMultiRowInput": false,
        "UseRichText": false,
        "ShowCharacterCount": false,
        "EnableAIAssistant": false,
        "Uid": "1e826c06-ecde-4712-a6f2-8beabb5039d4",
        "Alias": "HEXcolor",
        "BackofficeName": "HEX color",
        "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
        "AttributeScope": "00000000-0000-0000-0000-000000000000",
        "AttributeScopes": [],
        "Localized": false,
        "ReadOnly": false,
        "Mandatory": false,
        "Unchangeable": false,
        "AttributeType": "TextAttribute",
        "DisableRevisionLogging": false,
        "DisableIndexing": false
      }
    ],
    "RenderValuesForAttributeFieldUids": [
      "0f147b9f-6aa8-4c41-ac37-fc2b96da4641"
    ],
    "RenderValuesForBackofficeAttributeFieldUids": [
      "0f147b9f-6aa8-4c41-ac37-fc2b96da4641"
    ],
    "DefaultListViewAttributeFieldUids": [
      "18d6656a-3ebb-4ff2-b828-da982d9bbe59_0f147b9f-6aa8-4c41-ac37-fc2b96da4641"
    ],
    "Uid": "18d6656a-3ebb-4ff2-b828-da982d9bbe59",
    "Alias": "Colors",
    "BackofficeName": "Colors",
    "BackofficeDescription": "Colors variants in the system",
    "Name": {
      "en-GB": "Colors",
      "da-DK": "Farver"
    },
    "Description": {
      "en-GB": "Colors that products can take",
      "da-DK": "Farver produkter kan antage"
    },
    "AttributeScope": "00000000-0000-0000-0000-000000000000",
    "AttributeScopes": [],
    "Localized": false,
    "ReadOnly": false,
    "Mandatory": false,
    "Unchangeable": false,
    "AttributeType": "ComplexAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  "ViewRequiresPermission": true,
  "ViewPermission": "d1a8d890-97f3-496d-8bca-a0ccddb4f9d5",
  "ManageRequiresPermission": true,
  "CreateRequiresPermission": true,
  "EditRequiresPermission": true,
  "DeleteRequiresPermission": true,
  "ManagePermission": "23c2be81-58eb-49a4-9dfc-056d8305bf6a",
  "CreatePermission": "23c2be81-58eb-49a4-9dfc-056d8305bf6a",
  "EditPermission": "29598604-eba0-4c71-90d7-a91051094bef",
  "DeletePermission": "8465740d-439b-47a5-b68b-de9ade1ce6bd",
  "FolderUid": "e7dbda8a-fb97-40a4-be4f-7f5f924eaacc",
  "RequiresSorting": false,
  "KeyIsCaseInsensitive": false
}

Request parameters

Property name	Parameter type	Data type	Description
alias	path	string	Alias of the global list to return

Response status OK (200)

object : GlobalList

GlobalList

Property name	Data type	Description
Id	integer	Id of global list (readonly)
Uid	string	Unique id of global list
Attribute	object : Attribute	Attribute defining the data model for values of the global list
ViewRequiresPermission	boolean	Indicates whether a special permission is required to view the global list
ViewPermission	string	Permission required to view the global list, if ViewRequiresPermission is set
ManageRequiresPermission	boolean	Indicates whether a special permission is required in order to create or update values in the global list
CreateRequiresPermission	boolean	Indicates whether a special permission is required in order to create values in the global list
EditRequiresPermission	boolean	Indicates whether a special permission is required in order to update values in the global list
DeleteRequiresPermission	boolean	Indicates whether a special permission is required in order to delete values in the global list
ManagePermission	string	Permission required to create or update values in the global list, if ManageRequiresPermission is set
CreatePermission	string	Permission required to create values in the global list, if CreateRequiresPermission is set
EditPermission	string	Permission required to update values in the global list, if EditRequiresPermission is set
DeletePermission	string	Permission required to delete values in the global list, if DeleteRequiresPermission is set
FolderUid	string	Uid of folder to place global list in
RequiresSorting	boolean	Defines if values on a global list values should be sorted on creation
GlobalListKeys	array	Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)
KeyIsCaseInsensitive	boolean	Defines if key value for a global list value is case insensitive

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 /GlobalLists/ByAlias/batch Get a batch of global lists by their aliases

[
  {
    "Id": 10,
    "Uid": "4faa4cf4-5833-42f7-80ec-335dd374d951",
    "Attribute": {
      "SubAttributes": [
        {
          "UseMultiRowInput": false,
          "UseRichText": false,
          "ShowCharacterCount": false,
          "EnableAIAssistant": false,
          "Uid": "ead440cb-be6b-4577-9ad0-6e73244ef277",
          "Alias": "Name",
          "BackofficeName": "Name",
          "BackofficeDescription": "Localized name of color",
          "Name": {
            "en-GB": "Name",
            "da-DK": "Navn"
          },
          "AttributeScope": "00000000-0000-0000-0000-000000000000",
          "AttributeScopes": [],
          "Localized": true,
          "ReadOnly": false,
          "Mandatory": false,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        },
        {
          "UseMultiRowInput": false,
          "UseRichText": false,
          "ShowCharacterCount": false,
          "EnableAIAssistant": false,
          "Uid": "de1f47f7-bab0-465a-875b-76d30662c441",
          "Alias": "HEXcolor",
          "BackofficeName": "HEX color",
          "BackofficeDescription": "Add a HEX color which can be used to display a color swatch",
          "AttributeScope": "00000000-0000-0000-0000-000000000000",
          "AttributeScopes": [],
          "Localized": false,
          "ReadOnly": false,
          "Mandatory": false,
          "Unchangeable": false,
          "AttributeType": "TextAttribute",
          "DisableRevisionLogging": false,
          "DisableIndexing": false
        }
      ],
      "RenderValuesForAttributeFieldUids": [
        "ead440cb-be6b-4577-9ad0-6e73244ef277"
      ],
      "RenderValuesForBackofficeAttributeFieldUids": [
        "ead440cb-be6b-4577-9ad0-6e73244ef277"
      ],
      "DefaultListViewAttributeFieldUids": [
        "4faa4cf4-5833-42f7-80ec-335dd374d951_ead440cb-be6b-4577-9ad0-6e73244ef277"
      ],
      "Uid": "4faa4cf4-5833-42f7-80ec-335dd374d951",
      "Alias": "Colors",
      "BackofficeName": "Colors",
      "BackofficeDescription": "Colors variants in the system",
      "Name": {
        "en-GB": "Colors",
        "da-DK": "Farver"
      },
      "Description": {
        "en-GB": "Colors that products can take",
        "da-DK": "Farver produkter kan antage"
      },
      "AttributeScope": "00000000-0000-0000-0000-000000000000",
      "AttributeScopes": [],
      "Localized": false,
      "ReadOnly": false,
      "Mandatory": false,
      "Unchangeable": false,
      "AttributeType": "ComplexAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": true,
    "ViewPermission": "172f0eea-26f0-4817-a1f0-158fbcaae916",
    "ManageRequiresPermission": true,
    "CreateRequiresPermission": true,
    "EditRequiresPermission": true,
    "DeleteRequiresPermission": true,
    "ManagePermission": "c0cf773f-f7f5-4b92-b0c5-31ab703f70cd",
    "CreatePermission": "c0cf773f-f7f5-4b92-b0c5-31ab703f70cd",
    "EditPermission": "ae9cc8b0-39d5-4a92-83f2-fe31d471e6cf",
    "DeletePermission": "d752d57e-f4b4-455c-b2c4-7d2961d06442",
    "FolderUid": "410248df-76d2-4afe-911c-33d30bbc2478",
    "RequiresSorting": false,
    "KeyIsCaseInsensitive": false
  },
  {
    "Id": 11,
    "Uid": "97f4931f-56ca-4211-b57d-788e14f27400",
    "Attribute": {
      "UseMultiRowInput": false,
      "UseRichText": false,
      "ShowCharacterCount": false,
      "EnableAIAssistant": false,
      "Uid": "97f4931f-56ca-4211-b57d-788e14f27400",
      "Alias": "ProductStatusses",
      "BackofficeName": "Product statusses",
      "BackofficeDescription": "Manage statusses that products can have",
      "AttributeScope": "00000000-0000-0000-0000-000000000000",
      "AttributeScopes": [],
      "Localized": false,
      "ReadOnly": false,
      "Mandatory": false,
      "Unchangeable": false,
      "AttributeType": "TextAttribute",
      "DisableRevisionLogging": false,
      "DisableIndexing": false
    },
    "ViewRequiresPermission": false,
    "ManageRequiresPermission": false,
    "CreateRequiresPermission": false,
    "EditRequiresPermission": false,
    "DeleteRequiresPermission": false,
    "RequiresSorting": false,
    "KeyIsCaseInsensitive": false
  }
]

Request parameters

Property name	Parameter type	Data type	Description
aliases	body	array : string	Array of aliases

Response status OK (200)

array : GlobalList

GlobalList

Property name	Data type	Description
Id	integer	Id of global list (readonly)
Uid	string	Unique id of global list
Attribute	object : Attribute	Attribute defining the data model for values of the global list
ViewRequiresPermission	boolean	Indicates whether a special permission is required to view the global list
ViewPermission	string	Permission required to view the global list, if ViewRequiresPermission is set
ManageRequiresPermission	boolean	Indicates whether a special permission is required in order to create or update values in the global list
CreateRequiresPermission	boolean	Indicates whether a special permission is required in order to create values in the global list
EditRequiresPermission	boolean	Indicates whether a special permission is required in order to update values in the global list
DeleteRequiresPermission	boolean	Indicates whether a special permission is required in order to delete values in the global list
ManagePermission	string	Permission required to create or update values in the global list, if ManageRequiresPermission is set
CreatePermission	string	Permission required to create values in the global list, if CreateRequiresPermission is set
EditPermission	string	Permission required to update values in the global list, if EditRequiresPermission is set
DeletePermission	string	Permission required to delete values in the global list, if DeleteRequiresPermission is set
FolderUid	string	Uid of folder to place global list in
RequiresSorting	boolean	Defines if values on a global list values should be sorted on creation
GlobalListKeys	array	Defines data elements of the global list, which in combination must be unique across all values of the this global list (format: [rootAttributeUid][subAttributeUid][LanguageId/NA]_[DimensionSegmentUid/NA] - ex. 17ca35af-9cb9-44a2-a2f4-1d30a3617e01_2ee6ac86-77d0-4385-94b7-84dd59e05d0b_NA_NA)
KeyIsCaseInsensitive	boolean	Defines if key value for a global list value is case insensitive

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 /GlobalLists/folders Get all global list folders in the system

[
  {
    "Uid": "d2b49945-8571-40db-92ad-bf6f0578142a",
    "Name": "General"
  },
  {
    "Uid": "787bdc87-f5ac-4ff9-8515-bac7b358f58a",
    "Name": "Electronics"
  },
  {
    "Uid": "fb460b00-cbb3-4d39-ac6c-a5e0e3035231",
    "Name": "Clothing"
  }
]

Response status OK (200)

array : GlobalListFolder

GlobalListFolder

Property name	Data type	Description
Uid	string	Unique id of folder
Name	string	Presented name of folder in backoffice

PUT /GlobalLists/folders Update existing global list folder

{
  "Uid": "b553a888-58cd-40e4-9bff-b14473dbb517",
  "Name": "General"
}

Request parameters

Property name	Parameter type	Data type	Description
folder	body	object : GlobalListFolder	Folder model

GlobalListFolder

Property name	Data type	Description
Uid	string	Unique id of folder
Name	string	Presented name of folder in backoffice

Response status OK (200)

No body message is returned

POST /GlobalLists/folders Create new global list folder

{
  "Uid": "5a2f57a0-381e-4847-bf07-eec07b3711f8",
  "Name": "General"
}

Request parameters

Property name	Parameter type	Data type	Description
folder	body	object : GlobalListFolder	Folder model

GlobalListFolder

Property name	Data type	Description
Uid	string	Unique id of folder
Name	string	Presented name of folder in backoffice

Response status OK (200)

object

DELETE /GlobalLists/folders Deletes the global list folder with the specified uid

Request parameters

Property name	Parameter type	Data type	Description
uid	query	string	Uid of folder to delete

Response status OK (200)

No body message is returned

GET /GlobalLists/folders/{uid} Get a specific global list folder

{
  "Uid": "d64b537e-ba52-4fed-8b2f-5d996472e696",
  "Name": "General"
}

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of folder

Response status OK (200)

object : GlobalListFolder

GlobalListFolder

Property name	Data type	Description
Uid	string	Unique id of folder
Name	string	Presented name of folder in backoffice

GET /GlobalLists/queryablefields/{uid} Get available query fields for a specific global list

[
  {
    "Uid": "03d1fc91-69c9-4b31-a09c-2c815f20aa12_NA_NA",
    "Name": "Id",
    "SupportsSorting": false
  },
  {
    "Uid": "ddf07a35-7aa5-4dec-baed-f33863be2fb8_NA_1",
    "Name": "Name (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "ddf07a35-7aa5-4dec-baed-f33863be2fb8_NA_2",
    "Name": "Name (da-DK)",
    "SupportsSorting": false
  },
  {
    "Uid": "9f06c2ea-d008-49a1-9245-900cad8432b5_NA_1",
    "Name": "Description (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "9f06c2ea-d008-49a1-9245-900cad8432b5_NA_2",
    "Name": "Description (da-DK)",
    "SupportsSorting": false
  }
]

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Uid of global list

Response status OK (200)

array : QueryableField

QueryableField

Property name	Data type	Description
Uid	string	Unique id of field in PIM
Name	string	The display name of the field
SupportsSorting	boolean	If true field can be used for sorting

POST /GlobalLists/search/{uid} Get uids of global list values matching certain criteria

Request example Response example

{
  "SubQueries": [
    {
      "Filters": [
        {
          "FieldUid": "03d1fc91-69c9-4b31-a09c-2c815f20aa12_NA_NA",
          "QueryOperator": 0,
          "FilterValue": "DK"
        }
      ],
      "BooleanOperator": 0,
      "QueryModelType": "SimpleQueryModel"
    },
    {
      "Filters": [
        {
          "FieldUid": "ddf07a35-7aa5-4dec-baed-f33863be2fb8_NA_1",
          "QueryOperator": 0,
          "FilterValue": "red"
        }
      ],
      "BooleanOperator": 1,
      "QueryModelType": "SimpleQueryModel"
    }
  ],
  "BooleanOperator": 0,
  "QueryModelType": "BooleanQueryModel"
}

[
  "057360a4-1132-4ca3-b889-5063daacdad7",
  "41ce0d1d-4ed4-4591-b7db-fb04688fcc6e",
  "027194d1-d94d-4dff-807c-9ec26ae8d342"
]

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Uid of global list to search
model	body	object : QueryModel	Query model

QueryModel

This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type

SimpleQueryModel

Simple query model used for querying specific fields

Property name

Data type

Description

Filters

array : FieldFilterModel

List of filter conditions

BooleanOperator

string

The operator of the query. Can be any of:

And / 0 (All conditions must match)
Or / 1 (At least one of the provided conditions must match)

QueryModelType

string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel

Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries

Property name

Data type

Description

SubQueries

array : QueryModel

Sub queries to execute

BooleanOperator

string

The operator of the query. Can be any of:

And / 0 (All conditions must match)
Or / 1 (At least one of the provided conditions must match)

QueryModelType

string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel

Property name

Data type

Description

FieldUid

string

Uid of field to query

QueryOperator

string

Operator to use for query. Can be any of:

Equals / 0 (Value must start with FilterValue)
WildcardEquals / 1 (Value must be smaller than FilterValue)
SmallerThan / 2 (Value must be smaller than FilterValue)
LargerThan / 3 (Value must be larger than FilterValue)
IsEmpty / 4 (Value must be empty)
IsNotEmpty / 5 (Value must not be empty)
Contains / 6 (Value must contain FilterValue)
NotContains / 7 (Value must not contain FilterValue)
NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
NotWildcardEquals / 9 (Value must not start with FilterValue)
InList / 10 (Item field value must match any of the in provided values in FilterList)

FilterValue

object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for

Response status OK (200)

array : string

DELETE /GlobalLists/values Delete a range of global list values

Request parameters

Property name	Parameter type	Data type	Description
valueUids	body	array : string	Unique ids of values to delete

Response status OK (200)

No body message is returned

GET /GlobalLists/values/{uid} Get a global list value

{
  "Uid": "895d3a9f-921b-4276-9e5a-d85b53329fb8",
  "SortOrder": 1,
  "Value": {
    "Name": [
      {
        "CultureCode": "en-GB",
        "Data": "Blue"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Blå"
      }
    ],
    "HEXColor": "0000FF"
  }
}

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of global list value

Response status OK (200)

object : GlobalListValue

GlobalListValue

Property name

Data type

Description

Uid

string

Unique id of global list value

SortOrder

integer

Sort order of this value compared to other values in the same global list

Value

object

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

The table below shows how different attributes translates to this value model.

Attribute type	data type
Text attribute	string
Number attribute	decimal
Boolean attribute	bool
Fixedlist attribute	value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute	string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute	DateTimeOffset
Category attribute	int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute	int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute	int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute	uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute	string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute	object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute	value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)

GET /GlobalLists/values/{uid}/references Get references to a global list value

#Available from v.3.5.0

{
  "GlobalListValueUid": "2f6ca74a-694c-44ce-9dad-1e426dff31f6",
  "ReferencingCategories": [
    {
      "EntityId": 100,
      "AttributeUid": "1d45749a-5094-49c6-b815-abe2718da28f"
    },
    {
      "EntityId": 101,
      "AttributeUid": "1d45749a-5094-49c6-b815-abe2718da28f"
    }
  ],
  "ReferencingProducts": [
    {
      "EntityId": 100010,
      "AttributeUid": "e630d59c-9cc5-4427-8341-a1c3d19b7a14"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "e630d59c-9cc5-4427-8341-a1c3d19b7a14"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "8f9501fb-3b43-412d-8ffa-e4c0be764a0a"
    }
  ],
  "ReferencingVariantGroups": [],
  "ReferencingVariants": [
    {
      "EntityId": 100,
      "AttributeUid": "e630d59c-9cc5-4427-8341-a1c3d19b7a14"
    }
  ],
  "ReferencingGlobalListValues": [
    "6719048a-d4b2-4a49-9cbc-059c20e129f9",
    "88cc901a-def7-42c1-8212-4ec4ce7fa888"
  ]
}

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of global list value

Response status OK (200)

object : GlobalListValueReferences

GlobalListValueReferences

Property name	Data type	Description
GlobalListValueUid	string	Uid of the referenced global list value
ReferencingCategories	array : EntityReferenceDetail	List of categories referencing this global list value
ReferencingProducts	array : EntityReferenceDetail	List of products referencing this global list value
ReferencingVariantGroups	array : EntityReferenceDetail	List of variant groups referencing this global list value
ReferencingVariants	array : EntityReferenceDetail	List of variants referencing this global list value
ReferencingGlobalListValues	array	List of other global list values referencing this global list value

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 /GlobalLists/values/batch Get a batch of global list values

No more than 5000 values can be requested at a time.

{
  "Total": 201,
  "Remaining": 199,
  "LastId": "7e4f1b80-00b0-472e-b42c-085536eac506",
  "GlobalListValues": [
    {
      "Uid": "a366afe8-511c-49c6-b902-46ae67871f68",
      "SortOrder": 1,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Blue"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Blå"
          }
        ],
        "HEXColor": "0000FF"
      }
    },
    {
      "Uid": "8b840ffe-2cb2-478c-ac77-ba11d01a68ef",
      "SortOrder": 2,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Green"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Grøn"
          }
        ],
        "HEXColor": "00FF00"
      }
    },
    {
      "Uid": "7e4f1b80-00b0-472e-b42c-085536eac506",
      "SortOrder": 2,
      "Value": {
        "Name": [
          {
            "CultureCode": "en-GB",
            "Data": "Red"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Rød"
          }
        ],
        "HEXColor": "FF0000"
      }
    }
  ]
}

Request parameters

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

Response status OK (200)

array : GlobalListValue

GlobalListValue

Property name

Data type

Description

Uid

string

Unique id of global list value

SortOrder

integer

Sort order of this value compared to other values in the same global list

Value

object

The value dynamic value model. The data type of this model depends on the Global list attribute setup. If the global list attribute is a Text attribute, this value will be a string If it is a Number attribute, this value will be a decimal and so on.

The table below shows how different attributes translates to this value model.

Attribute type	data type
Text attribute	string
Number attribute	decimal
Boolean attribute	bool
Fixedlist attribute	value/value[] (depending on whether attribute allows selecting multiple global list values). The datatype of this value model depends on the underlying attribute for the global list of the refernced global list value(s)
Media attribute	string/string[] (depending on whether attribute allows selecting multiple medias)
Datetime attribute	DateTimeOffset
Category attribute	int/int[] (depending on whether attribute allows selecting multiple categories)
Product attribute	int/int[] (depending on whether attribute allows selecting multiple products)
Variant attribute	int/int[] (depending on whether attribute allows selecting multiple variants)
Collection attribute	uuid/uuid[] (depending on whether attribute allows selecting multiple collections)
Attribute attribute	string/string[] (depending on whether attribute allows selecting multiple attributes)
Complex attribute	object (Each property of the object corresponds to each sub attribute of the complex attribute. The value of each property then corresponds to the data type of that sub attribute)
List attribute	value[] (Each value in the array represents each row in the list. The model of each row corresponds to the datatype of the row template set up on the list attribute)

POST /GlobalLists/values/batch/references Get references to a batch of global list values

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

[
  {
    "GlobalListValueUid": "f87eaa09-cdc2-4dfc-bdfb-c67cb35fdd8e",
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "de74bac8-a25e-4e66-b490-cd74e4f23739"
      },
      {
        "EntityId": 101,
        "AttributeUid": "de74bac8-a25e-4e66-b490-cd74e4f23739"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 100010,
        "AttributeUid": "1c84f919-a84c-497f-9e47-acddee1bfc5e"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "1c84f919-a84c-497f-9e47-acddee1bfc5e"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "9e97d589-b47d-4a84-aed2-ce4e64813da0"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 100,
        "AttributeUid": "1c84f919-a84c-497f-9e47-acddee1bfc5e"
      }
    ],
    "ReferencingGlobalListValues": [
      "97ccf249-9f5b-4eff-b973-b73aafc97183",
      "eb7cae07-fa7c-45a9-958b-d32e3f1785c3"
    ]
  },
  {
    "GlobalListValueUid": "ab4f4119-6ceb-423f-b758-e73898da3169",
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "de74bac8-a25e-4e66-b490-cd74e4f23739"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 23553,
        "AttributeUid": "1c84f919-a84c-497f-9e47-acddee1bfc5e"
      },
      {
        "EntityId": 5656,
        "AttributeUid": "1c84f919-a84c-497f-9e47-acddee1bfc5e"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 568323,
        "AttributeUid": "9e97d589-b47d-4a84-aed2-ce4e64813da0"
      }
    ],
    "ReferencingGlobalListValues": [
      "bd026054-42a4-4e5e-a48a-4087954bff80",
      "121a8a26-75a7-480a-b559-77da141423b6"
    ]
  }
]

Request parameters

Property name	Parameter type	Data type	Description
uids	body	array : string	Unique ids of global list values

Response status OK (200)

array : GlobalListValueReferences

GlobalListValueReferences

Property name	Data type	Description
GlobalListValueUid	string	Uid of the referenced global list value
ReferencingCategories	array : EntityReferenceDetail	List of categories referencing this global list value
ReferencingProducts	array : EntityReferenceDetail	List of products referencing this global list value
ReferencingVariantGroups	array : EntityReferenceDetail	List of variant groups referencing this global list value
ReferencingVariants	array : EntityReferenceDetail	List of variants referencing this global list value
ReferencingGlobalListValues	array	List of other global list values referencing this global list value

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

# GlobalLists

GET /GlobalLists Get all global lists created in the system

Response status OK (200)

PUT /GlobalLists Update a global list

Request parameters

Response status OK (200)

POST /GlobalLists Create a new global list

Request parameters

Response status OK (200)

DELETE /GlobalLists Delete a global list

Request parameters

Response status OK (200)

GET /GlobalLists/{uid} Get a specific global list

Request parameters

Response status OK (200)

GET /GlobalLists/{uid}/values Get values for a specific global list

Request parameters

Response status OK (200)

PUT /GlobalLists/{uid}/values Update values in a global list

Request parameters

Response status OK (200)

POST /GlobalLists/{uid}/values Create values in a global list

Request parameters

Response status OK (200)

POST /GlobalLists/batch Get a batch of global lists

Request parameters

Response status OK (200)

GET /GlobalLists/ByAlias/{alias} Get a specific global list by its alias

Request parameters

Response status OK (200)

POST /GlobalLists/ByAlias/batch Get a batch of global lists by their aliases

Request parameters

Response status OK (200)

GET /GlobalLists/folders Get all global list folders in the system

Response status OK (200)

PUT /GlobalLists/folders Update existing global list folder

Request parameters

Response status OK (200)

POST /GlobalLists/folders Create new global list folder

Request parameters

Response status OK (200)

DELETE /GlobalLists/folders Deletes the global list folder with the specified uid

Request parameters

Response status OK (200)

GET /GlobalLists/folders/{uid} Get a specific global list folder

Request parameters

Response status OK (200)

GET /GlobalLists/queryablefields/{uid} Get available query fields for a specific global list

Request parameters

Response status OK (200)

POST /GlobalLists/search/{uid} Get uids of global list values matching certain criteria

Request parameters

Response status OK (200)

DELETE /GlobalLists/values Delete a range of global list values

Request parameters

Response status OK (200)

GET /GlobalLists/values/{uid} Get a global list value

Request parameters

Response status OK (200)

GET /GlobalLists/values/{uid}/references Get references to a global list value

Request parameters

Response status OK (200)

POST /GlobalLists/values/batch Get a batch of global list values

Request parameters

Response status OK (200)

POST /GlobalLists/values/batch/references Get references to a batch of global list values

Request parameters

Response status OK (200)