# ProductStructures

#Available from v.3.2.0 Product structures define models for products and variants in the system. Specifically, product structures define which properties are available on products and variants as well as how they are presented in the backoffice UI within tabs and sections.

GET /productstructures Get all product structures

#Available from v.3.4.0

[
  {
    "Uid": "2e67fb64-3cf6-4cab-9bf8-f95293b8723e",
    "Alias": "NonFood",
    "Label": "Non-food",
    "HasVariants": true,
    "HasVariantGroups": false,
    "ProductConfiguration": {
      "ThumbnailReference": "Product_f80a69dd-c0b7-49f8-94f0-6367aab38380",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "31f10ab4-c2f4-4f87-b9ce-da515bf89cc1",
          "116c89b8-eced-4837-b28c-f9178cfb3574"
        ]
      },
      "CreateWizard": {
        "Uid": "b2abce86-685a-41a8-949f-19660ae3cd08",
        "Steps": [
          {
            "Properties": [
              {
                "PropertyUid": "830da615-828d-4d03-8e0b-9574c8515f67",
                "Mandatory": true,
                "Uid": "cf73eeaf-5312-4106-b7dd-96358b2b8f90",
                "Type": "AttributeWizardPropertySetup"
              },
              {
                "PropertyUid": "26bc4e68-4a65-4f64-9c1a-16d6284290a1",
                "Mandatory": false,
                "Uid": "2f0a8976-f0ae-491d-b8e4-187943b195cd",
                "Type": "AttributeWizardPropertySetup"
              }
            ],
            "Uid": "48bdba0e-dbaa-4601-8e11-1b777a647604",
            "Headline": "Step 1 - basic information",
            "Description": "Add basic information about the product",
            "Type": "DynamicWizardStepSetup"
          },
          {
            "Properties": [
              {
                "PropertyUid": "6e8ffb3f-5fd7-4c74-abf8-4c9ba64665f0",
                "Mandatory": true,
                "Uid": "d255b812-07d9-4a1c-a200-be1ad61c59f7",
                "Type": "AttributeWizardPropertySetup"
              }
            ],
            "Uid": "2bece360-1fc1-4912-8957-38b9a2567e3b",
            "Headline": "Step 2 - Media",
            "Description": "Add an image to the product",
            "Type": "DynamicWizardStepSetup"
          }
        ]
      },
      "Tabs": [
        {
          "Label": "General",
          "Sections": [
            {
              "Headline": "Basic information",
              "Description": "Basic information about the product",
              "Properties": [
                {
                  "AttributeUid": "116c89b8-eced-4837-b28c-f9178cfb3574",
                  "ReadOnly": false,
                  "Mandatory": true,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "830da615-828d-4d03-8e0b-9574c8515f67",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "31f10ab4-c2f4-4f87-b9ce-da515bf89cc1",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "26bc4e68-4a65-4f64-9c1a-16d6284290a1",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "01cc15bb-92da-4209-884d-ca356b17e95d",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "e8c2a79c-2d4c-4b8d-a16f-5a1104d9ada7",
                  "Type": "AttributeSetup"
                },
                {
                  "DisplayName": "Variant type",
                  "DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
                  "Uid": "8784eda1-11ef-4a39-b505-2b6c0d68b1fd",
                  "Type": "VariationDefinitionSetup"
                }
              ],
              "Uid": "823d542b-6297-490e-82c7-c81be7d816b9",
              "Type": "DynamicSectionSetup"
            },
            {
              "Headline": "Weight & Size information",
              "Properties": [
                {
                  "AttributeUid": "cf8b9f73-0088-4685-8728-5f47ab38ae48",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "56f9efcf-0c8e-4b0c-8aba-3a27e62d3654",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "571163cf-73ba-4500-8f46-417644f3ee2c",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "42f40ea1-9161-40b0-9f01-bf5bd9245c96",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "9f0b0a34-5538-41db-9e29-0d655f290a07",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "d414d31c-ddd8-4a55-a80c-96a0bf67596d",
          "Type": "DynamicTabSetup"
        },
        {
          "Label": "Media",
          "Sections": [
            {
              "Headline": "Images",
              "Description": "Manage primary image and environment images for product",
              "Properties": [
                {
                  "AttributeUid": "f80a69dd-c0b7-49f8-94f0-6367aab38380",
                  "ReadOnly": false,
                  "Mandatory": true,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "6e8ffb3f-5fd7-4c74-abf8-4c9ba64665f0",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "f2dab98b-620a-4886-b4b7-4636059a7953",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "c223a38b-e3af-4d8b-89ad-53ccc02fb1b0",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "65fb8fad-7189-4cb8-bd9d-50b299147cbf",
              "Type": "DynamicSectionSetup"
            },
            {
              "Headline": "Videos",
              "Properties": [
                {
                  "AttributeUid": "7dbe8429-547a-4fa8-9540-752c66e8d780",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "e05c7ec9-5fec-4a8e-9e49-ff2eb566d1d4",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "fbe56a1b-0861-449c-8bd5-5e4feb584e7d",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "9a89f63e-ecee-47cf-91c0-adc777d39789",
          "Type": "DynamicTabSetup"
        },
        {
          "Uid": "c8c02b22-e8e1-46e1-8176-0d504cfb67bc",
          "Type": "ClassificationsTabSetup"
        },
        {
          "Uid": "5c72b1cb-07d7-4b5e-84b0-f4e86c66ece0",
          "Type": "VariantsTabSetup"
        }
      ]
    },
    "VariantConfiguration": {
      "ThumbnailReference": "Variant_f80a69dd-c0b7-49f8-94f0-6367aab38380",
      "CreateWizard": {
        "Uid": "ec5ad5a0-db59-4256-8e5f-e91d1046d5aa",
        "Steps": [
          {
            "Properties": [
              {
                "PropertyUid": "2cb7aba7-912c-4af1-95a6-f8f8ef3b6af0",
                "Mandatory": true,
                "Uid": "7a322bb0-d4ca-47e4-82d6-bbbfe6a2e135",
                "Type": "AttributeWizardPropertySetup"
              }
            ],
            "Uid": "67905d10-ca40-49dd-974f-476d6d06a51b",
            "Headline": "Step 1 - basic information",
            "Description": "Add basic information about the variant",
            "Type": "DynamicWizardStepSetup"
          }
        ]
      },
      "Tabs": [
        {
          "Label": "General",
          "Sections": [
            {
              "Headline": "Basic information",
              "Description": "Basic information about the variant",
              "Properties": [
                {
                  "AttributeUid": "0f6694f0-4f32-47c1-acc0-08c81ac2e02f",
                  "ReadOnly": false,
                  "Mandatory": true,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "2cb7aba7-912c-4af1-95a6-f8f8ef3b6af0",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "a76a1746-8473-459a-bb3e-a00bedac97b9",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "15d3437e-2f51-4c9a-a865-3e78b0800912",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "9bafc771-b761-46c4-8c11-26cca1342a0c",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "87dd8ef3-2c2b-457f-b441-3baf30ac1cd7",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "99389e4d-e95e-4eed-bef8-0274968095cc",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "665dd6c7-d961-4236-b41d-8fc55c892ba6",
          "Type": "DynamicTabSetup"
        },
        {
          "Label": "Media",
          "Sections": [
            {
              "Headline": "Images",
              "Description": "View and override product image if necessary",
              "Properties": [
                {
                  "AttributeUid": "f80a69dd-c0b7-49f8-94f0-6367aab38380",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": true,
                  "Uid": "f817445a-009f-4441-b545-b1c4a3f9fdff",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "73830fcd-2f57-4334-8375-29f5a485c5dc",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "05e408e1-cfa1-4cb8-8d90-a4fe041f08e6",
          "Type": "DynamicTabSetup"
        }
      ]
    },
    "VariationDefinitions": [
      {
        "Uid": "47c77241-964f-4af8-920b-6328fb77a92a",
        "Alias": "ColorVariants",
        "Name": "Color variants",
        "NameConfiguration": {
          "NamePattern": "{0} - {1}",
          "NameAttributes": [
            "0f6694f0-4f32-47c1-acc0-08c81ac2e02f",
            "a76a1746-8473-459a-bb3e-a00bedac97b9"
          ]
        },
        "DefiningAttributes": [
          "a76a1746-8473-459a-bb3e-a00bedac97b9"
        ],
        "SortOrder": 1
      },
      {
        "Uid": "936b7941-9129-4792-8dc5-40a02f617f81",
        "Alias": "SizeVariants",
        "Name": "Size variants",
        "NameConfiguration": {
          "NamePattern": "{0} - {1}",
          "NameAttributes": [
            "0f6694f0-4f32-47c1-acc0-08c81ac2e02f",
            "9bafc771-b761-46c4-8c11-26cca1342a0c"
          ]
        },
        "DefiningAttributes": [
          "9bafc771-b761-46c4-8c11-26cca1342a0c"
        ],
        "SortOrder": 1
      },
      {
        "Uid": "31401933-5cbe-41d0-ac97-3c78f4ce96f6",
        "Alias": "ColorAndSizeVariants",
        "Name": "Color/size variants",
        "NameConfiguration": {
          "NamePattern": "{0} - {1} / {2}",
          "NameAttributes": [
            "0f6694f0-4f32-47c1-acc0-08c81ac2e02f",
            "a76a1746-8473-459a-bb3e-a00bedac97b9",
            "9bafc771-b761-46c4-8c11-26cca1342a0c"
          ]
        },
        "DefiningAttributes": [
          "a76a1746-8473-459a-bb3e-a00bedac97b9",
          "9bafc771-b761-46c4-8c11-26cca1342a0c"
        ],
        "SortOrder": 3
      }
    ],
    "ProductIdentifierDefinitions": [
      {
        "Uid": "6c1a6f25-84ed-4af3-b338-01116fa5ebb2",
        "Alias": "ModelNoIdentifier",
        "IdentifierPattern": "{0}",
        "IdentifierAttributes": [
          "31f10ab4-c2f4-4f87-b9ce-da515bf89cc1"
        ]
      }
    ],
    "VariantIdentifierDefinitions": [
      {
        "Uid": "dadc4835-2e8e-4caa-91df-bfebdb357ae0",
        "Alias": "SKUIdentifier",
        "IdentifierPattern": "{0}",
        "IdentifierAttributes": [
          "0f6694f0-4f32-47c1-acc0-08c81ac2e02f"
        ]
      }
    ]
  }
]

Response status OK (200)

array : ProductStructure

ProductStructure

Property name	Data type	Description
Uid	string	Unique id of product structure
Alias	string	Unique human readable alias of product structure
Label	string	Presented name of product structure in backoffice
HasVariants	boolean	Indicates whether products using this product structure can have variants. VariantConfiguration is required when this is true
HasVariantGroups	boolean	Indicates whether products using this product structure can have variant groups. VariantGroupConfiguration is required when this is true
ProductConfiguration	object : ProductConfiguration	The configuration of tabs, sections and properties for products using this configuration
VariantGroupConfiguration	object : VariantGroupConfiguration	The configuration of tabs, sections and properties of variant groups using this configuration (only needed when HasVariantGroups is true)
VariantConfiguration	object : VariantConfiguration	The configuration of tabs, sections and properties of variants using this configuration (only needed when HasVariants is true)
VariationDefinitions	array : VariationDefinition	Defines different variant variations (eg. some products have variants of color/size, others of width/length, others again of just color and so on.)
AlwaysOnDefiningAttributes	array	Set defining attributes that must always be available no matter if they are part of the variation definition for a variant or not
ProductIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a model number and the internal id of a product in the system
VariantGroupIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a model number and the internal id of a variant group
VariantIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a SKU and the internal id of the variant

ProductConfiguration

Property name	Data type	Description
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the product. Use Product_[attributeUid] to reference a media attribute on the Product configuration itself Variant_[attributeUid] to reference a media attribute on the Product configuration of the Product structure and
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for products (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 product using this Product configuration [Optional]
CopyWizard	object : WizardSetup	The step wizard presented to users when copying a new product using this Product configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on products using this product 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

VariantGroupConfiguration

Property name	Data type	Description
GroupingAttributes	array	Attributes to group variants by. All variants with the same values as a variant group in the specified Grouping attributes will be associated to that variant group
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the product. Use VariantGroup_[attributeUid] to reference a media attribute on the Variant group configuration itself
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for variant groups (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 variant group using this Variant Group configuration [Optional]
CopyWizard	object : WizardSetup	The step wizard presented to users when copying a new Variant group using this Variant group configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on Variant groups using this Variant group configuration in the backoffice

VariantConfiguration

Property name	Data type	Description
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the variant. Use Product_[attributeUid] to reference a media attribute on the Product configuration of the Product structure and Variant_[attributeUid] to reference a media attribute on the Variant configuration itself
CreateWizard	object : WizardSetup	The step wizard presented to users when creating a new variant using this Variant configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on variants using this variant configuration in the backoffice

VariationDefinition

Property name	Data type	Description
Uid	string	Unique id of variation definition
Alias	string	Unique human readable identifier for variation definition
Name	string	Presented name of variation definition in backoffice
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for variants (names are shown in tree view and when a reference to the item is shown in backoffice)
DefiningAttributes	array	Uid of the attributes which are defining for variants using this variation definition (eg. uid of color attribute, uids of color and size attribute etc.)
SortOrder	integer	The presented sortorder of the variation definition in backoffice

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)

PUT /productstructures Update a product structure

#Available from v.3.2.0

{
  "Uid": "ce5766c1-79dd-41f0-8ea4-63ccabcb040a",
  "Alias": "NonFood",
  "Label": "Non-food",
  "HasVariants": true,
  "HasVariantGroups": false,
  "ProductConfiguration": {
    "ThumbnailReference": "Product_de182445-fc00-486a-aa51-4fb622956338",
    "NameConfiguration": {
      "NamePattern": "{0} - {1}",
      "NameAttributes": [
        "9552ab04-88af-40f2-be38-95c3e257ec23",
        "11f2816e-fe8b-43b0-85be-88a09aedc677"
      ]
    },
    "CreateWizard": {
      "Uid": "983936bc-2367-454c-9d49-08d836d9e661",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "3ce577c6-2c71-4aa6-ac5a-a15cc09ce7a8",
              "Mandatory": true,
              "Uid": "58307bbc-5cd8-4de7-a57d-3381a26f7163",
              "Type": "AttributeWizardPropertySetup"
            },
            {
              "PropertyUid": "0fab9ab8-7ff4-4794-abd8-e623b5bbe07b",
              "Mandatory": false,
              "Uid": "28b86e3e-dfbe-4e4a-b389-a7a6fd80adca",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "211cb753-7495-4865-95ac-9cd959856447",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the product",
          "Type": "DynamicWizardStepSetup"
        },
        {
          "Properties": [
            {
              "PropertyUid": "e2ea963f-603d-4e6b-b132-e081f96ab141",
              "Mandatory": true,
              "Uid": "67b14181-1db7-40eb-b018-5431768c8380",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "10cab4f2-e3ed-46f0-a8ce-2616f7c07c2a",
          "Headline": "Step 2 - Media",
          "Description": "Add an image to the product",
          "Type": "DynamicWizardStepSetup"
        }
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "Basic information about the product",
            "Properties": [
              {
                "AttributeUid": "11f2816e-fe8b-43b0-85be-88a09aedc677",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "3ce577c6-2c71-4aa6-ac5a-a15cc09ce7a8",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "9552ab04-88af-40f2-be38-95c3e257ec23",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "0fab9ab8-7ff4-4794-abd8-e623b5bbe07b",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "2763c47b-756b-4dd0-aeb0-f7de5b2c6d0d",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "03d6245f-5273-4cf0-b354-06299dc12793",
                "Type": "AttributeSetup"
              },
              {
                "DisplayName": "Variant type",
                "DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
                "Uid": "ddfd0af5-7c84-4f14-89f0-93040373ef68",
                "Type": "VariationDefinitionSetup"
              }
            ],
            "Uid": "4b7037dd-6a2e-4c3e-97c2-d91e6ed8fa67",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Weight & Size information",
            "Properties": [
              {
                "AttributeUid": "6537646c-dc3d-4b9a-832b-d2d6eab538b3",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "1fc7eca2-b661-477c-8ab6-14a6b076a726",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "e193fe13-453c-4dec-8586-323d25a03f1f",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "556b3399-54ac-4593-918f-a977dcb82420",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "c4ec5082-9fa8-4114-9379-d143a5701960",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "deaedf74-318b-46ee-87f7-00aeb7f9abf3",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "Manage primary image and environment images for product",
            "Properties": [
              {
                "AttributeUid": "de182445-fc00-486a-aa51-4fb622956338",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "e2ea963f-603d-4e6b-b132-e081f96ab141",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "1b2286b8-1ed1-4e92-91cc-2d1fedcef2d7",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "fb7f3b02-fff3-4f39-8aeb-d99bf6be0c2e",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "8b6c5c3b-e1dc-4fb4-b8d9-cbfc7a11eaa9",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Videos",
            "Properties": [
              {
                "AttributeUid": "f7059402-fd9b-4732-a97f-e56e8b44f00b",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "9b786f25-6b16-47de-b2ae-455437ea398d",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "cbb893d1-e52e-42bf-97e9-022fd1e68d7d",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "cb249b0c-0858-4738-8dd9-be2bd343ad4d",
        "Type": "DynamicTabSetup"
      },
      {
        "Uid": "300716cc-1bcd-4671-8351-23396d763d73",
        "Type": "ClassificationsTabSetup"
      },
      {
        "Uid": "ca9d7ca8-fa75-4e78-9a03-0da28ec1ebdb",
        "Type": "VariantsTabSetup"
      }
    ]
  },
  "VariantConfiguration": {
    "ThumbnailReference": "Variant_de182445-fc00-486a-aa51-4fb622956338",
    "CreateWizard": {
      "Uid": "3e1de671-3088-42b6-b58c-fcebf9486ac1",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "4a5fb8d0-eb10-4845-92e2-e9d3cb0d14d0",
              "Mandatory": true,
              "Uid": "7f349b00-e4f4-4613-9667-8af35150fa49",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "213e5cf7-2757-4247-a397-12c09a85c18a",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the variant",
          "Type": "DynamicWizardStepSetup"
        }
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "Basic information about the variant",
            "Properties": [
              {
                "AttributeUid": "00ea261c-03bc-4af9-8e15-189daa7daa58",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "4a5fb8d0-eb10-4845-92e2-e9d3cb0d14d0",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "d91c54b5-de86-46f8-b042-dfd49f09e072",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "ccf8a892-f894-4005-9e42-3422f149a196",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "2a7097c3-9710-42e1-acb6-7118348dd3ab",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "c8e08fe1-5213-4e07-aabb-3cf60084962b",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "74190199-7a6a-4bf2-8e53-250acf49e348",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "afa9eb98-0588-4eb8-97d0-7d9ec07bd515",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "View and override product image if necessary",
            "Properties": [
              {
                "AttributeUid": "de182445-fc00-486a-aa51-4fb622956338",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": true,
                "Uid": "f35aa055-3f00-4093-bf4d-127e2dbf44cf",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "94b6e918-5190-490a-bb27-14ae7140df47",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "fc057479-1fb4-4b83-8e00-8fd9a826235a",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "4cd8fa01-9693-44bb-86b4-db87ed87a408",
      "Alias": "ColorVariants",
      "Name": "Color variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "00ea261c-03bc-4af9-8e15-189daa7daa58",
          "d91c54b5-de86-46f8-b042-dfd49f09e072"
        ]
      },
      "DefiningAttributes": [
        "d91c54b5-de86-46f8-b042-dfd49f09e072"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "f54a4cb7-6ce0-41d4-919e-d94820b318e0",
      "Alias": "SizeVariants",
      "Name": "Size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "00ea261c-03bc-4af9-8e15-189daa7daa58",
          "2a7097c3-9710-42e1-acb6-7118348dd3ab"
        ]
      },
      "DefiningAttributes": [
        "2a7097c3-9710-42e1-acb6-7118348dd3ab"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "925dff34-df50-4913-8eec-338a1b7ffc7f",
      "Alias": "ColorAndSizeVariants",
      "Name": "Color/size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1} / {2}",
        "NameAttributes": [
          "00ea261c-03bc-4af9-8e15-189daa7daa58",
          "d91c54b5-de86-46f8-b042-dfd49f09e072",
          "2a7097c3-9710-42e1-acb6-7118348dd3ab"
        ]
      },
      "DefiningAttributes": [
        "d91c54b5-de86-46f8-b042-dfd49f09e072",
        "2a7097c3-9710-42e1-acb6-7118348dd3ab"
      ],
      "SortOrder": 3
    }
  ],
  "ProductIdentifierDefinitions": [
    {
      "Uid": "137f0637-b620-4ff5-b9a1-f48a6d956129",
      "Alias": "ModelNoIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "9552ab04-88af-40f2-be38-95c3e257ec23"
      ]
    }
  ],
  "VariantIdentifierDefinitions": [
    {
      "Uid": "253e903e-3471-4fb4-91e3-505f631db130",
      "Alias": "SKUIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "00ea261c-03bc-4af9-8e15-189daa7daa58"
      ]
    }
  ]
}

Request parameters

Property name	Parameter type	Data type	Description
model	body	object : ProductStructure	Updated product structure

ProductStructure

Property name	Data type	Description
Uid	string	Unique id of product structure
Alias	string	Unique human readable alias of product structure
Label	string	Presented name of product structure in backoffice
HasVariants	boolean	Indicates whether products using this product structure can have variants. VariantConfiguration is required when this is true
HasVariantGroups	boolean	Indicates whether products using this product structure can have variant groups. VariantGroupConfiguration is required when this is true
ProductConfiguration	object : ProductConfiguration	The configuration of tabs, sections and properties for products using this configuration
VariantGroupConfiguration	object : VariantGroupConfiguration	The configuration of tabs, sections and properties of variant groups using this configuration (only needed when HasVariantGroups is true)
VariantConfiguration	object : VariantConfiguration	The configuration of tabs, sections and properties of variants using this configuration (only needed when HasVariants is true)
VariationDefinitions	array : VariationDefinition	Defines different variant variations (eg. some products have variants of color/size, others of width/length, others again of just color and so on.)
AlwaysOnDefiningAttributes	array	Set defining attributes that must always be available no matter if they are part of the variation definition for a variant or not
ProductIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a model number and the internal id of a product in the system
VariantGroupIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a model number and the internal id of a variant group
VariantIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a SKU and the internal id of the variant

ProductConfiguration

Property name	Data type	Description
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the product. Use Product_[attributeUid] to reference a media attribute on the Product configuration itself Variant_[attributeUid] to reference a media attribute on the Product configuration of the Product structure and
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for products (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 product using this Product configuration [Optional]
CopyWizard	object : WizardSetup	The step wizard presented to users when copying a new product using this Product configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on products using this product 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

VariantGroupConfiguration

Property name	Data type	Description
GroupingAttributes	array	Attributes to group variants by. All variants with the same values as a variant group in the specified Grouping attributes will be associated to that variant group
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the product. Use VariantGroup_[attributeUid] to reference a media attribute on the Variant group configuration itself
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for variant groups (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 variant group using this Variant Group configuration [Optional]
CopyWizard	object : WizardSetup	The step wizard presented to users when copying a new Variant group using this Variant group configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on Variant groups using this Variant group configuration in the backoffice

VariantConfiguration

Property name	Data type	Description
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the variant. Use Product_[attributeUid] to reference a media attribute on the Product configuration of the Product structure and Variant_[attributeUid] to reference a media attribute on the Variant configuration itself
CreateWizard	object : WizardSetup	The step wizard presented to users when creating a new variant using this Variant configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on variants using this variant configuration in the backoffice

VariationDefinition

Property name	Data type	Description
Uid	string	Unique id of variation definition
Alias	string	Unique human readable identifier for variation definition
Name	string	Presented name of variation definition in backoffice
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for variants (names are shown in tree view and when a reference to the item is shown in backoffice)
DefiningAttributes	array	Uid of the attributes which are defining for variants using this variation definition (eg. uid of color attribute, uids of color and size attribute etc.)
SortOrder	integer	The presented sortorder of the variation definition in backoffice

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)

Response status OK (200)

No body message is returned

POST /productstructures Create new product structure

#Available from v.3.2.0

{
  "Uid": "cf95a183-db72-4578-8c1d-453c07e38c5a",
  "Alias": "NonFood",
  "Label": "Non-food",
  "HasVariants": true,
  "HasVariantGroups": false,
  "ProductConfiguration": {
    "ThumbnailReference": "Product_8c046bad-3230-45c3-bfd0-873c8a418d9e",
    "NameConfiguration": {
      "NamePattern": "{0} - {1}",
      "NameAttributes": [
        "63409442-02c1-45f7-b38f-c27ce47f904c",
        "03ee7c01-db03-4202-81bc-c8c62fb303fe"
      ]
    },
    "CreateWizard": {
      "Uid": "50b75be1-df50-4e88-ad23-8bdcf7da81dd",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "48cc5320-5af3-4b9b-a038-861e7f70fe05",
              "Mandatory": true,
              "Uid": "44661647-c9cf-4431-8cd1-97024ad2fe2a",
              "Type": "AttributeWizardPropertySetup"
            },
            {
              "PropertyUid": "e22a448b-b8b6-493a-863f-4497c55cb837",
              "Mandatory": false,
              "Uid": "39706409-a257-46da-82fd-c1e7f8349ce8",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "0a1e38c3-6ba5-4d85-b61b-72d4e7a60c64",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the product",
          "Type": "DynamicWizardStepSetup"
        },
        {
          "Properties": [
            {
              "PropertyUid": "b73fa730-71fe-4e83-8db4-06e51ffcbbe2",
              "Mandatory": true,
              "Uid": "9055f29c-e09c-4725-a582-276c906c9da7",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "273e02dd-4e19-438d-84a3-d55ebb04d7ef",
          "Headline": "Step 2 - Media",
          "Description": "Add an image to the product",
          "Type": "DynamicWizardStepSetup"
        }
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "Basic information about the product",
            "Properties": [
              {
                "AttributeUid": "03ee7c01-db03-4202-81bc-c8c62fb303fe",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "48cc5320-5af3-4b9b-a038-861e7f70fe05",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "63409442-02c1-45f7-b38f-c27ce47f904c",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "e22a448b-b8b6-493a-863f-4497c55cb837",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "70947f46-b333-4566-a500-72b983a4f84d",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "7619a064-2a6a-4be9-8e6d-ded51f9795e3",
                "Type": "AttributeSetup"
              },
              {
                "DisplayName": "Variant type",
                "DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
                "Uid": "83a3c4f8-f939-4ba1-b0b4-5db4e7cb5560",
                "Type": "VariationDefinitionSetup"
              }
            ],
            "Uid": "1e5f9db6-9968-467e-82fe-24fb34679163",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Weight & Size information",
            "Properties": [
              {
                "AttributeUid": "16ecfc94-78a8-4e17-972f-cfe827c8c658",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "a3b51501-6d7f-4bb7-8be5-55531fdcd71c",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "c039816b-fcc9-4b69-8f97-f42e9c4a8190",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "1c0e61ee-b5e4-43b8-9fd3-523d4e5e6a4f",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "091a68a0-1e24-42a9-a91c-8ecfc60fae03",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "9eaf0807-c9f8-4fa6-84d6-3030d3eafaf3",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "Manage primary image and environment images for product",
            "Properties": [
              {
                "AttributeUid": "8c046bad-3230-45c3-bfd0-873c8a418d9e",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "b73fa730-71fe-4e83-8db4-06e51ffcbbe2",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "6bd2a6a3-f2ca-4ed7-8986-aea8ac749cbe",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "4c3dccc1-3510-4e46-b20f-ee488d3c62d1",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "e96a637b-ce3c-4e04-b914-fe73b62db6d5",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Videos",
            "Properties": [
              {
                "AttributeUid": "97ccd90a-7ce1-4728-adce-423c5cee6344",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "86cca2ac-c304-4746-8f6f-3a379e3be8b8",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "02c0d581-5e2d-4346-b9d5-cdd723956c99",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "35113f64-63c2-4e46-bb8e-cc3aaca0d4a2",
        "Type": "DynamicTabSetup"
      },
      {
        "Uid": "d439cd36-cadc-4a97-b804-c43ce8489542",
        "Type": "ClassificationsTabSetup"
      },
      {
        "Uid": "3bbd3719-16ec-4dba-8d92-6f20c63bf4a0",
        "Type": "VariantsTabSetup"
      }
    ]
  },
  "VariantConfiguration": {
    "ThumbnailReference": "Variant_8c046bad-3230-45c3-bfd0-873c8a418d9e",
    "CreateWizard": {
      "Uid": "b268ed43-6266-4c82-90c0-abc87b966a42",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "bab82677-d5d6-4a78-b807-4364783343c4",
              "Mandatory": true,
              "Uid": "e8835bc4-36c4-4f34-a867-9881fd4ea56b",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "6ec024d3-aae8-4149-8014-07cf0b6dc5f6",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the variant",
          "Type": "DynamicWizardStepSetup"
        }
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "Basic information about the variant",
            "Properties": [
              {
                "AttributeUid": "935f6a72-7144-4002-b1b1-822bc1450feb",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "bab82677-d5d6-4a78-b807-4364783343c4",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "7e85d995-50df-4e20-a7a9-c16584b205cf",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "1fec1be2-6394-4c15-be49-d21a585b94c0",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "12b86882-4759-4070-9c3a-5f5ca13b01ed",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "699a1a7f-eace-4344-b0d8-330853875af5",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "35bcde92-c51a-43ff-8cba-82537f0fb314",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "ddd95e9b-c397-42e5-94a2-fc48d494442d",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "View and override product image if necessary",
            "Properties": [
              {
                "AttributeUid": "8c046bad-3230-45c3-bfd0-873c8a418d9e",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": true,
                "Uid": "b1e63fc0-7d3d-4655-9464-bdd86d86d21b",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "3a87473c-c30f-480b-a9c6-45a8e0995e39",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "c671aca2-090d-4022-8af5-fc3f8eba861f",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "76cf3bd9-05a1-4a22-b2d0-408b685ed2f2",
      "Alias": "ColorVariants",
      "Name": "Color variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "935f6a72-7144-4002-b1b1-822bc1450feb",
          "7e85d995-50df-4e20-a7a9-c16584b205cf"
        ]
      },
      "DefiningAttributes": [
        "7e85d995-50df-4e20-a7a9-c16584b205cf"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "8adb5a6f-f61b-4151-b2b4-3be163e1dd8e",
      "Alias": "SizeVariants",
      "Name": "Size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "935f6a72-7144-4002-b1b1-822bc1450feb",
          "12b86882-4759-4070-9c3a-5f5ca13b01ed"
        ]
      },
      "DefiningAttributes": [
        "12b86882-4759-4070-9c3a-5f5ca13b01ed"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "a669342e-e2d1-48f9-9143-6d26179c713c",
      "Alias": "ColorAndSizeVariants",
      "Name": "Color/size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1} / {2}",
        "NameAttributes": [
          "935f6a72-7144-4002-b1b1-822bc1450feb",
          "7e85d995-50df-4e20-a7a9-c16584b205cf",
          "12b86882-4759-4070-9c3a-5f5ca13b01ed"
        ]
      },
      "DefiningAttributes": [
        "7e85d995-50df-4e20-a7a9-c16584b205cf",
        "12b86882-4759-4070-9c3a-5f5ca13b01ed"
      ],
      "SortOrder": 3
    }
  ],
  "ProductIdentifierDefinitions": [
    {
      "Uid": "fb6b1ba4-2840-4008-8fa9-923b4c769f07",
      "Alias": "ModelNoIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "63409442-02c1-45f7-b38f-c27ce47f904c"
      ]
    }
  ],
  "VariantIdentifierDefinitions": [
    {
      "Uid": "12ba51c7-3295-48ae-a9a1-04bde35f9f6a",
      "Alias": "SKUIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "935f6a72-7144-4002-b1b1-822bc1450feb"
      ]
    }
  ]
}

Request parameters

Property name	Parameter type	Data type	Description
model	body	object : ProductStructure	Product structure to create

ProductStructure

Property name	Data type	Description
Uid	string	Unique id of product structure
Alias	string	Unique human readable alias of product structure
Label	string	Presented name of product structure in backoffice
HasVariants	boolean	Indicates whether products using this product structure can have variants. VariantConfiguration is required when this is true
HasVariantGroups	boolean	Indicates whether products using this product structure can have variant groups. VariantGroupConfiguration is required when this is true
ProductConfiguration	object : ProductConfiguration	The configuration of tabs, sections and properties for products using this configuration
VariantGroupConfiguration	object : VariantGroupConfiguration	The configuration of tabs, sections and properties of variant groups using this configuration (only needed when HasVariantGroups is true)
VariantConfiguration	object : VariantConfiguration	The configuration of tabs, sections and properties of variants using this configuration (only needed when HasVariants is true)
VariationDefinitions	array : VariationDefinition	Defines different variant variations (eg. some products have variants of color/size, others of width/length, others again of just color and so on.)
AlwaysOnDefiningAttributes	array	Set defining attributes that must always be available no matter if they are part of the variation definition for a variant or not
ProductIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a model number and the internal id of a product in the system
VariantGroupIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a model number and the internal id of a variant group
VariantIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a SKU and the internal id of the variant

ProductConfiguration

Property name	Data type	Description
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the product. Use Product_[attributeUid] to reference a media attribute on the Product configuration itself Variant_[attributeUid] to reference a media attribute on the Product configuration of the Product structure and
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for products (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 product using this Product configuration [Optional]
CopyWizard	object : WizardSetup	The step wizard presented to users when copying a new product using this Product configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on products using this product 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

VariantGroupConfiguration

Property name	Data type	Description
GroupingAttributes	array	Attributes to group variants by. All variants with the same values as a variant group in the specified Grouping attributes will be associated to that variant group
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the product. Use VariantGroup_[attributeUid] to reference a media attribute on the Variant group configuration itself
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for variant groups (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 variant group using this Variant Group configuration [Optional]
CopyWizard	object : WizardSetup	The step wizard presented to users when copying a new Variant group using this Variant group configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on Variant groups using this Variant group configuration in the backoffice

VariantConfiguration

Property name	Data type	Description
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the variant. Use Product_[attributeUid] to reference a media attribute on the Product configuration of the Product structure and Variant_[attributeUid] to reference a media attribute on the Variant configuration itself
CreateWizard	object : WizardSetup	The step wizard presented to users when creating a new variant using this Variant configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on variants using this variant configuration in the backoffice

VariationDefinition

Property name	Data type	Description
Uid	string	Unique id of variation definition
Alias	string	Unique human readable identifier for variation definition
Name	string	Presented name of variation definition in backoffice
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for variants (names are shown in tree view and when a reference to the item is shown in backoffice)
DefiningAttributes	array	Uid of the attributes which are defining for variants using this variation definition (eg. uid of color attribute, uids of color and size attribute etc.)
SortOrder	integer	The presented sortorder of the variation definition in backoffice

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)

Response status OK (200)

No body message is returned

GET /productstructures/{uid} Get a product structure

#Available from v.3.2.0

{
  "Uid": "a73384ec-0a4d-42bc-a83e-ab508723d235",
  "Alias": "NonFood",
  "Label": "Non-food",
  "HasVariants": true,
  "HasVariantGroups": false,
  "ProductConfiguration": {
    "ThumbnailReference": "Product_d47b7c1c-7b20-4f86-9331-01645d923de9",
    "NameConfiguration": {
      "NamePattern": "{0} - {1}",
      "NameAttributes": [
        "be033980-99a0-41b3-840b-634bb6b5b0ac",
        "944ded28-5fde-4367-90f5-65fc29cdbb11"
      ]
    },
    "CreateWizard": {
      "Uid": "4aa95e13-9d29-4ce4-a23a-134922c5ea16",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "c56afcbe-9d91-4971-839b-2f1f5c78b96f",
              "Mandatory": true,
              "Uid": "3e02fe25-f941-48c5-a57c-140a23649321",
              "Type": "AttributeWizardPropertySetup"
            },
            {
              "PropertyUid": "16c02340-e3cd-4a9a-838a-c0074f42deb3",
              "Mandatory": false,
              "Uid": "79d1615a-0da0-40d2-b013-0b964535b806",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "5153ee4e-b4ac-4589-a500-c469c1953922",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the product",
          "Type": "DynamicWizardStepSetup"
        },
        {
          "Properties": [
            {
              "PropertyUid": "ffc1bc4b-deaa-4b26-8756-5bba3ebee0e9",
              "Mandatory": true,
              "Uid": "1a40d5df-09bd-4f11-b291-ccb6fa91d6cf",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "879867ce-708a-467e-86f3-bb8ba262b653",
          "Headline": "Step 2 - Media",
          "Description": "Add an image to the product",
          "Type": "DynamicWizardStepSetup"
        }
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "Basic information about the product",
            "Properties": [
              {
                "AttributeUid": "944ded28-5fde-4367-90f5-65fc29cdbb11",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "c56afcbe-9d91-4971-839b-2f1f5c78b96f",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "be033980-99a0-41b3-840b-634bb6b5b0ac",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "16c02340-e3cd-4a9a-838a-c0074f42deb3",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "1eb98703-06b9-4883-b7fd-c4b3453503f4",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "c6dc7f5f-caa4-4856-a42f-05a7025a61e9",
                "Type": "AttributeSetup"
              },
              {
                "DisplayName": "Variant type",
                "DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
                "Uid": "3190df31-962c-41df-b876-138539a0e098",
                "Type": "VariationDefinitionSetup"
              }
            ],
            "Uid": "321a67bd-c1c3-47f2-8315-a7b93560c157",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Weight & Size information",
            "Properties": [
              {
                "AttributeUid": "c66d5f4f-e1a5-4e66-bb4d-1845b7d4624a",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "db352bef-edd7-449c-9163-c73f3cdc9e1d",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "be4dcd8b-2814-498f-95de-81b9749ce88a",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "4162b028-1820-47aa-acbf-44e3a404aa4a",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "ce35472d-3c35-454a-a972-b7b46a0536c4",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "de50ebf5-b544-43c5-a870-3288dc26bcd3",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "Manage primary image and environment images for product",
            "Properties": [
              {
                "AttributeUid": "d47b7c1c-7b20-4f86-9331-01645d923de9",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "ffc1bc4b-deaa-4b26-8756-5bba3ebee0e9",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "dc2c855a-faa0-40d6-9f4a-0b35c5292b30",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "f6d3694e-d7eb-40c9-a16f-50f2e5db1639",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "a5bb3965-7202-46f8-aee8-d253ae0fdb1d",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Videos",
            "Properties": [
              {
                "AttributeUid": "ea552aab-a062-462b-b70f-aa750fc30741",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "c5b671cb-1d3f-4cc6-bef7-0decf968064e",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "bc84c469-13b1-48f3-ba67-63faabfd2b74",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "90f30292-4241-46ab-a921-62d1a6f1222f",
        "Type": "DynamicTabSetup"
      },
      {
        "Uid": "a1ffa458-e930-4d7d-9c77-96a6bc721f91",
        "Type": "ClassificationsTabSetup"
      },
      {
        "Uid": "c9c11dbe-81a0-43ed-b3f0-72a15ade57b1",
        "Type": "VariantsTabSetup"
      }
    ]
  },
  "VariantConfiguration": {
    "ThumbnailReference": "Variant_d47b7c1c-7b20-4f86-9331-01645d923de9",
    "CreateWizard": {
      "Uid": "4850f06d-bffc-4944-8e4b-44cb3323e77b",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "fa4d9b3c-5a94-4351-9d08-af8038eb3f38",
              "Mandatory": true,
              "Uid": "6b747030-7067-4c19-af09-f4eef6515a67",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "47955b06-f63b-487f-9b6c-4f73e1196280",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the variant",
          "Type": "DynamicWizardStepSetup"
        }
      ]
    },
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "Basic information about the variant",
            "Properties": [
              {
                "AttributeUid": "e53ebbf9-41cf-4a68-b448-e94e87e84ca7",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "fa4d9b3c-5a94-4351-9d08-af8038eb3f38",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "58b2806b-96d1-4186-a793-b5415db0b2d2",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "090fb0da-0da0-4920-94f0-bda19bdfb999",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "a90c0590-18b4-4616-955e-c8a5b025cc94",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "99152054-7bdc-478f-9da4-1f780ae67a19",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "dfded1f6-3342-4c83-a09d-270ba86fd295",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "a278404c-a3da-4233-9851-365eeeda2dc7",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "View and override product image if necessary",
            "Properties": [
              {
                "AttributeUid": "d47b7c1c-7b20-4f86-9331-01645d923de9",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": true,
                "Uid": "b3705989-e20b-42db-8e23-2aed06c15957",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "459619dd-4f13-4280-98c5-e6ad7b402db9",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "c9ec6055-8d67-4d2f-b697-956273044a7d",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "c5e80977-d38e-4a6f-a737-baefc5621651",
      "Alias": "ColorVariants",
      "Name": "Color variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "e53ebbf9-41cf-4a68-b448-e94e87e84ca7",
          "58b2806b-96d1-4186-a793-b5415db0b2d2"
        ]
      },
      "DefiningAttributes": [
        "58b2806b-96d1-4186-a793-b5415db0b2d2"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "bd6fc190-739f-43b7-9e46-14d0f8928f1d",
      "Alias": "SizeVariants",
      "Name": "Size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "e53ebbf9-41cf-4a68-b448-e94e87e84ca7",
          "a90c0590-18b4-4616-955e-c8a5b025cc94"
        ]
      },
      "DefiningAttributes": [
        "a90c0590-18b4-4616-955e-c8a5b025cc94"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "80fac77f-6f67-4d1c-be69-7b544c630184",
      "Alias": "ColorAndSizeVariants",
      "Name": "Color/size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1} / {2}",
        "NameAttributes": [
          "e53ebbf9-41cf-4a68-b448-e94e87e84ca7",
          "58b2806b-96d1-4186-a793-b5415db0b2d2",
          "a90c0590-18b4-4616-955e-c8a5b025cc94"
        ]
      },
      "DefiningAttributes": [
        "58b2806b-96d1-4186-a793-b5415db0b2d2",
        "a90c0590-18b4-4616-955e-c8a5b025cc94"
      ],
      "SortOrder": 3
    }
  ],
  "ProductIdentifierDefinitions": [
    {
      "Uid": "ba7bd442-23c9-4ae3-937e-6fe2cb369761",
      "Alias": "ModelNoIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "be033980-99a0-41b3-840b-634bb6b5b0ac"
      ]
    }
  ],
  "VariantIdentifierDefinitions": [
    {
      "Uid": "dfb7c1e0-f5ea-4883-b509-ad0f6584a32b",
      "Alias": "SKUIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "e53ebbf9-41cf-4a68-b448-e94e87e84ca7"
      ]
    }
  ]
}

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of product structure

Response status OK (200)

object : ProductStructure

ProductStructure

Property name	Data type	Description
Uid	string	Unique id of product structure
Alias	string	Unique human readable alias of product structure
Label	string	Presented name of product structure in backoffice
HasVariants	boolean	Indicates whether products using this product structure can have variants. VariantConfiguration is required when this is true
HasVariantGroups	boolean	Indicates whether products using this product structure can have variant groups. VariantGroupConfiguration is required when this is true
ProductConfiguration	object : ProductConfiguration	The configuration of tabs, sections and properties for products using this configuration
VariantGroupConfiguration	object : VariantGroupConfiguration	The configuration of tabs, sections and properties of variant groups using this configuration (only needed when HasVariantGroups is true)
VariantConfiguration	object : VariantConfiguration	The configuration of tabs, sections and properties of variants using this configuration (only needed when HasVariants is true)
VariationDefinitions	array : VariationDefinition	Defines different variant variations (eg. some products have variants of color/size, others of width/length, others again of just color and so on.)
AlwaysOnDefiningAttributes	array	Set defining attributes that must always be available no matter if they are part of the variation definition for a variant or not
ProductIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a model number and the internal id of a product in the system
VariantGroupIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a model number and the internal id of a variant group
VariantIdentifierDefinitions	array : IdentifierDefinition	Defines identifier setups used to create maps between eg. a SKU and the internal id of the variant

ProductConfiguration

Property name	Data type	Description
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the product. Use Product_[attributeUid] to reference a media attribute on the Product configuration itself Variant_[attributeUid] to reference a media attribute on the Product configuration of the Product structure and
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for products (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 product using this Product configuration [Optional]
CopyWizard	object : WizardSetup	The step wizard presented to users when copying a new product using this Product configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on products using this product 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

VariantGroupConfiguration

Property name	Data type	Description
GroupingAttributes	array	Attributes to group variants by. All variants with the same values as a variant group in the specified Grouping attributes will be associated to that variant group
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the product. Use VariantGroup_[attributeUid] to reference a media attribute on the Variant group configuration itself
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for variant groups (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 variant group using this Variant Group configuration [Optional]
CopyWizard	object : WizardSetup	The step wizard presented to users when copying a new Variant group using this Variant group configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on Variant groups using this Variant group configuration in the backoffice

VariantConfiguration

Property name	Data type	Description
ThumbnailReference	string	Reference to a media attribute which holds the image that should be presented as thumbnail for the variant. Use Product_[attributeUid] to reference a media attribute on the Product configuration of the Product structure and Variant_[attributeUid] to reference a media attribute on the Variant configuration itself
CreateWizard	object : WizardSetup	The step wizard presented to users when creating a new variant using this Variant configuration [Optional]
Tabs	array : TabSetup	The tabs that shall be shown on variants using this variant configuration in the backoffice

VariationDefinition

Property name	Data type	Description
Uid	string	Unique id of variation definition
Alias	string	Unique human readable identifier for variation definition
Name	string	Presented name of variation definition in backoffice
NameConfiguration	object : NameConfiguration	Pattern defining how names shall be generated for variants (names are shown in tree view and when a reference to the item is shown in backoffice)
DefiningAttributes	array	Uid of the attributes which are defining for variants using this variation definition (eg. uid of color attribute, uids of color and size attribute etc.)
SortOrder	integer	The presented sortorder of the variation definition in backoffice

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)

DELETE /productstructures/{uid} Delete a product structure

#Available from v.3.2.0

Request parameters

Property name	Parameter type	Data type	Description
uid	path	string	Unique id of product structure to delete

Response status OK (200)

No body message is returned