#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 diffrent assortments, category structures etc.
GET /catalogues Get all catalogues in the system
[
{
"Uid": "fb979ded-2003-4fe7-876c-3b416096fff8",
"Alias": "MasterCatalogue",
"Label": "Master catalogue",
"IsMaster": true,
"SortOrder": 1,
"IdentifierDefinitions": [
{
"Uid": "618d65f3-814e-495e-8054-ab57148abe5a",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"450ccb79-6e63-499b-a044-05b404aa2224"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"1b6effb2-fb43-42f0-a6ad-80efc38d8830"
]
},
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Properties": [
{
"AttributeUid": "1b6effb2-fb43-42f0-a6ad-80efc38d8830",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "375bae86-96dc-4fac-99f4-db52059997ac",
"Type": "AttributeSetup"
},
{
"AttributeUid": "d224e7f5-fd29-4961-81b8-779fd23b01e0",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "1800b665-9443-4e64-b598-4e36d751998b",
"Type": "AttributeSetup"
},
{
"AttributeUid": "27e33f31-e676-4b54-80fc-34d1234f22f3",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "f62337af-87fe-4202-be07-505c768826bf",
"Type": "AttributeSetup"
}
],
"Uid": "d1aaa3fa-4063-4201-9c44-9f38820ad59c",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "910a418f-6470-40fe-bb9e-f2774ff492b2",
"Type": "DynamicTabSetup"
}
]
}
},
{
"Uid": "a065be58-f372-45aa-a151-a20ae60d6468",
"Alias": "USSalesCatalogue",
"Label": "Sales catalogue (US)",
"IsMaster": true,
"SortOrder": 2,
"IdentifierDefinitions": [
{
"Uid": "54ac84a4-654d-48ba-8ada-a513180aa425",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"d029be6a-ccd7-49d9-af86-760d7d21fa57"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"1b6effb2-fb43-42f0-a6ad-80efc38d8830"
]
},
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Properties": [
{
"AttributeUid": "1b6effb2-fb43-42f0-a6ad-80efc38d8830",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "c768e930-e1fc-4ce4-8852-948aa94274c0",
"Type": "AttributeSetup"
}
],
"Uid": "6d9a4153-d4c5-4647-b505-af4f5495cb16",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "1aab99ac-f00b-400a-92ed-920432e5768a",
"Type": "DynamicTabSetup"
}
]
}
}
]
Response status OK (200)
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of catalogue |
Alias | string |
Unique human readable alias for the catalogue |
Label | string |
Label of catalogue displayed in the backoffice |
IsMaster | boolean |
Indicates whether this catalogue is the master catalogue (only one master catalogue can exist in the system) |
SortOrder | integer |
Sort order of the catalogue compared to other catalogues |
IdentifierDefinitions | array : IdentifierDefinition |
Defines identifier setups used to create maps between eg. a category number in an external system and the internal id of a category of this catalogue in the system |
Configuration | object : CategoryConfigurationModel |
The configuration of tabs, sections and properties for categories in this catalogue |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of identifier definition |
Alias | string |
Unqique human readable identifier of the definition |
IdentifierPattern | string |
Pattern defining how to generate identifier string from values of the selected attributes (ex. {0} - {1} to render the values of two selected attributes in IdentifierAttributes with a - between them) |
IdentifierAttributes | array |
Attributes for which values should be used for generating the identifier string (ex. uid of attribute for Model number and uid of attribute for SKU) |
Property name | Data type | Description |
---|---|---|
NameConfiguration | object : NameConfiguration |
Pattern defining how names shall be generated for categories (names are shown in tree view and when a reference to the item is shown in backoffice) |
CreateWizard | object : WizardSetup |
The step wizard presented to users when creating a new category using this Category configuration [Optional] |
Tabs | array : TabSetup |
The tabs that shall be shown on categories using this category configuration in the backoffice |
Property name | Data type | Description |
---|---|---|
NamePattern | string |
Pattern defining how attribute values shall be concatenated to form a name. Ex. {0} - {1} |
NameAttributes | array |
Uids of attributes to use in rendering. Number of attributes must match number of referenced attributes in NamePattern |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard setup |
Steps | array : WizardStepSetup |
The steps that are part of this wizard |
Property name | Data type | Description |
---|---|---|
Properties | array : WizardPropertySetup |
Properties that shall be shown on this wizard step |
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
PropertyUid | string |
Reference to property uid on configuration defining the attribute |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Mandatory | boolean |
Defines if the defining attributes are mandatory in the step they are shown |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Add an optional display name to show for the property in the backoffice wizard |
DisplayDescription | string |
Add an optional description to show for the property in the backoffice wizard |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Label | string |
The headline this tab shall be presented with in the backoffice |
Sections | array : SectionSetup |
The sections shown on this tab in the backoffice |
ShowSidebar | boolean |
Shows product status sidebar in backoffice |
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Headline | string |
Headline of section |
Description | string |
Description to show on section |
Properties | array : PropertySetup |
Properties shown in section |
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Width | integer |
Width of the preview property |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Name to show for the property in the backoffice |
DisplayDescription | string |
Description to show for the property in the backoffice |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
AttributeUid | string |
Uid of attribute |
ReadOnly | boolean |
Defines if the attribute value is read only |
Mandatory | boolean |
Defines if the attribute must have a value before the user can save the tab |
Unchangeable | boolean |
Defines if the attribute value cannot change, once it has gotten a value |
Inherits | boolean |
Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default. |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
POST /catalogues Create new catalogue
#Available from v.3.3.0
{
"Uid": "60e98886-f6aa-4147-b292-754913ef5064",
"Alias": "MasterCatalogue",
"Label": "Master catalogue",
"IsMaster": true,
"SortOrder": 1,
"IdentifierDefinitions": [
{
"Uid": "0286e80d-65f5-4af3-8afc-d94d88a6297d",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"3e2b5292-ea1c-481e-9ce1-802c6d212fd7"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"7e86a1f8-e8b0-4481-ac66-d31926e43432"
]
},
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Properties": [
{
"AttributeUid": "7e86a1f8-e8b0-4481-ac66-d31926e43432",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "253feb35-ad25-4ab5-ae9f-75cdb934694f",
"Type": "AttributeSetup"
},
{
"AttributeUid": "4c7cf56a-fff6-4cd1-9633-b647720757fd",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "fc5bdae9-52f2-49ed-92ca-571c5ec0fda3",
"Type": "AttributeSetup"
},
{
"AttributeUid": "7c37300f-3ef5-472d-a918-e5f345632958",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "31c9b383-fc1d-45f2-aff4-18f88675e369",
"Type": "AttributeSetup"
}
],
"Uid": "1223be50-4301-44b8-9e88-8c0d430273f1",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "a2c3e1a9-fd33-4b8f-8930-afe835f8933a",
"Type": "DynamicTabSetup"
}
]
}
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
catalogue | body | object : CatalogueModel |
Catalogue |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of catalogue |
Alias | string |
Unique human readable alias for the catalogue |
Label | string |
Label of catalogue displayed in the backoffice |
IsMaster | boolean |
Indicates whether this catalogue is the master catalogue (only one master catalogue can exist in the system) |
SortOrder | integer |
Sort order of the catalogue compared to other catalogues |
IdentifierDefinitions | array : IdentifierDefinition |
Defines identifier setups used to create maps between eg. a category number in an external system and the internal id of a category of this catalogue in the system |
Configuration | object : CategoryConfigurationModel |
The configuration of tabs, sections and properties for categories in this catalogue |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of identifier definition |
Alias | string |
Unqique human readable identifier of the definition |
IdentifierPattern | string |
Pattern defining how to generate identifier string from values of the selected attributes (ex. {0} - {1} to render the values of two selected attributes in IdentifierAttributes with a - between them) |
IdentifierAttributes | array |
Attributes for which values should be used for generating the identifier string (ex. uid of attribute for Model number and uid of attribute for SKU) |
Property name | Data type | Description |
---|---|---|
NameConfiguration | object : NameConfiguration |
Pattern defining how names shall be generated for categories (names are shown in tree view and when a reference to the item is shown in backoffice) |
CreateWizard | object : WizardSetup |
The step wizard presented to users when creating a new category using this Category configuration [Optional] |
Tabs | array : TabSetup |
The tabs that shall be shown on categories using this category configuration in the backoffice |
Property name | Data type | Description |
---|---|---|
NamePattern | string |
Pattern defining how attribute values shall be concatenated to form a name. Ex. {0} - {1} |
NameAttributes | array |
Uids of attributes to use in rendering. Number of attributes must match number of referenced attributes in NamePattern |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard setup |
Steps | array : WizardStepSetup |
The steps that are part of this wizard |
Property name | Data type | Description |
---|---|---|
Properties | array : WizardPropertySetup |
Properties that shall be shown on this wizard step |
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
PropertyUid | string |
Reference to property uid on configuration defining the attribute |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Mandatory | boolean |
Defines if the defining attributes are mandatory in the step they are shown |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Add an optional display name to show for the property in the backoffice wizard |
DisplayDescription | string |
Add an optional description to show for the property in the backoffice wizard |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Label | string |
The headline this tab shall be presented with in the backoffice |
Sections | array : SectionSetup |
The sections shown on this tab in the backoffice |
ShowSidebar | boolean |
Shows product status sidebar in backoffice |
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Headline | string |
Headline of section |
Description | string |
Description to show on section |
Properties | array : PropertySetup |
Properties shown in section |
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Width | integer |
Width of the preview property |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Name to show for the property in the backoffice |
DisplayDescription | string |
Description to show for the property in the backoffice |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
AttributeUid | string |
Uid of attribute |
ReadOnly | boolean |
Defines if the attribute value is read only |
Mandatory | boolean |
Defines if the attribute must have a value before the user can save the tab |
Unchangeable | boolean |
Defines if the attribute value cannot change, once it has gotten a value |
Inherits | boolean |
Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default. |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Response status OK (200)
DELETE /catalogues Delete a catalogue
#Available from v.3.3.0
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
catalogueUid | query | string |
Response status OK (200)
PATCH /catalogues Update a catalogue
#Available from v.3.3.0
{
"Uid": "68f23e24-0be6-4892-946f-f6579b78882b",
"Alias": "MasterCatalogue",
"Label": "Master catalogue",
"IsMaster": true,
"SortOrder": 1,
"IdentifierDefinitions": [
{
"Uid": "68f49c86-306c-4d04-97e6-7d506f78c066",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"c7c9a2aa-d064-4803-9e74-d4405f43b22a"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"2e05619e-c1a1-4a84-970e-7a74f84c21fd"
]
},
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Properties": [
{
"AttributeUid": "2e05619e-c1a1-4a84-970e-7a74f84c21fd",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "75fffcb6-8b87-4676-95f2-6979e787e6fe",
"Type": "AttributeSetup"
},
{
"AttributeUid": "bb4f5471-ea76-415b-8f2b-506bb005b23c",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "d251c302-b88f-491a-935c-4ef48b49cf86",
"Type": "AttributeSetup"
},
{
"AttributeUid": "1881f82e-77ba-4008-8afd-09d574bf54a0",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "b83dd573-3079-4c3e-a2b6-cf0c0198db00",
"Type": "AttributeSetup"
}
],
"Uid": "4d2389ad-a718-4376-b8d9-06bb50658067",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "250cfed5-e70a-479d-9933-903b0538e68b",
"Type": "DynamicTabSetup"
}
]
}
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
catalogue | body | object : CatalogueModel |
Catalogue |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of catalogue |
Alias | string |
Unique human readable alias for the catalogue |
Label | string |
Label of catalogue displayed in the backoffice |
IsMaster | boolean |
Indicates whether this catalogue is the master catalogue (only one master catalogue can exist in the system) |
SortOrder | integer |
Sort order of the catalogue compared to other catalogues |
IdentifierDefinitions | array : IdentifierDefinition |
Defines identifier setups used to create maps between eg. a category number in an external system and the internal id of a category of this catalogue in the system |
Configuration | object : CategoryConfigurationModel |
The configuration of tabs, sections and properties for categories in this catalogue |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of identifier definition |
Alias | string |
Unqique human readable identifier of the definition |
IdentifierPattern | string |
Pattern defining how to generate identifier string from values of the selected attributes (ex. {0} - {1} to render the values of two selected attributes in IdentifierAttributes with a - between them) |
IdentifierAttributes | array |
Attributes for which values should be used for generating the identifier string (ex. uid of attribute for Model number and uid of attribute for SKU) |
Property name | Data type | Description |
---|---|---|
NameConfiguration | object : NameConfiguration |
Pattern defining how names shall be generated for categories (names are shown in tree view and when a reference to the item is shown in backoffice) |
CreateWizard | object : WizardSetup |
The step wizard presented to users when creating a new category using this Category configuration [Optional] |
Tabs | array : TabSetup |
The tabs that shall be shown on categories using this category configuration in the backoffice |
Property name | Data type | Description |
---|---|---|
NamePattern | string |
Pattern defining how attribute values shall be concatenated to form a name. Ex. {0} - {1} |
NameAttributes | array |
Uids of attributes to use in rendering. Number of attributes must match number of referenced attributes in NamePattern |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard setup |
Steps | array : WizardStepSetup |
The steps that are part of this wizard |
Property name | Data type | Description |
---|---|---|
Properties | array : WizardPropertySetup |
Properties that shall be shown on this wizard step |
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
PropertyUid | string |
Reference to property uid on configuration defining the attribute |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Mandatory | boolean |
Defines if the defining attributes are mandatory in the step they are shown |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Add an optional display name to show for the property in the backoffice wizard |
DisplayDescription | string |
Add an optional description to show for the property in the backoffice wizard |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Label | string |
The headline this tab shall be presented with in the backoffice |
Sections | array : SectionSetup |
The sections shown on this tab in the backoffice |
ShowSidebar | boolean |
Shows product status sidebar in backoffice |
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Headline | string |
Headline of section |
Description | string |
Description to show on section |
Properties | array : PropertySetup |
Properties shown in section |
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Width | integer |
Width of the preview property |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Name to show for the property in the backoffice |
DisplayDescription | string |
Description to show for the property in the backoffice |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
AttributeUid | string |
Uid of attribute |
ReadOnly | boolean |
Defines if the attribute value is read only |
Mandatory | boolean |
Defines if the attribute must have a value before the user can save the tab |
Unchangeable | boolean |
Defines if the attribute value cannot change, once it has gotten a value |
Inherits | boolean |
Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default. |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Response status OK (200)
GET /catalogues/{uid} Get catalogue by its Uid
{
"Uid": "e1320270-32cd-45c2-a8f4-84c0b47e7644",
"Alias": "MasterCatalogue",
"Label": "Master catalogue",
"IsMaster": true,
"SortOrder": 1,
"IdentifierDefinitions": [
{
"Uid": "484119c7-1e7e-4285-a0f0-19576b40c1bb",
"Alias": "ERPRef",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"6e7df573-2e1c-47db-9b1c-2a3f48a1e32b"
]
}
],
"Configuration": {
"NameConfiguration": {
"NamePattern": "{0}",
"NameAttributes": [
"d553a735-ba3f-4489-a159-93f5f4674e43"
]
},
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Properties": [
{
"AttributeUid": "d553a735-ba3f-4489-a159-93f5f4674e43",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "585ea661-4400-401e-b851-ed68cee87acc",
"Type": "AttributeSetup"
},
{
"AttributeUid": "ce9c49cf-d7be-4936-8021-d0171ed81ee8",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "6a3df849-0a24-41dd-a73b-93138027c57b",
"Type": "AttributeSetup"
},
{
"AttributeUid": "75799350-037d-4169-b5db-9d5293ac03eb",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "2de9a514-27fa-43ae-bd39-c4d6a8861822",
"Type": "AttributeSetup"
}
],
"Uid": "098665d1-f3bc-4eb6-b43d-98a95b8d7457",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "b131feee-f37e-43b1-ad5f-4177ff9ec39e",
"Type": "DynamicTabSetup"
}
]
}
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
uid | path | string |
Unique id of catalogue |
Response status OK (200)
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of catalogue |
Alias | string |
Unique human readable alias for the catalogue |
Label | string |
Label of catalogue displayed in the backoffice |
IsMaster | boolean |
Indicates whether this catalogue is the master catalogue (only one master catalogue can exist in the system) |
SortOrder | integer |
Sort order of the catalogue compared to other catalogues |
IdentifierDefinitions | array : IdentifierDefinition |
Defines identifier setups used to create maps between eg. a category number in an external system and the internal id of a category of this catalogue in the system |
Configuration | object : CategoryConfigurationModel |
The configuration of tabs, sections and properties for categories in this catalogue |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of identifier definition |
Alias | string |
Unqique human readable identifier of the definition |
IdentifierPattern | string |
Pattern defining how to generate identifier string from values of the selected attributes (ex. {0} - {1} to render the values of two selected attributes in IdentifierAttributes with a - between them) |
IdentifierAttributes | array |
Attributes for which values should be used for generating the identifier string (ex. uid of attribute for Model number and uid of attribute for SKU) |
Property name | Data type | Description |
---|---|---|
NameConfiguration | object : NameConfiguration |
Pattern defining how names shall be generated for categories (names are shown in tree view and when a reference to the item is shown in backoffice) |
CreateWizard | object : WizardSetup |
The step wizard presented to users when creating a new category using this Category configuration [Optional] |
Tabs | array : TabSetup |
The tabs that shall be shown on categories using this category configuration in the backoffice |
Property name | Data type | Description |
---|---|---|
NamePattern | string |
Pattern defining how attribute values shall be concatenated to form a name. Ex. {0} - {1} |
NameAttributes | array |
Uids of attributes to use in rendering. Number of attributes must match number of referenced attributes in NamePattern |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard setup |
Steps | array : WizardStepSetup |
The steps that are part of this wizard |
Property name | Data type | Description |
---|---|---|
Properties | array : WizardPropertySetup |
Properties that shall be shown on this wizard step |
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
PropertyUid | string |
Reference to property uid on configuration defining the attribute |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Mandatory | boolean |
Defines if the defining attributes are mandatory in the step they are shown |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Add an optional display name to show for the property in the backoffice wizard |
DisplayDescription | string |
Add an optional description to show for the property in the backoffice wizard |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Label | string |
The headline this tab shall be presented with in the backoffice |
Sections | array : SectionSetup |
The sections shown on this tab in the backoffice |
ShowSidebar | boolean |
Shows product status sidebar in backoffice |
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Headline | string |
Headline of section |
Description | string |
Description to show on section |
Properties | array : PropertySetup |
Properties shown in section |
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Width | integer |
Width of the preview property |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Name to show for the property in the backoffice |
DisplayDescription | string |
Description to show for the property in the backoffice |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
AttributeUid | string |
Uid of attribute |
ReadOnly | boolean |
Defines if the attribute value is read only |
Mandatory | boolean |
Defines if the attribute must have a value before the user can save the tab |
Unchangeable | boolean |
Defines if the attribute value cannot change, once it has gotten a value |
Inherits | boolean |
Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default. |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
GET /catalogues/{uid}/children Get all children to a catalogue
[
{
"Id": 10,
"SortOrder": 1,
"CatalogueUid": "630da473-5cd7-40f9-b441-a02c6ed5ebd1",
"Created": "2023-07-18T14:11:16.6444301+02:00",
"CreatedBy": "Struct admin",
"LastModified": "2023-09-26T14:11:16.6444301+02:00",
"LastModifiedBy": "Struct support",
"HasChildren": true,
"Name": {
"en-GB": "Electronics",
"da-DK": "Elektronik"
},
"Dynamic": false
},
{
"Id": 11,
"SortOrder": 1,
"CatalogueUid": "630da473-5cd7-40f9-b441-a02c6ed5ebd1",
"Created": "2023-07-28T14:11:16.6444301+02:00",
"CreatedBy": "Struct admin",
"LastModified": "2023-10-16T14:11:16.6444301+02:00",
"LastModifiedBy": "Struct support",
"HasChildren": true,
"Name": {
"en-GB": "Clothing",
"da-DK": "Tøj"
},
"Dynamic": false
}
]
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
uid | path | string |
Unique id of catalogue |
Response status OK (200)
Property name | Data type | Description |
---|---|---|
Id | integer |
Id of category |
ParentId | integer |
Id of category's parent category. Null, if this category is placed in the root of its catalogue |
SortOrder | integer |
Sortorder of the category compared to other categories at the same level in the catalogue |
CatalogueUid | string |
The unique id of the catalogue, this category resides in |
Created | string |
Timestamp of the creation of category |
CreatedBy | string |
Username of user who created this category |
LastModified | string |
Timestamp of last modification of category |
LastModifiedBy | string |
Username of user who did the last modification |
HasChildren | boolean |
Indicates whether this category has any sub categories |
Name | object |
Display name of category (Dictionary of ISO culture code and name) |
Dynamic | boolean |
Indicates whether this category is dynamic (classification handled by PIM) |
QuerySetup | object : DynamicQueryContainer |
Query defining the entities that are placed as part of this category. Only Text, Boolean, Number, DateTime and FixedList is supported. FixedList needs to be specified by reference (Guid). |
WorkflowStateUid | string |
The uid of the workflow state of the category |
Property name | Data type | Description |
---|---|---|
ProductQuery | object : QueryModel |
Definition of the product query, which can be BooleanQueryModel or SimpleQueryModel |
VariantGroupQuery | object : QueryModel |
Definition of the variant group query, which can be BooleanQueryModel or SimpleQueryModel |
Property name | Data type | Description |
---|---|---|
Filters | array : FieldFilterModel |
List of filter conditions |
BooleanOperator | string |
The operator of the query. Can be any of:
|
QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
Property name | Data type | Description |
---|---|---|
SubQueries | array : QueryModel |
Sub queries to execute |
BooleanOperator | string |
The operator of the query. Can be any of:
|
QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
Property name | Data type | Description |
---|---|---|
FieldUid | string |
Uid of field to query |
QueryOperator | string |
Operator to use for query. Can be any of:
|
FilterValue | object |
Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for |
GET /catalogues/{uid}/descendants Get all categories in a catalogue
No more than 5000 categories can be requested at a time. If no limit is provided, the default limit of 1000 will be used
{
"Categories": [
{
"Id": 10,
"SortOrder": 1,
"CatalogueUid": "c6a31905-be94-46b6-b1d3-e9544d2abb3c",
"Created": "2023-07-18T14:11:16.6444301+02:00",
"CreatedBy": "Struct admin",
"LastModified": "2023-09-26T14:11:16.6444301+02:00",
"LastModifiedBy": "Struct support",
"HasChildren": true,
"Name": {
"en-GB": "Electronics",
"da-DK": "Elektronik"
},
"Dynamic": false
},
{
"Id": 11,
"SortOrder": 1,
"CatalogueUid": "c6a31905-be94-46b6-b1d3-e9544d2abb3c",
"Created": "2023-07-28T14:11:16.6444301+02:00",
"CreatedBy": "Struct admin",
"LastModified": "2023-10-16T14:11:16.6444301+02:00",
"LastModifiedBy": "Struct support",
"HasChildren": true,
"Name": {
"en-GB": "Clothing",
"da-DK": "Tøj"
},
"Dynamic": false
}
],
"Total": 27,
"Remaining": 25,
"LastId": 11
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
uid | path | string |
Unique id of catalogue |
limit | query | integer |
Max number of categories til return |
afterId | query | integer |
Only return categories with id larger than this |
Response status OK (200)
Property name | Data type | Description |
---|---|---|
Categories | array : CategoryModel |
List of categories in result set |
Total | integer |
The total number of items |
Remaining | integer |
The remaining items that lie after the last id of the item in this result set |
LastId | integer |
The id of the last item in this result set |
Property name | Data type | Description |
---|---|---|
Id | integer |
Id of category |
ParentId | integer |
Id of category's parent category. Null, if this category is placed in the root of its catalogue |
SortOrder | integer |
Sortorder of the category compared to other categories at the same level in the catalogue |
CatalogueUid | string |
The unique id of the catalogue, this category resides in |
Created | string |
Timestamp of the creation of category |
CreatedBy | string |
Username of user who created this category |
LastModified | string |
Timestamp of last modification of category |
LastModifiedBy | string |
Username of user who did the last modification |
HasChildren | boolean |
Indicates whether this category has any sub categories |
Name | object |
Display name of category (Dictionary of ISO culture code and name) |
Dynamic | boolean |
Indicates whether this category is dynamic (classification handled by PIM) |
QuerySetup | object : DynamicQueryContainer |
Query defining the entities that are placed as part of this category. Only Text, Boolean, Number, DateTime and FixedList is supported. FixedList needs to be specified by reference (Guid). |
WorkflowStateUid | string |
The uid of the workflow state of the category |
Property name | Data type | Description |
---|---|---|
ProductQuery | object : QueryModel |
Definition of the product query, which can be BooleanQueryModel or SimpleQueryModel |
VariantGroupQuery | object : QueryModel |
Definition of the variant group query, which can be BooleanQueryModel or SimpleQueryModel |
Property name | Data type | Description |
---|---|---|
Filters | array : FieldFilterModel |
List of filter conditions |
BooleanOperator | string |
The operator of the query. Can be any of:
|
QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
Property name | Data type | Description |
---|---|---|
SubQueries | array : QueryModel |
Sub queries to execute |
BooleanOperator | string |
The operator of the query. Can be any of:
|
QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
Property name | Data type | Description |
---|---|---|
FieldUid | string |
Uid of field to query |
QueryOperator | string |
Operator to use for query. Can be any of:
|
FilterValue | object |
Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for |
GET /catalogues/uids Get Uids of all catalogues in the system
[
"c9d45772-730e-44a1-935c-5b440f60c27b",
"6d0a2bf5-c4eb-486a-b97a-0b56ff4d7fef",
"74251497-3ba3-4348-8b8c-6bb7ed5a4f57"
]