GlobalLists
Global lists define reusable object structures that can be referenced on products, variants, categories or within global lists themselves. A global list uses an attribute to define the data model for values in the global list. Using Complex attributes as the data model allows for complex value models for each global list value object.
GET /v1/GlobalLists HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
[
{
"Id": 1,
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Attribute": {
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
},
"ViewRequiresPermission": true,
"ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
"CreateRequiresPermission": true,
"EditRequiresPermission": true,
"DeleteRequiresPermission": true,
"CreatePermission": "123e4567-e89b-12d3-a456-426614174000",
"EditPermission": "123e4567-e89b-12d3-a456-426614174000",
"DeletePermission": "123e4567-e89b-12d3-a456-426614174000",
"FolderUid": "123e4567-e89b-12d3-a456-426614174000",
"RequiresSorting": true,
"GlobalListKeys": [
"text"
],
"KeyIsCaseInsensitive": true,
"AvailableInApps": [
0
]
}
]
Global list represents a global collection of reusable objects
Id of global list (readonly)
Unique id of global list
Indicates whether a special permission is required to view the global list
Permission required to view the global list, if ViewRequiresPermission is set
Indicates whether a special permission is required in order to create values in the global list
Indicates whether a special permission is required in order to update values in the global list
Indicates whether a special permission is required in order to delete values in the global list
Permission required to create values in the global list, if CreateRequiresPermission is set
Permission required to update values in the global list, if EditRequiresPermission is set
Permission required to delete values in the global list, if DeleteRequiresPermission is set
Uid of folder to place global list in
Defines if values on a global list values should be sorted on creation
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)
Defines if key value for a global list value is case insensitive
POST /v1/GlobalLists HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1160
{
"Id": 1,
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Attribute": {
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"DisableRevisionLogging": true,
"DisableIndexing": true
},
"ViewRequiresPermission": true,
"ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
"CreateRequiresPermission": true,
"EditRequiresPermission": true,
"DeleteRequiresPermission": true,
"CreatePermission": "123e4567-e89b-12d3-a456-426614174000",
"EditPermission": "123e4567-e89b-12d3-a456-426614174000",
"DeletePermission": "123e4567-e89b-12d3-a456-426614174000",
"FolderUid": "123e4567-e89b-12d3-a456-426614174000",
"RequiresSorting": true,
"GlobalListKeys": [
"text"
],
"KeyIsCaseInsensitive": true,
"AvailableInApps": [
0
]
}
{
"Id": 1,
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Attribute": {
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
},
"ViewRequiresPermission": true,
"ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
"CreateRequiresPermission": true,
"EditRequiresPermission": true,
"DeleteRequiresPermission": true,
"CreatePermission": "123e4567-e89b-12d3-a456-426614174000",
"EditPermission": "123e4567-e89b-12d3-a456-426614174000",
"DeletePermission": "123e4567-e89b-12d3-a456-426614174000",
"FolderUid": "123e4567-e89b-12d3-a456-426614174000",
"RequiresSorting": true,
"GlobalListKeys": [
"text"
],
"KeyIsCaseInsensitive": true,
"AvailableInApps": [
0
]
}
Global list represents a global collection of reusable objects
Id of global list (readonly)
Unique id of global list
Indicates whether a special permission is required to view the global list
Permission required to view the global list, if ViewRequiresPermission is set
Indicates whether a special permission is required in order to create values in the global list
Indicates whether a special permission is required in order to update values in the global list
Indicates whether a special permission is required in order to delete values in the global list
Permission required to create values in the global list, if CreateRequiresPermission is set
Permission required to update values in the global list, if EditRequiresPermission is set
Permission required to delete values in the global list, if DeleteRequiresPermission is set
Uid of folder to place global list in
Defines if values on a global list values should be sorted on creation
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)
Defines if key value for a global list value is case insensitive
PUT /v1/GlobalLists HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1160
{
"Id": 1,
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Attribute": {
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"DisableRevisionLogging": true,
"DisableIndexing": true
},
"ViewRequiresPermission": true,
"ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
"CreateRequiresPermission": true,
"EditRequiresPermission": true,
"DeleteRequiresPermission": true,
"CreatePermission": "123e4567-e89b-12d3-a456-426614174000",
"EditPermission": "123e4567-e89b-12d3-a456-426614174000",
"DeletePermission": "123e4567-e89b-12d3-a456-426614174000",
"FolderUid": "123e4567-e89b-12d3-a456-426614174000",
"RequiresSorting": true,
"GlobalListKeys": [
"text"
],
"KeyIsCaseInsensitive": true,
"AvailableInApps": [
0
]
}
OK
No content
Unique id of global list
GET /v1/GlobalLists/{uid} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
{
"Id": 1,
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Attribute": {
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
},
"ViewRequiresPermission": true,
"ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
"CreateRequiresPermission": true,
"EditRequiresPermission": true,
"DeleteRequiresPermission": true,
"CreatePermission": "123e4567-e89b-12d3-a456-426614174000",
"EditPermission": "123e4567-e89b-12d3-a456-426614174000",
"DeletePermission": "123e4567-e89b-12d3-a456-426614174000",
"FolderUid": "123e4567-e89b-12d3-a456-426614174000",
"RequiresSorting": true,
"GlobalListKeys": [
"text"
],
"KeyIsCaseInsensitive": true,
"AvailableInApps": [
0
]
}
Alias of the global list to return
GET /v1/GlobalLists/ByAlias/{alias} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
{
"Id": 1,
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Attribute": {
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
},
"ViewRequiresPermission": true,
"ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
"CreateRequiresPermission": true,
"EditRequiresPermission": true,
"DeleteRequiresPermission": true,
"CreatePermission": "123e4567-e89b-12d3-a456-426614174000",
"EditPermission": "123e4567-e89b-12d3-a456-426614174000",
"DeletePermission": "123e4567-e89b-12d3-a456-426614174000",
"FolderUid": "123e4567-e89b-12d3-a456-426614174000",
"RequiresSorting": true,
"GlobalListKeys": [
"text"
],
"KeyIsCaseInsensitive": true,
"AvailableInApps": [
0
]
}
POST /v1/GlobalLists/ByAlias/batch HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 8
[
"text"
]
OK
[
{
"Id": 1,
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Attribute": {
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
},
"ViewRequiresPermission": true,
"ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
"CreateRequiresPermission": true,
"EditRequiresPermission": true,
"DeleteRequiresPermission": true,
"CreatePermission": "123e4567-e89b-12d3-a456-426614174000",
"EditPermission": "123e4567-e89b-12d3-a456-426614174000",
"DeletePermission": "123e4567-e89b-12d3-a456-426614174000",
"FolderUid": "123e4567-e89b-12d3-a456-426614174000",
"RequiresSorting": true,
"GlobalListKeys": [
"text"
],
"KeyIsCaseInsensitive": true,
"AvailableInApps": [
0
]
}
]
POST /v1/GlobalLists/batch HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 40
[
"123e4567-e89b-12d3-a456-426614174000"
]
OK
[
{
"Id": 1,
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Attribute": {
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text",
"BackofficeName": "text",
"BackofficeDescription": "text",
"Name": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Description": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"AttributeGroupUid": "123e4567-e89b-12d3-a456-426614174000",
"AttributeScopes": [
"123e4567-e89b-12d3-a456-426614174000"
],
"Localized": true,
"FallbackLanguage": 1,
"DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
"FallbackSegment": "123e4567-e89b-12d3-a456-426614174000",
"ReadOnly": true,
"Mandatory": true,
"Columns": 1,
"Unchangeable": true,
"AttributeType": "text",
"DisableRevisionLogging": true,
"DisableIndexing": true
},
"ViewRequiresPermission": true,
"ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
"CreateRequiresPermission": true,
"EditRequiresPermission": true,
"DeleteRequiresPermission": true,
"CreatePermission": "123e4567-e89b-12d3-a456-426614174000",
"EditPermission": "123e4567-e89b-12d3-a456-426614174000",
"DeletePermission": "123e4567-e89b-12d3-a456-426614174000",
"FolderUid": "123e4567-e89b-12d3-a456-426614174000",
"RequiresSorting": true,
"GlobalListKeys": [
"text"
],
"KeyIsCaseInsensitive": true,
"AvailableInApps": [
0
]
}
]
Folder holding global lists
Unique id of folder
Presented name of folder in backoffice
POST /v1/GlobalLists/folders HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 60
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
Folder holding global lists
Unique id of folder
Presented name of folder in backoffice
PUT /v1/GlobalLists/folders HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 60
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text"
}
No content
Unique id of global list to get values for
Max number of items to return
1000000
Only get values sorted after this id
GET /v1/GlobalLists/{uid}/values HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
{
"Total": 1,
"Remaining": 1,
"LastId": "123e4567-e89b-12d3-a456-426614174000",
"GlobalListValues": [
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"SortOrder": 1,
"Value": null
}
]
}
Unique id of global list to create values in
Global list value object representing data on a specific object in a global list. The data type of the value property differs depending on the underlying attribute on the global list of this value.
Unique id of global list value
Sort order of this value compared to other values in the same global list
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.
POST /v1/GlobalLists/{uid}/values HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 75
[
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"SortOrder": 1,
"Value": null
}
]
OK
No content
Unique id of global list value
GET /v1/GlobalLists/values/{uid} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"SortOrder": 1,
"Value": null
}
#Available from v.3.5.0
Unique id of global list value
GET /v1/GlobalLists/values/{uid}/references HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
{
"GlobalListValueUid": "123e4567-e89b-12d3-a456-426614174000",
"ReferencingCategories": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingProducts": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingVariantGroups": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingVariants": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingGlobalListValues": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
#Available from v.3.5.0 No more than 5000 values can be requested at a time.
POST /v1/GlobalLists/values/batch/references HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 40
[
"123e4567-e89b-12d3-a456-426614174000"
]
OK
{
"GlobalListValueUid": "123e4567-e89b-12d3-a456-426614174000",
"ReferencingCategories": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingProducts": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingVariantGroups": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingVariants": [
{
"EntityId": 1,
"AttributeUid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ReferencingGlobalListValues": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
No more than 5000 values can be requested at a time.
POST /v1/GlobalLists/values/batch HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 40
[
"123e4567-e89b-12d3-a456-426614174000"
]
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"SortOrder": 1,
"Value": null
}
Unique id of global list to update values in
Global list value object representing data on a specific object in a global list. The data type of the value property differs depending on the underlying attribute on the global list of this value.
Unique id of global list value
Sort order of this value compared to other values in the same global list
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.
PUT /v1/GlobalLists/{Uid}/values HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 75
[
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"SortOrder": 1,
"Value": null
}
]
OK
No content
DELETE /v1/GlobalLists/values HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 40
[
"123e4567-e89b-12d3-a456-426614174000"
]
OK
No content
Uid of global list to search
Definition of general query model
Boolean operator
The type of query model. Name matches exact name of concrete model implementation
POST /v1/GlobalLists/search/{uid} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 21
{
"BooleanOperator": 0
}
OK
[
"123e4567-e89b-12d3-a456-426614174000"
]
Uid of global list
GET /v1/GlobalLists/queryablefields/{uid} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
OK
[
{
"Uid": "text",
"Name": "text",
"SupportsSorting": true
}
]