#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

Response status OK (200)

array : CatalogueModel
CatalogueModel
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

IdentifierDefinition
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)

CategoryConfigurationModel
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

NameConfiguration
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

WizardSetup
Property name Data type Description
Uid string

Unique id of wizard setup

Steps array : WizardStepSetup

The steps that are part of this wizard

WizardStepSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
DynamicWizardStepSetup
Dynamic wizard step allows setting properties that shall be shown in this step
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

ClassificationWizardStepSetup
Classification step allowing users to classify products as part of a wizard
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

WizardPropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
AttributeWizardPropertySetup
Attribute property reference, referencing a property that shall be shown in a wizard step
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

DefiningAttributesWizardPropertySetup
Defining attributes property used to show defining attributes for a variant in wizard
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

VariationDefinitionWizardPropertySetup
Variation definition selector (can only be set on products)
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

TabSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
VariantsTabSetup
Variants tab displays all variants of a product and can only be added to product configuration
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

AttributesOnCategoryTabSetup
Tab that allows setting up attributes on a category that shall be available to products in this category or its descendants (Can only be added to master catalogue).
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

ClassificationsTabSetup
Shows a products classifications in different catalogues of the system (can only be added to product configuration)
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

DynamicTabSetup
Generic tab that allows setting up specific sections to show on the 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

SectionSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
CategoryAttributesSetup
Section which shows input fields for all attributes inherited from the products primary category
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

DynamicSectionSetup
Generic section that allows setting up specific properties to show in the 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

PropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
IdSetup
ID property showing the internal id of the item
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

CreatedSetup
Created timestamp property showing the exact creation timestamp of the item
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

LastModifiedSetup
Last modified timestamp property showing the exact timestamp of the latest modification of the item
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

PublicationPreviewSetup
Preview of publication for item
Property name Data type Description
Width integer

Widht 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

VariationDefinitionSetup
Variation definition selector property defines a property that allows users to select the variation definition to use for a product from a dropdown (can only be set on product configuration)
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

AttributeSetup
Defines an attribute connection to a configuration, allowing users to set data for an attribute on the product, variant or category using the configuration this attribute setup is added to
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


POST /catalogues Create new catalogue

#Available from v.3.3.0

Request parameters

Property name Parameter type Data type Description
catalogue body object : CatalogueModel

Catalogue

CatalogueModel
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

IdentifierDefinition
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)

CategoryConfigurationModel
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

NameConfiguration
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

WizardSetup
Property name Data type Description
Uid string

Unique id of wizard setup

Steps array : WizardStepSetup

The steps that are part of this wizard

WizardStepSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
DynamicWizardStepSetup
Dynamic wizard step allows setting properties that shall be shown in this step
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

ClassificationWizardStepSetup
Classification step allowing users to classify products as part of a wizard
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

WizardPropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
AttributeWizardPropertySetup
Attribute property reference, referencing a property that shall be shown in a wizard step
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

DefiningAttributesWizardPropertySetup
Defining attributes property used to show defining attributes for a variant in wizard
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

VariationDefinitionWizardPropertySetup
Variation definition selector (can only be set on products)
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

TabSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
VariantsTabSetup
Variants tab displays all variants of a product and can only be added to product configuration
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

AttributesOnCategoryTabSetup
Tab that allows setting up attributes on a category that shall be available to products in this category or its descendants (Can only be added to master catalogue).
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

ClassificationsTabSetup
Shows a products classifications in different catalogues of the system (can only be added to product configuration)
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

DynamicTabSetup
Generic tab that allows setting up specific sections to show on the 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

SectionSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
CategoryAttributesSetup
Section which shows input fields for all attributes inherited from the products primary category
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

DynamicSectionSetup
Generic section that allows setting up specific properties to show in the 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

PropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
IdSetup
ID property showing the internal id of the item
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

CreatedSetup
Created timestamp property showing the exact creation timestamp of the item
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

LastModifiedSetup
Last modified timestamp property showing the exact timestamp of the latest modification of the item
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

PublicationPreviewSetup
Preview of publication for item
Property name Data type Description
Width integer

Widht 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

VariationDefinitionSetup
Variation definition selector property defines a property that allows users to select the variation definition to use for a product from a dropdown (can only be set on product configuration)
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

AttributeSetup
Defines an attribute connection to a configuration, allowing users to set data for an attribute on the product, variant or category using the configuration this attribute setup is added to
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

Response status OK (200)

No body message is returned

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)

No body message is returned

PATCH /catalogues Update a catalogue

#Available from v.3.3.0

Request parameters

Property name Parameter type Data type Description
catalogue body object : CatalogueModel

Catalogue

CatalogueModel
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

IdentifierDefinition
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)

CategoryConfigurationModel
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

