GET /catalogues Get all catalogues in the system

[
  {
    "Uid": "40439db3-fd6a-4987-977b-eb14ca190d0e",
    "Alias": "MasterCatalogue",
    "Label": "Master catalogue",
    "IsMaster": true,
    "SortOrder": 1,
    "IdentifierDefinitions": [
      {
        "Uid": "4d2a58ca-0acc-4636-ba53-24eda28f320c",
        "Alias": "ERPRef",
        "IdentifierPattern": "{0}",
        "IdentifierAttributes": [
          "aca82c22-b169-4cc9-819d-8eb163f20c43"
        ]
      }
    ],
    "Configuration": {
      "NameConfiguration": {
        "NamePattern": "{0}",
        "NameAttributes": [
          "8722dcde-38cd-4b7b-a2db-27572a58d4de"
        ]
      },
      "Tabs": [
        {
          "Label": "General",
          "Sections": [
            {
              "Headline": "Basic information",
              "Properties": [
                {
                  "AttributeUid": "8722dcde-38cd-4b7b-a2db-27572a58d4de",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "241dcd3d-14c7-4da7-88a5-981c94edb82e",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "9f02d3a6-1277-4fed-9c47-835fb91ea081",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "071574b3-5df6-4a25-9070-dadc4aab07f2",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "743fa649-b28d-451f-b049-2e776fe01168",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "c818b710-1b50-4155-87e3-5adf7d0b8352",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "39ab9fc6-bab7-4373-a23d-a1d7a6a8bbc4",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "260f843c-924f-418e-9379-39032bec6d47",
          "Type": "DynamicTabSetup"
        }
      ]
    }
  },
  {
    "Uid": "051ef226-99dc-4bef-a85a-22f79690443a",
    "Alias": "USSalesCatalogue",
    "Label": "Sales catalogue (US)",
    "IsMaster": true,
    "SortOrder": 2,
    "IdentifierDefinitions": [
      {
        "Uid": "33e0c44c-39f6-4426-a400-ccc0ff3c6f30",
        "Alias": "ERPRef",
        "IdentifierPattern": "{0}",
        "IdentifierAttributes": [
          "7f1461f3-d2b2-4d89-8e3d-949dbd1c12bb"
        ]
      }
    ],
    "Configuration": {
      "NameConfiguration": {
        "NamePattern": "{0}",
        "NameAttributes": [
          "8722dcde-38cd-4b7b-a2db-27572a58d4de"
        ]
      },
      "Tabs": [
        {
          "Label": "General",
          "Sections": [
            {
              "Headline": "Basic information",
              "Properties": [
                {
                  "AttributeUid": "8722dcde-38cd-4b7b-a2db-27572a58d4de",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "0d9740cb-8e4c-4e03-9089-6c5e82c4d13b",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "9e50988c-7143-43a3-a5ed-a8bb6448d7b6",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "d11ec39d-8b49-4a41-bb25-60dd273b1a1f",
          "Type": "DynamicTabSetup"
        }
      ]
    }
  }
]

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

VariantGroupVariantsTabSetup

Variant group variants tab displays all variants of a variant and can only be added to variant group 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

VariantGroupsTabSetup

Variant groups tab displays all variant groups 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

ExternalTabSetup

Shows an external website

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

DynamicCategoryRuleDesignerTabSetup

Tab that allows setting up which products shall be placed in this category.

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

NoteSectionSetup

Section which shows notes

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

EntityReferencesSetup

Show references to the entity from other entities

Property name	Data type	Description
ReferencingAttributeUid	string	Uid of attribute to show references for
ReferencingEntityType	string	Type of entity to show references for
Label	string	Label to show for the property in the backoffice
Description	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

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

WorkflowStateSetup

Workflow state property allows users to the view and change the workflow state of entities

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": "9b65f00e-f04b-44b1-a7d5-4db32978f423",
  "Alias": "MasterCatalogue",
  "Label": "Master catalogue",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "1b23086a-95a3-450e-aae8-a29b801cd9b1",
      "Alias": "ERPRef",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "fd279d60-d7e6-462b-916e-212ca5b4588c"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "{0}",
      "NameAttributes": [
        "186e9d64-03ce-454f-8325-0aeab462d072"
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Properties": [
              {
                "AttributeUid": "186e9d64-03ce-454f-8325-0aeab462d072",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "9e44e37b-e27c-4e58-a1ad-4f8e40468cbc",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "7e565e33-5b38-491b-bb8a-4b4c2502c595",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "1fe3f4f7-3b32-486d-85ed-7c394b9621f9",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "c23e50d9-e6eb-43ef-bbc9-b0ce8a2e801f",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "18824e3e-6110-4b53-ace0-809cd0f86951",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "33521a6d-623f-4a8a-afbb-0b22fb91b83b",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "662296a6-90e7-43c6-a48a-afef44fc6ef0",
        "Type": "DynamicTabSetup"
      }
    ]
  }
}

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

VariantGroupVariantsTabSetup

Variant group variants tab displays all variants of a variant and can only be added to variant group 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

VariantGroupsTabSetup

Variant groups tab displays all variant groups 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

ExternalTabSetup

Shows an external website

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

DynamicCategoryRuleDesignerTabSetup

Tab that allows setting up which products shall be placed in this category.

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

NoteSectionSetup

Section which shows notes

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

EntityReferencesSetup

Show references to the entity from other entities

Property name	Data type	Description
ReferencingAttributeUid	string	Uid of attribute to show references for
ReferencingEntityType	string	Type of entity to show references for
Label	string	Label to show for the property in the backoffice
Description	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

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

WorkflowStateSetup

Workflow state property allows users to the view and change the workflow state of entities

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)

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

{
  "Uid": "8acb3249-c12d-455c-b213-0540dadf44c9",
  "Alias": "MasterCatalogue",
  "Label": "Master catalogue",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "2cf93e9a-19cb-4718-b3dd-4775ea59410a",
      "Alias": "ERPRef",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "273914df-0625-449f-b639-fbaa5335d5a4"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "{0}",
      "NameAttributes": [
        "b2a6993c-4eda-4ea3-be95-c2c7e5d4a5b5"
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Properties": [
              {
                "AttributeUid": "b2a6993c-4eda-4ea3-be95-c2c7e5d4a5b5",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "e14dbaa7-0ddc-4f15-bf35-5ec39089411f",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "32d418ff-a21b-48bf-995a-3ff58ba449a8",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "66d400c0-a183-41e4-8658-c391eeebea1c",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "907d5752-82ab-4a99-8151-7f426f2b7347",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "5fd0063e-14d8-4482-945d-7b1a96c7ae6d",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "c808062c-7a20-45da-b79f-8ce893fa1065",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "f13caea8-b641-4fbb-b4c1-cefcf687ff0c",
        "Type": "DynamicTabSetup"
      }
    ]
  }
}

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

VariantGroupVariantsTabSetup

Variant group variants tab displays all variants of a variant and can only be added to variant group 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

VariantGroupsTabSetup

Variant groups tab displays all variant groups 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

ExternalTabSetup

Shows an external website

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

DynamicCategoryRuleDesignerTabSetup

Tab that allows setting up which products shall be placed in this category.

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

NoteSectionSetup

Section which shows notes

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

EntityReferencesSetup

Show references to the entity from other entities

Property name	Data type	Description
ReferencingAttributeUid	string	Uid of attribute to show references for
ReferencingEntityType	string	Type of entity to show references for
Label	string	Label to show for the property in the backoffice
Description	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

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

WorkflowStateSetup

Workflow state property allows users to the view and change the workflow state of entities

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)

No body message is returned

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

{
  "Uid": "0b9b0ad6-7c37-451a-b46d-8afaee83595e",
  "Alias": "MasterCatalogue",
  "Label": "Master catalogue",
  "IsMaster": true,
  "SortOrder": 1,
  "IdentifierDefinitions": [
    {
      "Uid": "ac057438-3b9a-4d31-9c82-5f0bc9806eb4",
      "Alias": "ERPRef",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "8bcadaea-66ea-4667-bb24-1a3316bc2cbb"
      ]
    }
  ],
  "Configuration": {
    "NameConfiguration": {
      "NamePattern": "{0}",
      "NameAttributes": [
        "3bdb6005-22fd-4f6e-9610-fcf6fb270977"
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Properties": [
              {
                "AttributeUid": "3bdb6005-22fd-4f6e-9610-fcf6fb270977",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "86d15ae4-8d1f-455c-99e3-67d20574f53e",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "32d62124-2ee7-46a6-9aea-8ac4d73bb377",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "cf15df6c-2add-4df2-be27-21851d390232",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "2c39bb8a-48e0-4964-b935-48dd3275f5e6",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "257bcd02-f433-4255-909a-2919be1a019b",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "f3b93080-9282-45ab-afb8-8618ad0361b7",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "f1f06894-8c73-4b70-b393-0a33d0281d48",
        "Type": "DynamicTabSetup"
      }
    ]
  }
}

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

VariantGroupVariantsTabSetup

Variant group variants tab displays all variants of a variant and can only be added to variant group 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

VariantGroupsTabSetup

Variant groups tab displays all variant groups 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

ExternalTabSetup

Shows an external website

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

DynamicCategoryRuleDesignerTabSetup

Tab that allows setting up which products shall be placed in this category.

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

NoteSectionSetup

Section which shows notes

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

EntityReferencesSetup

Show references to the entity from other entities

Property name	Data type	Description
ReferencingAttributeUid	string	Uid of attribute to show references for
ReferencingEntityType	string	Type of entity to show references for
Label	string	Label to show for the property in the backoffice
Description	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

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

WorkflowStateSetup

Workflow state property allows users to the view and change the workflow state of entities

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": "d20d22de-784c-48d8-bfe2-6814a4653704",
    "Created": "2024-08-12T15:17:54.2115756+02:00",
    "CreatedBy": "Struct admin",
    "LastModified": "2024-10-21T15:17:54.2115756+02:00",
    "LastModifiedBy": "Struct support",
    "HasChildren": true,
    "Name": {
      "en-GB": "Electronics",
      "da-DK": "Elektronik"
    },
    "Dynamic": false
  },
  {
    "Id": 11,
    "SortOrder": 1,
    "CatalogueUid": "d20d22de-784c-48d8-bfe2-6814a4653704",
    "Created": "2024-08-22T15:17:54.2115756+02:00",
    "CreatedBy": "Struct admin",
    "LastModified": "2024-11-10T14:17:54.2115756+01: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)

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

DynamicQueryContainer

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

QueryModel

This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type

SimpleQueryModel

Simple query model used for querying specific fields

Property name

Data type

Description

Filters

array : FieldFilterModel

List of filter conditions

BooleanOperator

string

The operator of the query. Can be any of:

And / 0 (All conditions must match)
Or / 1 (At least one of the provided conditions must match)

QueryModelType

string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel

Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries

Property name

Data type

Description

SubQueries

array : QueryModel

Sub queries to execute

BooleanOperator

string

The operator of the query. Can be any of:

And / 0 (All conditions must match)
Or / 1 (At least one of the provided conditions must match)

QueryModelType

string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel

Property name

Data type

Description

FieldUid

string

Uid of field to query

QueryOperator

string

Operator to use for query. Can be any of:

Equals / 0 (Value must start with FilterValue)
WildcardEquals / 1 (Value must be smaller than FilterValue)
SmallerThan / 2 (Value must be smaller than FilterValue)
LargerThan / 3 (Value must be larger than FilterValue)
IsEmpty / 4 (Value must be empty)
IsNotEmpty / 5 (Value must not be empty)
Contains / 6 (Value must contain FilterValue)
NotContains / 7 (Value must not contain FilterValue)
NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
NotWildcardEquals / 9 (Value must not start with FilterValue)
InList / 10 (Item field value must match any of the in provided values in FilterList)

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": "f769a9a4-d389-4cd1-831e-5ec8895974ff",
      "Created": "2024-08-12T15:17:54.2105714+02:00",
      "CreatedBy": "Struct admin",
      "LastModified": "2024-10-21T15:17:54.2105714+02:00",
      "LastModifiedBy": "Struct support",
      "HasChildren": true,
      "Name": {
        "en-GB": "Electronics",
        "da-DK": "Elektronik"
      },
      "Dynamic": false
    },
    {
      "Id": 11,
      "SortOrder": 1,
      "CatalogueUid": "f769a9a4-d389-4cd1-831e-5ec8895974ff",
      "Created": "2024-08-22T15:17:54.2105714+02:00",
      "CreatedBy": "Struct admin",
      "LastModified": "2024-11-10T14:17:54.2105714+01: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)

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

DynamicQueryContainer

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

QueryModel

This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type

SimpleQueryModel

Simple query model used for querying specific fields

Property name

Data type

Description

Filters

array : FieldFilterModel

List of filter conditions

BooleanOperator

string

The operator of the query. Can be any of:

And / 0 (All conditions must match)
Or / 1 (At least one of the provided conditions must match)

QueryModelType

string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel

Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries

Property name

Data type

Description

SubQueries

array : QueryModel

Sub queries to execute

BooleanOperator

string

The operator of the query. Can be any of:

And / 0 (All conditions must match)
Or / 1 (At least one of the provided conditions must match)

QueryModelType

string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel

Property name

Data type

Description

FieldUid

string

Uid of field to query

QueryOperator

string

Operator to use for query. Can be any of:

Equals / 0 (Value must start with FilterValue)
WildcardEquals / 1 (Value must be smaller than FilterValue)
SmallerThan / 2 (Value must be smaller than FilterValue)
LargerThan / 3 (Value must be larger than FilterValue)
IsEmpty / 4 (Value must be empty)
IsNotEmpty / 5 (Value must not be empty)
Contains / 6 (Value must contain FilterValue)
NotContains / 7 (Value must not contain FilterValue)
NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
NotWildcardEquals / 9 (Value must not start with FilterValue)
InList / 10 (Item field value must match any of the in provided values in FilterList)

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

[
  "1df1cd68-bff7-41b5-b927-23cbc922f894",
  "d44b298c-f857-413b-ab29-05cf611ddcbc",
  "1b726a9a-8472-4007-a68c-588372ac76ee"
]

Response status OK (200)

array : string

# Catalogues

GET /catalogues Get all catalogues in the system

Response status OK (200)

POST /catalogues Create new catalogue

Request parameters

Response status OK (200)

DELETE /catalogues Delete a catalogue

Request parameters

Response status OK (200)

PATCH /catalogues Update a catalogue

Request parameters

Response status OK (200)

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

Request parameters

Response status OK (200)

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

Request parameters

Response status OK (200)

GET /catalogues/{uid}/descendants Get all categories in a catalogue

Request parameters

Response status OK (200)

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

Response status OK (200)