Catalogues
Catalogues are root elements in category structures used for organizing products logically. A master catalogue allows setting up attributes on categories that are then available on products in those categories. Different catalogues can be used for different assortments, category structures etc.
Authorizations
AuthorizationstringRequired
Responses
200
OK
application/json
string · uuid[]Optional
get/v1/catalogues/uids
GET /v1/catalogues/uids HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200
OK
[
"c3c936cd-aca8-415d-811f-770c96610e3c",
"85253051-2a1c-44e6-abfb-d05689494d76",
"36d93cb3-ed25-47e3-bb49-1d742cec8d89"
]Authorizations
AuthorizationstringRequired
Responses
200
OK
application/json
Represents a catalogue in the PIM system
Uidstring · uuidOptional
Unique id of catalogue
Aliasstring · nullableOptional
Unique human readable alias for the catalogue
Labelstring · nullableOptional
Label of catalogue displayed in the backoffice
IsMasterbooleanOptional
Indicates whether this catalogue is the master catalogue (only one master catalogue can exist in the system)
SortOrderinteger · int32Optional
Sort order of the catalogue compared to other catalogues
BusinessUnitsstring · uuid[] · nullableOptional
This business units this catalogue is associated with
400
Bad Request
application/json
get/v1/catalogues
GET /v1/catalogues HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
[
{
"Uid": "1251f3c5-3239-4cbb-8fb2-0c93eded9f71",
"Alias": "MasterCatalogue",
"Label": "Master catalogue",
"IsMaster": true,
"SortOrder": 1,
"IdentifierDefinitions": [
{
"Uid": "4e1600a1-47cc-4bae-8ba7-c31db7eb0783",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"af91835f-3d68-440a-a22c-2d54071b9c21"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"d0487142-1a1a-4924-bd5a-2f76c7edb4fa"
]
},
"CreateWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "",
"Properties": [
{
"AttributeUid": "d0487142-1a1a-4924-bd5a-2f76c7edb4fa",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "99acd0fe-2283-4df4-b809-660c40270f8f",
"ViewPermission": "d7b36334-0274-4b0c-87a8-dfe47edc1edd",
"SavePermission": "06e958b3-a075-4524-9597-35284ce472d7",
"Type": "AttributeSetup"
},
{
"AttributeUid": "5271cdfb-7cf3-44c9-b549-5082ab4cf11a",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "4fc780e5-4ff8-4c3d-84bc-17a92b115fee",
"ViewPermission": "9dce2c30-f4c4-4b01-af9e-63e2ab4fbb34",
"SavePermission": "779129b1-7c62-4aa9-9812-144a822cab67",
"Type": "AttributeSetup"
},
{
"AttributeUid": "22e7513e-ad21-4b67-adca-73ee1fc01a3e",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "c0eb31f6-df0b-4195-8c43-8e47355fd1df",
"ViewPermission": "1419e4d1-c8b0-404e-91ca-9f26e7d2c5b3",
"SavePermission": "aeff6199-3b2a-4401-884e-8bb8821ce734",
"Type": "AttributeSetup"
}
],
"Uid": "61cde82f-c7f8-4062-9002-7b21393b99cf",
"ViewPermission": "48d5b267-13d6-4b3d-afee-99c000259418",
"SavePermission": "40fe6949-e259-41ee-91bf-4ebc42751ede",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "852b67c1-249b-4ffe-a9d6-865b9852a69c",
"ViewPermission": "e02af78e-c33c-4546-a2a6-d0e7d47d70c4",
"SavePermission": "de7e143a-9c88-4e7c-b629-58380f1f6066",
"Type": "DynamicTabSetup"
}
]
},
"BusinessUnits": []
},
{
"Uid": "57834d74-a1fd-4b27-9c1d-bd9d6cdfed7b",
"Alias": "USSalesCatalogue",
"Label": "Sales catalogue (US)",
"IsMaster": true,
"SortOrder": 2,
"IdentifierDefinitions": [
{
"Uid": "a2941734-9b1c-42bf-9f46-298038f0fbbd",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"f7a777d5-1fc7-4554-a7e5-e2b58578dcf2"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"d0487142-1a1a-4924-bd5a-2f76c7edb4fa"
]
},
"CreateWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "",
"Properties": [
{
"AttributeUid": "d0487142-1a1a-4924-bd5a-2f76c7edb4fa",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "d86faa19-86bc-4064-87c9-8a0185880ed8",
"ViewPermission": "c32e1e94-b154-4fec-b402-3e5e1bcb079d",
"SavePermission": "b6125bbb-252f-462b-b693-f4db7fb0cdcd",
"Type": "AttributeSetup"
}
],
"Uid": "b9055ed5-0713-4e5f-a079-cf21e54adf82",
"ViewPermission": "72940a38-8424-438e-88b8-c5d98add1e33",
"SavePermission": "6a1abd2d-c173-431f-8dd5-7c85db579679",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "20f94b51-d9bf-45a8-a488-238c9f5dcef7",
"ViewPermission": "7bafed49-8353-45af-9158-b238c047b90f",
"SavePermission": "7dddbce5-c4ca-4e84-9b5b-cc827a30a62a",
"Type": "DynamicTabSetup"
}
]
},
"BusinessUnits": []
}
]#Available from v.3.3.0
Authorizations
AuthorizationstringRequired
Body
Represents a catalogue in the PIM system
Uidstring · uuidOptional
Unique id of catalogue
Aliasstring · nullableOptional
Unique human readable alias for the catalogue
Labelstring · nullableOptional
Label of catalogue displayed in the backoffice
IsMasterbooleanOptional
Indicates whether this catalogue is the master catalogue (only one master catalogue can exist in the system)
SortOrderinteger · int32Optional
Sort order of the catalogue compared to other catalogues
BusinessUnitsstring · uuid[] · nullableOptional
This business units this catalogue is associated with
Responses
200
OK
No content
400
Bad Request
application/json
post/v1/catalogues
POST /v1/catalogues HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1891
{
"Uid": "4b697954-ba5c-41aa-83b6-9ac830013036",
"Alias": "MasterCatalogue",
"Label": "Master catalogue",
"IsMaster": true,
"SortOrder": 1,
"IdentifierDefinitions": [
{
"Uid": "16476566-8019-4ea8-84ee-39e536a1aa45",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"1fcf9b01-cff2-47c0-b735-d5d4e43a506a"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"bbe0d112-70a7-4fca-a1eb-a6970686630c"
]
},
"CreateWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "",
"Properties": [
{
"AttributeUid": "bbe0d112-70a7-4fca-a1eb-a6970686630c",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "9d6e0cc7-5ae7-454e-b934-bc47a7e6b2c3",
"ViewPermission": "e52fdebd-9bb7-484d-ad15-895ea49bad3b",
"SavePermission": "29c9a71e-f907-4e63-9a18-8941ed6b724a",
"Type": "AttributeSetup"
},
{
"AttributeUid": "c08d382f-571e-49c2-ba8e-ece9613df356",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "80b5eb07-67da-4f99-a197-9a584b7c04b5",
"ViewPermission": "d0f5af30-2c6a-45d5-978d-0fcd42c3b7c8",
"SavePermission": "86dd9006-44de-4462-8fdb-65ab5acc3021",
"Type": "AttributeSetup"
},
{
"AttributeUid": "c7420232-5d5f-4ada-b87c-0830145e602a",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "cf9ff80b-aeab-4201-b633-87610757e18b",
"ViewPermission": "83e839fa-6ab0-4528-a75d-000eac0c66bd",
"SavePermission": "0589a670-e0d3-45c3-aab3-336dc41015f5",
"Type": "AttributeSetup"
}
],
"Uid": "d6a99d10-40e0-4aeb-9d80-b579c17350df",
"ViewPermission": "2a14b8f8-dbce-4fb5-a39f-91e2c5dbaf89",
"SavePermission": "ba0a22bd-9587-4129-90e1-9d871c7e8e87",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "055ca1db-abf8-46b4-981f-98de600a2cf6",
"ViewPermission": "13246cae-4151-431c-b398-97e3a4601dc0",
"SavePermission": "b3db2311-4b36-426c-8fa5-03f6656b66a8",
"Type": "DynamicTabSetup"
}
]
},
"BusinessUnits": []
}No content
delete
Authorizations
AuthorizationstringRequired
Query parameters
catalogueUidstring · uuidOptional
Responses
200
OK
No content
delete/v1/catalogues
DELETE /v1/catalogues HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200
OK
No content
#Available from v.3.3.0
Authorizations
AuthorizationstringRequired
Body
Represents a catalogue in the PIM system
Uidstring · uuidOptional
Unique id of catalogue
Aliasstring · nullableOptional
Unique human readable alias for the catalogue
Labelstring · nullableOptional
Label of catalogue displayed in the backoffice
IsMasterbooleanOptional
Indicates whether this catalogue is the master catalogue (only one master catalogue can exist in the system)
SortOrderinteger · int32Optional
Sort order of the catalogue compared to other catalogues
BusinessUnitsstring · uuid[] · nullableOptional
This business units this catalogue is associated with
Responses
200
OK
No content
400
Bad Request
application/json
patch/v1/catalogues
PATCH /v1/catalogues HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1891
{
"Uid": "0252a368-1d13-4a6f-83e7-d625eb653644",
"Alias": "MasterCatalogue",
"Label": "Master catalogue",
"IsMaster": true,
"SortOrder": 1,
"IdentifierDefinitions": [
{
"Uid": "dc69e714-8b30-4a76-a338-352f961093da",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"4fb46073-2b4b-4d00-b3b5-ff6882542d9f"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"0831c89f-274b-4b4c-9b74-4be836940efa"
]
},
"CreateWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "",
"Properties": [
{
"AttributeUid": "0831c89f-274b-4b4c-9b74-4be836940efa",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "12ef08c9-46ff-45d9-ab04-b70f2e2a7366",
"ViewPermission": "9a491efb-5e73-4781-97ec-b6141ce81b04",
"SavePermission": "babbd6b7-be57-43f3-89f1-aabdd1230daa",
"Type": "AttributeSetup"
},
{
"AttributeUid": "55aa82bf-7c79-4f72-ae36-fac4736cf66c",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "7afe0ee2-4b10-41bc-b520-8e9f7a623239",
"ViewPermission": "1c1e8096-f84c-4704-b169-29030eac9ab9",
"SavePermission": "36e9f633-7faf-4c2a-9874-f57301b40efe",
"Type": "AttributeSetup"
},
{
"AttributeUid": "ee403b3a-3256-47a3-a7eb-0a6a525d8ddb",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "564ae9c6-a2db-49af-bc90-0d429fc8869d",
"ViewPermission": "efc6e2c1-4002-4882-ad90-e4e777121eff",
"SavePermission": "7ad97659-5d10-4bca-9ed6-4cd77c19f93b",
"Type": "AttributeSetup"
}
],
"Uid": "deade415-e5b1-4a7d-b2f3-f05ee894ddab",
"ViewPermission": "ed13c3ed-3db8-467b-adca-d9863b41e2c2",
"SavePermission": "304cd448-f8e8-4d61-9295-8e0460a2cc43",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "641e9f90-affd-490c-ba62-22bec419f1e3",
"ViewPermission": "a64f4ac5-779a-494c-be7d-e06d9aa31155",
"SavePermission": "9b4e2cd3-90de-46c1-8676-bba9d001fa64",
"Type": "DynamicTabSetup"
}
]
},
"BusinessUnits": []
}No content
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired
Unique id of catalogue
Responses
200
OK
application/json
Represents a catalogue in the PIM system
Uidstring · uuidOptional
Unique id of catalogue
Aliasstring · nullableOptional
Unique human readable alias for the catalogue
Labelstring · nullableOptional
Label of catalogue displayed in the backoffice
IsMasterbooleanOptional
Indicates whether this catalogue is the master catalogue (only one master catalogue can exist in the system)
SortOrderinteger · int32Optional
Sort order of the catalogue compared to other catalogues
BusinessUnitsstring · uuid[] · nullableOptional
This business units this catalogue is associated with
400
Bad Request
application/json
404
Not Found
application/json
get/v1/catalogues/{uid}
GET /v1/catalogues/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"Uid": "64581ded-ed96-4725-9ac2-5833de390961",
"Alias": "MasterCatalogue",
"Label": "Master catalogue",
"IsMaster": true,
"SortOrder": 1,
"IdentifierDefinitions": [
{
"Uid": "39a3794f-e581-4c8f-9f20-d8362b3068fa",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"259b20b9-7d91-4b23-843e-a751d75df6c3"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"14236bf8-e8f0-4262-8844-b1eb6ac276b3"
]
},
"CreateWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "",
"Properties": [
{
"AttributeUid": "14236bf8-e8f0-4262-8844-b1eb6ac276b3",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "30a27e5c-cad9-4a67-93a0-4c5118a6d696",
"ViewPermission": "6121c8cc-7ead-4e7c-b0dd-5cd988ecf99b",
"SavePermission": "b98c0a37-e0a7-46b9-b216-3a07facaac9e",
"Type": "AttributeSetup"
},
{
"AttributeUid": "4eadd593-9cae-4a5d-9e29-e267ad635f02",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "e2f4938e-535c-4dd7-b5a9-d34d6e3c4b3c",
"ViewPermission": "a2ec2724-1cb9-4827-8b43-ccf905974fb5",
"SavePermission": "42a951ab-ea84-4817-8eb5-250272e6f7ce",
"Type": "AttributeSetup"
},
{
"AttributeUid": "41e43d33-f4aa-47ad-8ec0-ff94c0865726",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "c9bc4774-b9c2-4e64-bcac-3ea32ee4d4a5",
"ViewPermission": "72b4e9e6-ffa9-4044-bc06-f9fc0747d5d0",
"SavePermission": "694af9ab-3ac0-4888-82bc-df1bd8d464ea",
"Type": "AttributeSetup"
}
],
"Uid": "9d4b4f44-226e-4547-8069-82f21605a0b2",
"ViewPermission": "c4633b15-29ae-4d57-a7e0-790b51209e43",
"SavePermission": "b67d349f-fa35-488c-bcd0-fe3d71cc2b8e",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "d7bca0ec-0598-4cc7-a226-6f402e9df553",
"ViewPermission": "f8e3ad9d-fd20-40d9-b099-de5411a90543",
"SavePermission": "a685e600-0354-4678-9578-9d525d21314f",
"Type": "DynamicTabSetup"
}
]
},
"BusinessUnits": []
}No more than 5000 categories can be requested at a time. If no limit is provided, the default limit of 1000 will be used
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired
Unique id of catalogue
Query parameters
limitinteger · int32OptionalDefault:
Max number of categories til return
1000afterIdinteger · int32Optional
Only return categories with id larger than this
Responses
200
OK
application/json
Result set of categories from a category query
Totalinteger · int32Optional
The total number of items
Remaininginteger · int32Optional
The remaining items that lie after the last id of the item in this result set
LastIdinteger · int32Optional
The id of the last item in this result set
400
Bad Request
application/json
get/v1/catalogues/{uid}/descendants
GET /v1/catalogues/{uid}/descendants HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"Categories": [
{
"Id": 10,
"ParentId": null,
"SortOrder": 1,
"CatalogueUid": "139cc834-3f44-4905-922f-db42de10cb57",
"Created": "2026-02-09T18:51:56.1557242+00:00",
"CreatedBy": "Struct admin",
"LastModified": "2026-04-20T18:51:56.1557253+00:00",
"LastModifiedBy": "Struct support",
"HasChildren": true,
"Name": {
"en-GB": "Electronics",
"da-DK": "Elektronik"
},
"Dynamic": false,
"QuerySetup": null,
"WorkflowStateUid": "8d090450-de6e-4188-9b19-f570e7dd82b0",
"BusinessUnits": []
},
{
"Id": 11,
"ParentId": null,
"SortOrder": 1,
"CatalogueUid": "139cc834-3f44-4905-922f-db42de10cb57",
"Created": "2026-02-19T18:51:56.1557264+00:00",
"CreatedBy": "Struct admin",
"LastModified": "2026-05-10T18:51:56.1557265+00:00",
"LastModifiedBy": "Struct support",
"HasChildren": true,
"Name": {
"en-GB": "Clothing",
"da-DK": "Tøj"
},
"Dynamic": false,
"QuerySetup": null,
"WorkflowStateUid": "b635a200-2374-48c5-8caa-48662c36aa06",
"BusinessUnits": []
}
],
"Total": 27,
"Remaining": 25,
"LastId": 11
}Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired
Unique id of catalogue
Responses
200
OK
application/json
Defines general information on a category
Idinteger · int32Optional
Id of category
ParentIdinteger · int32 · nullableOptional
Id of category's parent category. Null, if this category is placed in the root of its catalogue
SortOrderinteger · int32Optional
Sortorder of the category compared to other categories at the same level in the catalogue
CatalogueUidstring · uuidOptional
The unique id of the catalogue, this category resides in
Createdstring · date-timeOptional
Timestamp of the creation of category
CreatedBystring · nullableOptional
Username of user who created this category
LastModifiedstring · date-timeOptional
Timestamp of last modification of category
LastModifiedBystring · nullableOptional
Username of user who did the last modification
HasChildrenbooleanOptional
Indicates whether this category has any sub categories
DynamicbooleanOptional
Indicates whether this category is dynamic (classification handled by PIM)
WorkflowStateUidstring · uuid · nullableOptional
The uid of the workflow state of the category
get/v1/catalogues/{uid}/children
GET /v1/catalogues/{uid}/children HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200
OK
[
{
"Id": 10,
"ParentId": null,
"SortOrder": 1,
"CatalogueUid": "5f81bc23-77de-4fe5-a473-d7e5ce77894a",
"Created": "2026-02-09T18:51:56.1560823+00:00",
"CreatedBy": "Struct admin",
"LastModified": "2026-04-20T18:51:56.1560831+00:00",
"LastModifiedBy": "Struct support",
"HasChildren": true,
"Name": {
"en-GB": "Electronics",
"da-DK": "Elektronik"
},
"Dynamic": false,
"QuerySetup": null,
"WorkflowStateUid": "7ed57cc7-f11d-43ca-b763-de8fcbbfdc5e",
"BusinessUnits": []
},
{
"Id": 11,
"ParentId": null,
"SortOrder": 1,
"CatalogueUid": "5f81bc23-77de-4fe5-a473-d7e5ce77894a",
"Created": "2026-02-19T18:51:56.1560838+00:00",
"CreatedBy": "Struct admin",
"LastModified": "2026-05-10T18:51:56.1560840+00:00",
"LastModifiedBy": "Struct support",
"HasChildren": true,
"Name": {
"en-GB": "Clothing",
"da-DK": "Tøj"
},
"Dynamic": false,
"QuerySetup": null,
"WorkflowStateUid": "5c6c6e30-bb4b-4821-80ad-fbdf0bfd3f2d",
"BusinessUnits": []
}
]Last updated