NameConfiguration
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

WizardSetup
Property name Data type Description
Uid string

Unique id of wizard setup

Steps array : WizardStepSetup

The steps that are part of this wizard

WizardStepSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
DynamicWizardStepSetup
Dynamic wizard step allows setting properties that shall be shown in this step
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

ClassificationWizardStepSetup
Classification step allowing users to classify products as part of a wizard
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

WizardPropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
AttributeWizardPropertySetup
Attribute property reference, referencing a property that shall be shown in a wizard step
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

DefiningAttributesWizardPropertySetup
Defining attributes property used to show defining attributes for a variant in wizard
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

VariationDefinitionWizardPropertySetup
Variation definition selector (can only be set on products)
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

TabSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
VariantsTabSetup
Variants tab displays all variants of a product and can only be added to product configuration
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

AttributesOnCategoryTabSetup
Tab that allows setting up attributes on a category that shall be available to products in this category or its descendants (Can only be added to master catalogue).
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

ClassificationsTabSetup
Shows a products classifications in different catalogues of the system (can only be added to product configuration)
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

DynamicTabSetup
Generic tab that allows setting up specific sections to show on the 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

SectionSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
CategoryAttributesSetup
Section which shows input fields for all attributes inherited from the products primary category
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

DynamicSectionSetup
Generic section that allows setting up specific properties to show in the 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

PropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
IdSetup
ID property showing the internal id of the item
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

CreatedSetup
Created timestamp property showing the exact creation timestamp of the item
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

LastModifiedSetup
Last modified timestamp property showing the exact timestamp of the latest modification of the item
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

PublicationPreviewSetup
Preview of publication for item
Property name Data type Description
Width integer

Widht 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

VariationDefinitionSetup
Variation definition selector property defines a property that allows users to select the variation definition to use for a product from a dropdown (can only be set on product configuration)
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

AttributeSetup
Defines an attribute connection to a configuration, allowing users to set data for an attribute on the product, variant or category using the configuration this attribute setup is added to
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

Response status OK (200)

No body message is returned

GET /catalogues/{uid} Get catalogue by its Uid

Request parameters

Property name Parameter type Data type Description
uid path string

Unique id of catalogue

Response status OK (200)

object : CatalogueModel
CatalogueModel
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

IdentifierDefinition
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)

CategoryConfigurationModel
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

NameConfiguration
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

WizardSetup
Property name Data type Description
Uid string

Unique id of wizard setup

Steps array : WizardStepSetup

The steps that are part of this wizard

WizardStepSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
DynamicWizardStepSetup
Dynamic wizard step allows setting properties that shall be shown in this step
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

ClassificationWizardStepSetup
Classification step allowing users to classify products as part of a wizard
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

WizardPropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
AttributeWizardPropertySetup
Attribute property reference, referencing a property that shall be shown in a wizard step
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

DefiningAttributesWizardPropertySetup
Defining attributes property used to show defining attributes for a variant in wizard
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

VariationDefinitionWizardPropertySetup
Variation definition selector (can only be set on products)
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

TabSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
VariantsTabSetup
Variants tab displays all variants of a product and can only be added to product configuration
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

AttributesOnCategoryTabSetup
Tab that allows setting up attributes on a category that shall be available to products in this category or its descendants (Can only be added to master catalogue).
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

ClassificationsTabSetup
Shows a products classifications in different catalogues of the system (can only be added to product configuration)
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

DynamicTabSetup
Generic tab that allows setting up specific sections to show on the 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

SectionSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
CategoryAttributesSetup
Section which shows input fields for all attributes inherited from the products primary category
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

DynamicSectionSetup
Generic section that allows setting up specific properties to show in the 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

PropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
IdSetup
ID property showing the internal id of the item
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

CreatedSetup
Created timestamp property showing the exact creation timestamp of the item
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

LastModifiedSetup
Last modified timestamp property showing the exact timestamp of the latest modification of the item
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

PublicationPreviewSetup
Preview of publication for item
Property name Data type Description
Width integer

Widht 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

VariationDefinitionSetup
Variation definition selector property defines a property that allows users to select the variation definition to use for a product from a dropdown (can only be set on product configuration)
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

AttributeSetup
Defines an attribute connection to a configuration, allowing users to set data for an attribute on the product, variant or category using the configuration this attribute setup is added to
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


GET /catalogues/{uid}/children Get all children to a catalogue

Request parameters

Property name Parameter type Data type Description
uid path string

Unique id of catalogue

Response status OK (200)

array : CategoryModel
CategoryModel
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)


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

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)

object : CategoriesResultSet
CategoriesResultSet
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

CategoryModel
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)


GET /catalogues/uids Get Uids of all catalogues in the system

Response status OK (200)

array : string