#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

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

ProductConfiguration object : ProductConfiguration

The configuration of tabs, sections and properties for products using this configuration

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

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]

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

AttributesOnCategoryTabSetup
Tab that allows setting up attributes on a category that shall be available to products in this category or its descendants (Can only be added to master catalogue).
Property name Data type Description
Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

ClassificationsTabSetup
Shows a products classifications in different catalogues of the system (can only be added to product configuration)
Property name Data type Description
Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

DynamicTabSetup
Generic tab that allows setting up specific sections to show on the tab
Property name Data type Description
Label string

The headline this tab shall be presented with in the backoffice

Sections array : SectionSetup

The sections shown on this tab in the backoffice

ShowSidebar boolean

Shows product status sidebar in backoffice

Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

SectionSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
CategoryAttributesSetup
Section which shows input fields for all attributes inherited from the products primary category
Property name Data type Description
Uid string

Unique id of section

ViewPermission string

Permission required to view section

SavePermission string

Permission required to edit data in this section

Type string

The type of section defining the actual implementation type of the abstract Section

DynamicSectionSetup
Generic section that allows setting up specific properties to show in the section
Property name Data type Description
Headline string

Headline of section

Description string

Description to show on section

Properties array : PropertySetup

Properties shown in section

Uid string

Unique id of section

ViewPermission string

Permission required to view section

SavePermission string

Permission required to edit data in this section

Type string

The type of section defining the actual implementation type of the abstract Section

PropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
IdSetup
ID property showing the internal id of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

CreatedSetup
Created timestamp property showing the exact creation timestamp of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

LastModifiedSetup
Last modified timestamp property showing the exact timestamp of the latest modification of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

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

Widht of the preview property

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

VariationDefinitionSetup
Variation definition selector property defines a property that allows users to select the variation definition to use for a product from a dropdown (can only be set on product configuration)
Property name Data type Description
DisplayName string

Name to show for the property in the backoffice

DisplayDescription string

Description to show for the property in the backoffice

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

AttributeSetup
Defines an attribute connection to a configuration, allowing users to set data for an attribute on the product, variant or category using the configuration this attribute setup is added to
Property name Data type Description
AttributeUid string

Uid of attribute

ReadOnly boolean

Defines if the attribute value is read only

Mandatory boolean

Defines if the attribute must have a value before the user can save the tab

Unchangeable boolean

Defines if the attribute value cannot change, once it has gotten a value

Inherits boolean

Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default.

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

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

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

ProductConfiguration object : ProductConfiguration

The configuration of tabs, sections and properties for products using this configuration

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

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]

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

AttributesOnCategoryTabSetup
Tab that allows setting up attributes on a category that shall be available to products in this category or its descendants (Can only be added to master catalogue).
Property name Data type Description
Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

ClassificationsTabSetup
Shows a products classifications in different catalogues of the system (can only be added to product configuration)
Property name Data type Description
Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

DynamicTabSetup
Generic tab that allows setting up specific sections to show on the tab
Property name Data type Description
Label string

The headline this tab shall be presented with in the backoffice

Sections array : SectionSetup

The sections shown on this tab in the backoffice

ShowSidebar boolean

Shows product status sidebar in backoffice

Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

SectionSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
CategoryAttributesSetup
Section which shows input fields for all attributes inherited from the products primary category
Property name Data type Description
Uid string

Unique id of section

ViewPermission string

Permission required to view section

SavePermission string

Permission required to edit data in this section

Type string

The type of section defining the actual implementation type of the abstract Section

DynamicSectionSetup
Generic section that allows setting up specific properties to show in the section
Property name Data type Description
Headline string

Headline of section

Description string

Description to show on section

Properties array : PropertySetup

Properties shown in section

Uid string

Unique id of section

ViewPermission string

Permission required to view section

SavePermission string

Permission required to edit data in this section

Type string

The type of section defining the actual implementation type of the abstract Section

PropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
IdSetup
ID property showing the internal id of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

CreatedSetup
Created timestamp property showing the exact creation timestamp of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

LastModifiedSetup
Last modified timestamp property showing the exact timestamp of the latest modification of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

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

Widht of the preview property

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

VariationDefinitionSetup
Variation definition selector property defines a property that allows users to select the variation definition to use for a product from a dropdown (can only be set on product configuration)
Property name Data type Description
DisplayName string

Name to show for the property in the backoffice

DisplayDescription string

Description to show for the property in the backoffice

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

AttributeSetup
Defines an attribute connection to a configuration, allowing users to set data for an attribute on the product, variant or category using the configuration this attribute setup is added to
Property name Data type Description
AttributeUid string

Uid of attribute

ReadOnly boolean

Defines if the attribute value is read only

Mandatory boolean

Defines if the attribute must have a value before the user can save the tab

Unchangeable boolean

Defines if the attribute value cannot change, once it has gotten a value

Inherits boolean

Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default.

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

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

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

ProductConfiguration object : ProductConfiguration

The configuration of tabs, sections and properties for products using this configuration

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

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]

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

AttributesOnCategoryTabSetup
Tab that allows setting up attributes on a category that shall be available to products in this category or its descendants (Can only be added to master catalogue).
Property name Data type Description
Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

