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

Responses

200

OK

text/plainapplication/jsontext/json

Responsestring · uuid[]

get

HTTPcURLJavaScriptPython

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

200

OK

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

Get all catalogues in the system

get

Authorizations

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text",
    "Label": "text",
    "IsMaster": true,
    "SortOrder": 1,
    "IdentifierDefinitions": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Alias": "text",
        "IdentifierPattern": "text",
        "IdentifierAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "Configuration": {
      "NameConfiguration": {
        "NamePattern": "text",
        "NameAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      },
      "CreateWizard": {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Steps": [
          {
            "Uid": "123e4567-e89b-12d3-a456-426614174000",
            "Headline": "text",
            "Description": "text",
            "Type": "text"
          }
        ]
      },
      "Tabs": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
          "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
          "Type": "text"
        }
      ]
    },
    "BusinessUnits": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
]

Create new catalogue

post

#Available from v.3.3.0

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+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

400

Bad Request

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

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

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "BusinessUnits": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

delete

Authorizations

Query parameters

catalogueUidstring · uuidOptional

Responses

200

OK

delete

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

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+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

400

Bad Request

text/plainapplication/jsontext/json

patch

HTTPcURLJavaScriptPython

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

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "BusinessUnits": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

Get catalogue by its Uid

get

Authorizations

Path parameters

uidstring · uuidRequired

Unique id of catalogue

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text",
          "Type": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
        "Type": "text"
      }
    ]
  },
  "BusinessUnits": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

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

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

{
  "Categories": [
    {
      "Id": 1,
      "ParentId": 1,
      "SortOrder": 1,
      "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
      "Created": "2025-06-27T08:06:56.411Z",
      "CreatedBy": "text",
      "LastModified": "2025-06-27T08:06:56.411Z",
      "LastModifiedBy": "text",
      "HasChildren": true,
      "Name": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "Dynamic": true,
      "QuerySetup": {
        "ProductQuery": {
          "BooleanOperator": 0,
          "QueryModelType": "text"
        },
        "VariantGroupQuery": {
          "BooleanOperator": 0,
          "QueryModelType": "text"
        }
      },
      "WorkflowStateUid": "123e4567-e89b-12d3-a456-426614174000",
      "BusinessUnits": [
        {
          "AccessPolicy": "text",
          "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }
  ],
  "Total": 1,
  "Remaining": 1,
  "LastId": 1
}

Get all children to a catalogue

get

Authorizations

Path parameters

uidstring · uuidRequired

Unique id of catalogue

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "Id": 1,
    "ParentId": 1,
    "SortOrder": 1,
    "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
    "Created": "2025-06-27T08:06:56.411Z",
    "CreatedBy": "text",
    "LastModified": "2025-06-27T08:06:56.411Z",
    "LastModifiedBy": "text",
    "HasChildren": true,
    "Name": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "Dynamic": true,
    "QuerySetup": {
      "ProductQuery": {
        "BooleanOperator": 0,
        "QueryModelType": "text"
      },
      "VariantGroupQuery": {
        "BooleanOperator": 0,
        "QueryModelType": "text"
      }
    },
    "WorkflowStateUid": "123e4567-e89b-12d3-a456-426614174000",
    "BusinessUnits": [
      {
        "AccessPolicy": "text",
        "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
]