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
AuthorizationstringRequired
Responses
chevron-right
200

OK

application/json
string · uuid[]Optional
get
/v1/catalogues/uids
200

OK

Get all catalogues in the system

get
Authorizations
AuthorizationstringRequired
Responses
chevron-right
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

get
/v1/catalogues

Create new catalogue

post

#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
chevron-right
200

OK

No content

post
/v1/catalogues

No content

delete
Authorizations
AuthorizationstringRequired
Query parameters
catalogueUidstring · uuidOptional
Responses
chevron-right
200

OK

No content

delete
/v1/catalogues
200

OK

No content

Update a catalogue

patch

#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
chevron-right
200

OK

No content

patch
/v1/catalogues

No content

Get catalogue by its Uid

get
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired

Unique id of catalogue

Responses
chevron-right
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

get
/v1/catalogues/{uid}

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
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
chevron-right
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

get
/v1/catalogues/{uid}/descendants

Get all children to a catalogue

get
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired

Unique id of catalogue

Responses
chevron-right
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
200

OK

Last updated