ClassificationsTabSetup
Shows a products classifications in different catalogues of the system (can only be added to product configuration)
Property name Data type Description
Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

DynamicTabSetup
Generic tab that allows setting up specific sections to show on the tab
Property name Data type Description
Label string

The headline this tab shall be presented with in the backoffice

Sections array : SectionSetup

The sections shown on this tab in the backoffice

ShowSidebar boolean

Shows product status sidebar in backoffice

Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

SectionSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
CategoryAttributesSetup
Section which shows input fields for all attributes inherited from the products primary category
Property name Data type Description
Uid string

Unique id of section

ViewPermission string

Permission required to view section

SavePermission string

Permission required to edit data in this section

Type string

The type of section defining the actual implementation type of the abstract Section

DynamicSectionSetup
Generic section that allows setting up specific properties to show in the section
Property name Data type Description
Headline string

Headline of section

Description string

Description to show on section

Properties array : PropertySetup

Properties shown in section

Uid string

Unique id of section

ViewPermission string

Permission required to view section

SavePermission string

Permission required to edit data in this section

Type string

The type of section defining the actual implementation type of the abstract Section

PropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
IdSetup
ID property showing the internal id of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

CreatedSetup
Created timestamp property showing the exact creation timestamp of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

LastModifiedSetup
Last modified timestamp property showing the exact timestamp of the latest modification of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

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

Widht of the preview property

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

VariationDefinitionSetup
Variation definition selector property defines a property that allows users to select the variation definition to use for a product from a dropdown (can only be set on product configuration)
Property name Data type Description
DisplayName string

Name to show for the property in the backoffice

DisplayDescription string

Description to show for the property in the backoffice

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

AttributeSetup
Defines an attribute connection to a configuration, allowing users to set data for an attribute on the product, variant or category using the configuration this attribute setup is added to
Property name Data type Description
AttributeUid string

Uid of attribute

ReadOnly boolean

Defines if the attribute value is read only

Mandatory boolean

Defines if the attribute must have a value before the user can save the tab

Unchangeable boolean

Defines if the attribute value cannot change, once it has gotten a value

Inherits boolean

Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default.

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

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

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

ProductConfiguration object : ProductConfiguration

The configuration of tabs, sections and properties for products using this configuration

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

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]

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

AttributesOnCategoryTabSetup
Tab that allows setting up attributes on a category that shall be available to products in this category or its descendants (Can only be added to master catalogue).
Property name Data type Description
Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

ClassificationsTabSetup
Shows a products classifications in different catalogues of the system (can only be added to product configuration)
Property name Data type Description
Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

DynamicTabSetup
Generic tab that allows setting up specific sections to show on the tab
Property name Data type Description
Label string

The headline this tab shall be presented with in the backoffice

Sections array : SectionSetup

The sections shown on this tab in the backoffice

ShowSidebar boolean

Shows product status sidebar in backoffice

Uid string

Unique id of tab

ViewPermission string

Uid of permision required to view this tab

SavePermission string

Uid of permission required to edit data on this tab

Type string

The type of tab defining the actual implementation type of the abstract Tab

SectionSetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
CategoryAttributesSetup
Section which shows input fields for all attributes inherited from the products primary category
Property name Data type Description
Uid string

Unique id of section

ViewPermission string

Permission required to view section

SavePermission string

Permission required to edit data in this section

Type string

The type of section defining the actual implementation type of the abstract Section

DynamicSectionSetup
Generic section that allows setting up specific properties to show in the section
Property name Data type Description
Headline string

Headline of section

Description string

Description to show on section

Properties array : PropertySetup

Properties shown in section

Uid string

Unique id of section

ViewPermission string

Permission required to view section

SavePermission string

Permission required to edit data in this section

Type string

The type of section defining the actual implementation type of the abstract Section

PropertySetup
This model is an abstract type and can attain any of the below concrete models. The Type property is used to define the actual model type
IdSetup
ID property showing the internal id of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

CreatedSetup
Created timestamp property showing the exact creation timestamp of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

LastModifiedSetup
Last modified timestamp property showing the exact timestamp of the latest modification of the item
Property name Data type Description
Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

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

Widht of the preview property

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

VariationDefinitionSetup
Variation definition selector property defines a property that allows users to select the variation definition to use for a product from a dropdown (can only be set on product configuration)
Property name Data type Description
DisplayName string

Name to show for the property in the backoffice

DisplayDescription string

Description to show for the property in the backoffice

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

AttributeSetup
Defines an attribute connection to a configuration, allowing users to set data for an attribute on the product, variant or category using the configuration this attribute setup is added to
Property name Data type Description
AttributeUid string

Uid of attribute

ReadOnly boolean

Defines if the attribute value is read only

Mandatory boolean

Defines if the attribute must have a value before the user can save the tab

Unchangeable boolean

Defines if the attribute value cannot change, once it has gotten a value

Inherits boolean

Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default.

Uid string

Unique id of property

ViewPermission string

Permission required to view property

SavePermission string

Permission required to edit property

Type string

The type of property defining the actual implementation type of the abstract Property

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