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.

Get Uids of all catalogues in the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

Responsestring · uuid[]

get

/v1/catalogues/uids

HTTPcURLJavaScriptPython

GET /v1/catalogues/uids HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  "20d19fd6-2f44-48e5-99f0-63b38bdd1a4f",
  "074ab54f-2e1e-407e-ba5e-5488c6a90668",
  "69a9283f-9509-457a-aabb-988e668f911c"
]

Get all catalogues in the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/catalogues

HTTPcURLJavaScriptPython

GET /v1/catalogues HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Uid": "dee61e1e-2611-436f-a598-7316138438ec",
    "Alias": "MasterCatalogue",
    "Label": "Master catalogue",
    "IsMaster": true,
    "SortOrder": 1,
    "IdentifierDefinitions": [
      {
        "Uid": "8703bcba-d6cf-40bd-aaff-5a219740ca7c",
        "Alias": "ERPRef",
        "IdentifierPattern": "{0}",
        "IdentifierAttributes": [
          "4e41d7e3-6c60-4fa7-b752-b77b86dd279f"
        ]
      }
    ],
    "Configuration": {
      "NameConfiguration": {
        "NamePattern": "{0}",
        "NameAttributes": [
          "b5ffa961-d846-4adf-8161-f692469d7513"
        ]
      },
      "CreateWizard": null,
      "Tabs": [
        {
          "Label": "General",
          "Sections": [
            {
              "Headline": "Basic information",
              "Description": "",
              "Properties": [
                {
                  "AttributeUid": "b5ffa961-d846-4adf-8161-f692469d7513",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "25b330a3-19fb-42df-a8d8-54137940b72f",
                  "ViewPermission": "d72d5b00-14d5-412c-abab-c3b6605d9461",
                  "SavePermission": "f73c602b-b7ed-4a00-940c-07486f869510",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "f7584a33-f9c6-4df1-878f-6a876f18f1de",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "b33b2ff3-6504-4a8c-96b9-77954b230e54",
                  "ViewPermission": "ab15ca5d-be25-4fc8-889b-4a47484e6da8",
                  "SavePermission": "048c7f4d-9d40-4c2c-b365-02899c06f883",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "d07a5325-9f61-4a99-a8be-ec631956e5c8",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "0d23c94c-5f7b-4978-bdba-b6931566a0de",
                  "ViewPermission": "94cb8eb4-3d89-4aa7-b16b-aafa65885bd5",
                  "SavePermission": "11de531e-b806-498d-b07c-5291a76ebc77",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "5e0ee02a-1450-4e65-bd22-5d170b7aeaea",
              "ViewPermission": "c388b35b-cb81-4d6b-9b4a-27a943ea3f10",
              "SavePermission": "1b7d94cb-c531-421f-b33b-eb8b2eb04331",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "bfc660c8-bfba-40ec-ab7a-ea38f3aeecf0",
          "ViewPermission": "afb354df-b606-4942-b750-81974358e822",
          "SavePermission": "bc4b40ed-ec28-4083-9785-1900e320f2e6",
          "Type": "DynamicTabSetup"
        }
      ]
    },
    "BusinessUnits": []
  },
  {
    "Uid": "f08c54a5-a90c-4c3c-a532-a98a1a4231f4",
    "Alias": "USSalesCatalogue",
    "Label": "Sales catalogue (US)",
    "IsMaster": true,
    "SortOrder": 2,
    "IdentifierDefinitions": [
      {
        "Uid": "ded2ca4e-7134-400e-8a18-2b3f65d008a9",
        "Alias": "ERPRef",
        "IdentifierPattern": "{0}",
        "IdentifierAttributes": [
          "f0555fd6-f480-41a4-946d-7929670c1ce6"
        ]
      }
    ],
    "Configuration": {
      "NameConfiguration": {
        "NamePattern": "{0}",
        "NameAttributes": [
          "b5ffa961-d846-4adf-8161-f692469d7513"
        ]
      },
      "CreateWizard": null,
      "Tabs": [
        {
          "Label": "General",
          "Sections": [
            {
              "Headline": "Basic information",
              "Description": "",
              "Properties": [
                {
                  "AttributeUid": "b5ffa961-d846-4adf-8161-f692469d7513",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "8c61ea6e-749d-4feb-93ac-887137e414f0",
                  "ViewPermission": "8c8607d0-c2a0-4d86-b6a4-5b513999f55a",
                  "SavePermission": "de6cea66-5210-4ec4-aa69-c260a0ae5e7b",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "6e33bed8-d035-4608-a544-e81f18e0c2d6",
              "ViewPermission": "7f97f649-62b1-4939-b7c3-67f25f3e4cdd",
              "SavePermission": "2004c96a-9f60-44a8-a893-c47b29919117",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "37e2a00a-0c41-404d-aca1-6a58d2a0d5e8",
          "ViewPermission": "857f5ae9-dabd-46b1-ae2d-071bf6c60e92",
          "SavePermission": "979b9326-e1c6-4aeb-87a8-12e35939e7bc",
          "Type": "DynamicTabSetup"
        }
      ]
    },
    "BusinessUnits": []
  }
]

Create new catalogue

post

#Available from v.3.3.0

Authorizations

ApiKey

AuthorizationstringRequired

Body

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

Responses

200

OK

No content

400

Bad Request

application/json

post

/v1/catalogues

HTTPcURLJavaScriptPython

POST /v1/catalogues HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1891

{
  "Uid": "2f780f93-8cea-4498-82b8-d1f85fd78bfe",
  "Alias": "MasterCatalogue",
  "Label": "Master catalogue",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "c9fd6683-c0ea-4767-b9e8-b67ab92b2440",
      "Alias": "ERPRef",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "cd89a67b-bdb8-4304-8c49-d8148d4b5fe8"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "{0}",
      "NameAttributes": [
        "cb73d54d-f5bd-405f-9026-6289889e1d69"
      ]
    },
    "CreateWizard": null,
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "cb73d54d-f5bd-405f-9026-6289889e1d69",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "13a89dd7-516b-44b8-a6b1-04456e6a6a47",
                "ViewPermission": "25c14c56-00b6-41e6-bdae-c7c8afbcf6c4",
                "SavePermission": "7f42470e-a6e0-4dc6-8ecd-a7044c14fc63",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "9758e2db-aa07-49ba-bf34-3cea09751724",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "39ec6a4e-cc8e-42c0-a5e8-763f652d91ba",
                "ViewPermission": "2d60f446-66f1-4cb1-bc2b-7fa117a9fcb7",
                "SavePermission": "c1a09c40-bebf-4f37-a53f-e2e3556502f8",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "8d9181a4-18ea-4f01-8c93-2d029d70b88e",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "25fbd86c-9f9f-4749-bb01-9de7a01e2abb",
                "ViewPermission": "6d6a0842-bdab-4331-82fb-67eca0443635",
                "SavePermission": "3f874c3f-5f35-452d-85b6-6741120ce0c3",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "b51d71e9-5c11-4fdf-a42b-47d3d36762e3",
            "ViewPermission": "8b4742f7-61f7-4a44-82c9-ed10def71b22",
            "SavePermission": "475fa7b8-1f4b-460d-94bd-07cb6eec331e",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "b597dd7c-59ee-43a2-8b7a-24ae9b4b9f61",
        "ViewPermission": "b0c639c9-b549-48a3-9ad6-8ced2ca0ad68",
        "SavePermission": "17acb20e-76c9-4a9a-acdc-49416dc93ff5",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "BusinessUnits": []
}

No content

delete

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

catalogueUidstring · uuidOptional

Responses

200

OK

No content

delete

/v1/catalogues

HTTPcURLJavaScriptPython

DELETE /v1/catalogues HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Update a catalogue

patch

#Available from v.3.3.0

Authorizations

ApiKey

AuthorizationstringRequired

Body

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

Responses

200

OK

No content

400

Bad Request

application/json

patch

/v1/catalogues

HTTPcURLJavaScriptPython

PATCH /v1/catalogues HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1891

{
  "Uid": "e13e96c4-b813-4768-b652-cca482c4ab6f",
  "Alias": "MasterCatalogue",
  "Label": "Master catalogue",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "829bfb40-a271-41bd-960e-7698d6e3f5ff",
      "Alias": "ERPRef",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "0689938e-7c1c-4be7-9f47-c755e435aaf7"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "{0}",
      "NameAttributes": [
        "58fca5c5-6c82-45b2-9ee6-d57342287960"
      ]
    },
    "CreateWizard": null,
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "58fca5c5-6c82-45b2-9ee6-d57342287960",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "7d035f6f-988c-463a-9a36-f93abf86fa76",
                "ViewPermission": "635c4c57-1c5b-48ad-8753-7dfe30c5419c",
                "SavePermission": "98caf75a-a560-4b10-922e-0b209ba2743f",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "a44bd0a0-7322-4d66-ae97-198c9b8b535e",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "da413873-99a2-43df-b397-671a42ecbbd8",
                "ViewPermission": "4a22b7e6-7552-47e4-9e70-b9dda65b4b7f",
                "SavePermission": "e31d6aff-0793-4351-986a-746436429f46",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "74613bd6-159f-4a94-ba64-41769f2bab56",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "3f7a3b99-b3aa-4261-9055-46bab1496820",
                "ViewPermission": "ca33c502-c2eb-4427-9d04-60df1821a121",
                "SavePermission": "a674a950-a808-4489-8f52-7eafecd5c77c",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "79647c2d-60b1-4872-91aa-da2cca2529f0",
            "ViewPermission": "18675fa1-e06e-4d51-a2d5-ab177f19da90",
            "SavePermission": "9b08705a-8349-4ed9-8812-93e23a78fba3",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "b8ed1b36-1c22-46ea-8272-96d09ad0c006",
        "ViewPermission": "2eccc633-e9a1-478c-9e81-fff626f11aaa",
        "SavePermission": "9bb53c38-39ae-4c34-9b1b-018c13367953",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "BusinessUnits": []
}

No content

Get catalogue by its Uid

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of catalogue

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

/v1/catalogues/{uid}

HTTPcURLJavaScriptPython

GET /v1/catalogues/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "a285fc51-ec9c-46cf-be6b-c11fc84611e0",
  "Alias": "MasterCatalogue",
  "Label": "Master catalogue",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "caed11d1-6b7e-4eca-836d-f93e4a7569ec",
      "Alias": "ERPRef",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "faa32e8c-8b00-4ddb-a608-6e071252bfc5"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "{0}",
      "NameAttributes": [
        "aaf75b7d-108b-4e39-a461-c4286ea27d83"
      ]
    },
    "CreateWizard": null,
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "aaf75b7d-108b-4e39-a461-c4286ea27d83",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "5ae8e4bb-b7ee-4dfe-bc3b-9f53f96233a7",
                "ViewPermission": "72e35171-68d9-421b-9f0b-3ab928ba50fa",
                "SavePermission": "3d9ea5d2-d600-4f77-b720-6af82a24fcf5",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "d0c0e3d6-32e0-4420-8560-afc7d3764f15",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "01e68a73-ba48-4e54-b3f8-6f788f479c8f",
                "ViewPermission": "177a0702-1d31-4b9d-a871-778def8723b0",
                "SavePermission": "23643d97-774c-4c42-a6f4-620ed3dcc968",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "12d2d6c6-1846-47c4-974f-6a44e20379a3",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "e8d1d687-8f68-45c7-84f8-959203ea7347",
                "ViewPermission": "35769bbe-c8ae-4aa6-b376-5c8bb1491dd0",
                "SavePermission": "6db8eb99-871d-4066-9f40-bbc473554a9a",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "67eeaba9-c86d-478f-8c71-0114fb17a3b3",
            "ViewPermission": "e99e4ab9-3381-477a-801c-8568e9a17281",
            "SavePermission": "23abeeb0-4a8a-4111-8d29-1329fd135735",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "2554040d-2d2a-45af-8a1a-753604c8c07d",
        "ViewPermission": "34d00cef-b907-4f47-99c1-c204861c8986",
        "SavePermission": "d71258d0-8082-4bad-8c72-e42478874d33",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "BusinessUnits": []
}

Get all categories in a catalogue

get

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

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of catalogue

Query parameters

limitinteger · int32Optional

Max number of categories til return

Default: 1000

afterIdinteger · int32Optional

Only return categories with id larger than this

Responses

200

OK

application/json

400

Bad Request

application/json

get

/v1/catalogues/{uid}/descendants

HTTPcURLJavaScriptPython

GET /v1/catalogues/{uid}/descendants HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Categories": [
    {
      "Id": 10,
      "ParentId": null,
      "SortOrder": 1,
      "CatalogueUid": "d302d4ea-5546-430f-8cb0-3794f30eab25",
      "Created": "2025-07-27T22:40:48.5007688+01:00",
      "CreatedBy": "Struct admin",
      "LastModified": "2025-10-05T22:40:48.5007833+01:00",
      "LastModifiedBy": "Struct support",
      "HasChildren": true,
      "Name": {
        "en-GB": "Electronics",
        "da-DK": "Elektronik"
      },
      "Dynamic": false,
      "QuerySetup": null,
      "WorkflowStateUid": "9541f724-593f-49dd-96b3-ddbcbbf17ab5",
      "BusinessUnits": []
    },
    {
      "Id": 11,
      "ParentId": null,
      "SortOrder": 1,
      "CatalogueUid": "d302d4ea-5546-430f-8cb0-3794f30eab25",
      "Created": "2025-08-06T22:40:48.5007864+01:00",
      "CreatedBy": "Struct admin",
      "LastModified": "2025-10-25T22:40:48.5007869+01:00",
      "LastModifiedBy": "Struct support",
      "HasChildren": true,
      "Name": {
        "en-GB": "Clothing",
        "da-DK": "Tøj"
      },
      "Dynamic": false,
      "QuerySetup": null,
      "WorkflowStateUid": "adb66c41-d2f1-4e9b-9540-0806f0d09904",
      "BusinessUnits": []
    }
  ],
  "Total": 27,
  "Remaining": 25,
  "LastId": 11
}

