Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Integrate with Struct PIM
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints

GlobalLists

PreviousEnrichmentInsightSetupsNextLanguages

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.

Delete a global list

delete
Authorizations
Query parameters
uidstring · uuidOptional

the Unique id of the global list

Responses
200
OK
delete
DELETE /v1/GlobalLists HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content

Get a specific global list

get
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of global list

Responses
200
OK
get
GET /v1/GlobalLists/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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
  ]
}

Get a specific global list by its alias

get
Authorizations
Path parameters
aliasstringRequired

Alias of the global list to return

Responses
200
OK
get
GET /v1/GlobalLists/ByAlias/{alias} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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
  ]
}

Get all global list folders in the system

get
Authorizations
Responses
200
OK
get
GET /v1/GlobalLists/folders HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text"
  }
]

Deletes the global list folder with the specified uid

delete
Authorizations
Query parameters
uidstring · uuidOptional

Uid of folder to delete

Responses
200
OK
delete
DELETE /v1/GlobalLists/folders HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content

Get a specific global list folder

get
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of folder

Responses
200
OK
get
GET /v1/GlobalLists/folders/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text"
}

Get values for a specific global list

get
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of global list to get values for

Query parameters
limitinteger · int32Optional

Max number of items to return

Default: 1000000
afterIdstring · uuidOptional

Only get values sorted after this id

Responses
200
OK
get
GET /v1/GlobalLists/{uid}/values HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Total": 1,
  "Remaining": 1,
  "LastId": "123e4567-e89b-12d3-a456-426614174000",
  "GlobalListValues": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "SortOrder": 1,
      "Value": null
    }
  ]
}

Get a global list value

get
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of global list value

Responses
200
OK
400
Bad Request
get
GET /v1/GlobalLists/values/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "SortOrder": 1,
  "Value": null
}

Get references to a global list value

get

#Available from v.3.5.0

Authorizations
Path parameters
uidstring · uuidRequired

Unique id of global list value

Responses
200
OK
get
GET /v1/GlobalLists/values/{uid}/references HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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"
  ]
}

Get available query fields for a specific global list

get
Authorizations
Path parameters
uidstring · uuidRequired

Uid of global list

Responses
200
OK
get
GET /v1/GlobalLists/queryablefields/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "text",
    "Name": "text",
    "SupportsSorting": true
  }
]
  • GETGet all global lists created in the system
  • POSTCreate a new global list
  • PUTUpdate a global list
  • DELETEDelete a global list
  • GETGet a specific global list
  • GETGet a specific global list by its alias
  • POSTGet a batch of global lists by their aliases
  • POSTGet a batch of global lists
  • GETGet all global list folders in the system
  • POSTCreate new global list folder
  • PUTUpdate existing global list folder
  • DELETEDeletes the global list folder with the specified uid
  • GETGet a specific global list folder
  • GETGet values for a specific global list
  • POSTCreate values in a global list
  • GETGet a global list value
  • GETGet references to a global list value
  • POSTGet references to a batch of global list values
  • POSTGet a batch of global list values
  • PUTUpdate values in a global list
  • DELETEDelete a range of global list values
  • POSTGet uids of global list values matching certain criteria
  • GETGet available query fields for a specific global list

Get all global lists created in the system

get
Authorizations
Responses
200
OK
get
GET /v1/GlobalLists HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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
    ]
  }
]

Create a new global list

post
Authorizations
Body

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid | nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid | nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid | nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid | nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid | nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] | nullableOptional

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)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

Responses
201
Created
400
Bad Request
post
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
  ]
}

Update a global list

put
Authorizations
Body

Global list represents a global collection of reusable objects

Idinteger · int32Optional

Id of global list (readonly)

Uidstring · uuidOptional

Unique id of global list

ViewRequiresPermissionbooleanOptional

Indicates whether a special permission is required to view the global list

ViewPermissionstring · uuid | nullableOptional

Permission required to view the global list, if ViewRequiresPermission is set

CreateRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to create values in the global list

EditRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to update values in the global list

DeleteRequiresPermissionbooleanOptional

Indicates whether a special permission is required in order to delete values in the global list

CreatePermissionstring · uuid | nullableOptional

Permission required to create values in the global list, if CreateRequiresPermission is set

EditPermissionstring · uuid | nullableOptional

Permission required to update values in the global list, if EditRequiresPermission is set

DeletePermissionstring · uuid | nullableOptional

Permission required to delete values in the global list, if DeleteRequiresPermission is set

FolderUidstring · uuid | nullableOptional

Uid of folder to place global list in

RequiresSortingbooleanOptional

Defines if values on a global list values should be sorted on creation

GlobalListKeysstring[] | nullableOptional

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)

KeyIsCaseInsensitivebooleanOptional

Defines if key value for a global list value is case insensitive

Responses
200
OK
put
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
  ]
}
200

OK

No content

Get a batch of global lists by their aliases

post
Authorizations
Body
string[]Optional
Responses
200
OK
post
POST /v1/GlobalLists/ByAlias/batch HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 8

[
  "text"
]
200

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
    ]
  }
]

Get a batch of global lists

post
Authorizations
Body
string · uuid[]Optional
Responses
200
OK
post
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"
]
200

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
    ]
  }
]

Create new global list folder

post
Authorizations
Body

Folder holding global lists

Uidstring · uuidOptional

Unique id of folder

Namestring | nullableOptional

Presented name of folder in backoffice

Responses
200
OK
400
Bad Request
post
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"
}

Update existing global list folder

put
Authorizations
Body

Folder holding global lists

Uidstring · uuidOptional

Unique id of folder

Namestring | nullableOptional

Presented name of folder in backoffice

Responses
200
OK
400
Bad Request
put
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

Create values in a global list

post
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of global list to create values in

Body

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.

Uidstring · uuidOptional

Unique id of global list value

SortOrderinteger · int32 | nullableOptional

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

Valueany | nullableOptional

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.

Responses
200
OK
post
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
  }
]
200

OK

No content

Get references to a batch of global list values

post

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

Authorizations
Body
string · uuid[]Optional
Responses
200
OK
post
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"
]
200

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"
  ]
}

Get a batch of global list values

post

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

Authorizations
Body
string · uuid[]Optional
Responses
200
OK
400
Bad Request
post
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
}

Update values in a global list

put
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of global list to update values in

Body

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.

Uidstring · uuidOptional

Unique id of global list value

SortOrderinteger · int32 | nullableOptional

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

Valueany | nullableOptional

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.

Responses
200
OK
put
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
  }
]
200

OK

No content

Delete a range of global list values

delete
Authorizations
Body
string · uuid[]Optional
Responses
200
OK
delete
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"
]
200

OK

No content

Get uids of global list values matching certain criteria

post
Authorizations
Path parameters
uidstring · uuidRequired

Uid of global list to search

Body

Definition of general query model

BooleanOperatorinteger · enumOptional

Boolean operator

Possible values:
QueryModelTypestring | nullableRead-onlyOptional

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

Responses
200
OK
Responsestring · uuid[]
post
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
}
200

OK

[
  "123e4567-e89b-12d3-a456-426614174000"
]