Get all children to a catalogue

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of catalogue

Responses

200

OK

application/json

get

/v1/catalogues/{uid}/children

HTTPcURLJavaScriptPython

GET /v1/catalogues/{uid}/children HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Id": 10,
    "ParentId": null,
    "SortOrder": 1,
    "CatalogueUid": "3cf2a3a2-fb72-440b-adf9-152ae1f36804",
    "Created": "2025-07-27T22:40:48.5018405+01:00",
    "CreatedBy": "Struct admin",
    "LastModified": "2025-10-05T22:40:48.5018441+01:00",
    "LastModifiedBy": "Struct support",
    "HasChildren": true,
    "Name": {
      "en-GB": "Electronics",
      "da-DK": "Elektronik"
    },
    "Dynamic": false,
    "QuerySetup": null,
    "WorkflowStateUid": "7d81babd-9e04-4090-ac7c-63aafc4feee5",
    "BusinessUnits": []
  },
  {
    "Id": 11,
    "ParentId": null,
    "SortOrder": 1,
    "CatalogueUid": "3cf2a3a2-fb72-440b-adf9-152ae1f36804",
    "Created": "2025-08-06T22:40:48.5018464+01:00",
    "CreatedBy": "Struct admin",
    "LastModified": "2025-10-25T22:40:48.5018471+01:00",
    "LastModifiedBy": "Struct support",
    "HasChildren": true,
    "Name": {
      "en-GB": "Clothing",
      "da-DK": "Tøj"
    },
    "Dynamic": false,
    "QuerySetup": null,
    "WorkflowStateUid": "ba00fe87-76ae-4f41-8118-b7d16fe17520",
    "BusinessUnits": []
  }
]