# 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": "8b2c6fab-dd52-4971-a65e-440f27317762",
"Alias": "NonFood",
"Label": "Non-food",
"HasVariants": true,
"HasVariantGroups": false,
"ProductConfiguration": {
"ThumbnailReference": "Product_d84b4ec9-7ceb-450d-a53c-b0ef4bd96260",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"78c3d859-2f06-4a31-89e3-09df1781f9c6",
"f1f9046e-9fcf-44dc-a7d7-173833428986"
]
},
"CreateWizard": {
"Uid": "3394924f-8d56-49b4-80aa-bd3f65910371",
"Steps": [
{
"Properties": [
{
"PropertyUid": "f209b035-34fe-4657-ad9a-99df4f9a6c11",
"Mandatory": true,
"Uid": "abd9a8df-3bcb-4677-90ce-d0853b4d8422",
"Type": "AttributeWizardPropertySetup"
},
{
"PropertyUid": "586924af-d672-4daf-aaa5-29a009dbdce4",
"Mandatory": false,
"Uid": "9e026cf9-eff8-401d-818e-697b39a7a555",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "59d433e4-47a2-4e1e-b2dd-c89dbeef650a",
"Headline": "Step 1 - basic information",
"Description": "Add basic information about the product",
"Type": "DynamicWizardStepSetup"
},
{
"Properties": [
{
"PropertyUid": "b0677a17-4a5d-4b6e-90f8-bd65e8964b18",
"Mandatory": true,
"Uid": "6432626b-c913-44c0-84e0-462c0c7f3a3c",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "7031f735-ba1c-4086-9baa-153607b59fe5",
"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": "f1f9046e-9fcf-44dc-a7d7-173833428986",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "f209b035-34fe-4657-ad9a-99df4f9a6c11",
"Type": "AttributeSetup"
},
{
"AttributeUid": "78c3d859-2f06-4a31-89e3-09df1781f9c6",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "586924af-d672-4daf-aaa5-29a009dbdce4",
"Type": "AttributeSetup"
},
{
"AttributeUid": "4a8f1249-7e25-4371-b01a-cf4a89d4a657",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "76638f19-3f09-451e-b2c3-7c3498d2187b",
"Type": "AttributeSetup"
},
{
"DisplayName": "Variant type",
"DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
"Uid": "1b65aac9-fb07-4f4d-822f-fbc39f8982d1",
"Type": "VariationDefinitionSetup"
}
],
"Uid": "1714e2a0-664c-45e9-a0cc-9689879d98b2",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Weight & Size information",
"Properties": [
{
"AttributeUid": "a0a2b9c1-e592-4011-8add-885285c7f6d6",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "ad3996ed-97f9-4f82-ad78-aac02ea2761c",
"Type": "AttributeSetup"
},
{
"AttributeUid": "28348c14-40b0-49a1-858d-40b3d8d5a02d",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "3b07a5c1-64f2-48e4-acb5-3ed5fb06bdb2",
"Type": "AttributeSetup"
}
],
"Uid": "3bd3b908-8643-4611-87a3-d777a2795892",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "00c48cbe-8680-4378-aaac-0c489a0b5e19",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "Manage primary image and environment images for product",
"Properties": [
{
"AttributeUid": "d84b4ec9-7ceb-450d-a53c-b0ef4bd96260",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "b0677a17-4a5d-4b6e-90f8-bd65e8964b18",
"Type": "AttributeSetup"
},
{
"AttributeUid": "9a59ba72-9848-4285-966b-84487e16e171",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "19bcd8f3-99c2-488e-a0fb-bad007832224",
"Type": "AttributeSetup"
}
],
"Uid": "9344bf19-9247-406b-b379-bb9af9a355b4",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Videos",
"Properties": [
{
"AttributeUid": "bd8aaee4-855c-4b17-9eef-1b14749778c5",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "a169c630-aa11-490a-b28f-c0ff7ca94b25",
"Type": "AttributeSetup"
}
],
"Uid": "ff6ddad2-cf48-4b2c-8126-c6a9a40395d5",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "24067f99-bff1-4a15-8ee1-f134cc378459",
"Type": "DynamicTabSetup"
},
{
"Uid": "a3588e60-86d1-4215-846c-e5a7e54f10cf",
"Type": "ClassificationsTabSetup"
},
{
"Uid": "0345b282-1be4-47a7-a516-331ab8998025",
"Type": "VariantsTabSetup"
}
]
},
"VariantConfiguration": {
"ThumbnailReference": "Variant_d84b4ec9-7ceb-450d-a53c-b0ef4bd96260",
"CreateWizard": {
"Uid": "99e1759c-fabf-4277-96f6-e7f13f08c543",
"Steps": [
{
"Properties": [
{
"PropertyUid": "d884fef9-eb6b-48dd-ba9d-5deb7fc059a7",
"Mandatory": true,
"Uid": "c37b4c84-cbf5-4f45-b79b-29dd865c9f14",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "41b83a64-d12a-4d78-aeeb-68bb8a692c6d",
"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": "b0b26960-d745-44ce-9a05-53e3187f8fec",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "d884fef9-eb6b-48dd-ba9d-5deb7fc059a7",
"Type": "AttributeSetup"
},
{
"AttributeUid": "dc37e84a-d919-47b0-a820-efde3566c2a0",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "f63faaa4-874e-471e-befd-f19ee1bab8a8",
"Type": "AttributeSetup"
},
{
"AttributeUid": "3e4cc692-132c-4b1e-bfe5-c18c39232fde",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "3f546618-c7d8-4fdc-8bbf-f58f454c8f4a",
"Type": "AttributeSetup"
}
],
"Uid": "7183b43f-6b78-4fa7-9c4b-7da023f0a22a",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "f0c39830-876b-47e3-9d15-cfde63eba0f2",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "View and override product image if necessary",
"Properties": [
{
"AttributeUid": "d84b4ec9-7ceb-450d-a53c-b0ef4bd96260",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": true,
"Uid": "c65a233e-e779-4b36-aa1b-680d8b758f26",
"Type": "AttributeSetup"
}
],
"Uid": "be751b5b-3b54-4fcb-998e-21dcd1a1db94",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "2bbc3939-c2b9-48f0-934e-530407b2aa12",
"Type": "DynamicTabSetup"
}
]
},
"VariationDefinitions": [
{
"Uid": "21d87858-e816-441d-837f-e82d1fd8189b",
"Alias": "ColorVariants",
"Name": "Color variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"b0b26960-d745-44ce-9a05-53e3187f8fec",
"dc37e84a-d919-47b0-a820-efde3566c2a0"
]
},
"DefiningAttributes": [
"dc37e84a-d919-47b0-a820-efde3566c2a0"
],
"SortOrder": 1
},
{
"Uid": "41e8f271-b811-4296-9ab9-c37e5282d908",
"Alias": "SizeVariants",
"Name": "Size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"b0b26960-d745-44ce-9a05-53e3187f8fec",
"3e4cc692-132c-4b1e-bfe5-c18c39232fde"
]
},
"DefiningAttributes": [
"3e4cc692-132c-4b1e-bfe5-c18c39232fde"
],
"SortOrder": 1
},
{
"Uid": "eef4a38a-6949-46f5-b428-792ac76d6214",
"Alias": "ColorAndSizeVariants",
"Name": "Color/size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1} / {2}",
"NameAttributes": [
"b0b26960-d745-44ce-9a05-53e3187f8fec",
"dc37e84a-d919-47b0-a820-efde3566c2a0",
"3e4cc692-132c-4b1e-bfe5-c18c39232fde"
]
},
"DefiningAttributes": [
"dc37e84a-d919-47b0-a820-efde3566c2a0",
"3e4cc692-132c-4b1e-bfe5-c18c39232fde"
],
"SortOrder": 3
}
],
"ProductIdentifierDefinitions": [
{
"Uid": "35a9cfa8-9379-4cc3-abc3-8a68e3378936",
"Alias": "ModelNoIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"78c3d859-2f06-4a31-89e3-09df1781f9c6"
]
}
],
"VariantIdentifierDefinitions": [
{
"Uid": "e46d4afd-e59c-4cf9-90cc-03a71b3a024b",
"Alias": "SKUIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"b0b26960-d745-44ce-9a05-53e3187f8fec"
]
}
]
}
]
Response status OK (200)
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 |
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 |
Property name | Data type | Description |
---|---|---|
NamePattern | string |
Pattern defining how attribute values shall be concatenated to form a name. Ex. {0} - {1} |
NameAttributes | array |
Uids of attributes to use in rendering. Number of attributes must match number of referenced attributes in NamePattern |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard setup |
Steps | array : WizardStepSetup |
The steps that are part of this wizard |
Property name | Data type | Description |
---|---|---|
Properties | array : WizardPropertySetup |
Properties that shall be shown on this wizard step |
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
PropertyUid | string |
Reference to property uid on configuration defining the attribute |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Mandatory | boolean |
Defines if the defining attributes are mandatory in the step they are shown |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Add an optional display name to show for the property in the backoffice wizard |
DisplayDescription | string |
Add an optional description to show for the property in the backoffice wizard |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Label | string |
The headline this tab shall be presented with in the backoffice |
Sections | array : SectionSetup |
The sections shown on this tab in the backoffice |
ShowSidebar | boolean |
Shows product status sidebar in backoffice |
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Headline | string |
Headline of section |
Description | string |
Description to show on section |
Properties | array : PropertySetup |
Properties shown in section |
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Width | integer |
Width of the preview property |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
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 |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Name to show for the property in the backoffice |
DisplayDescription | string |
Description to show for the property in the backoffice |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
AttributeUid | string |
Uid of attribute |
ReadOnly | boolean |
Defines if the attribute value is read only |
Mandatory | boolean |
Defines if the attribute must have a value before the user can save the tab |
Unchangeable | boolean |
Defines if the attribute value cannot change, once it has gotten a value |
Inherits | boolean |
Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default. |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
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 |
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 |
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 |
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": "78c6af03-bb73-4506-8287-22a637492530",
"Alias": "NonFood",
"Label": "Non-food",
"HasVariants": true,
"HasVariantGroups": false,
"ProductConfiguration": {
"ThumbnailReference": "Product_454d0936-6128-4126-93df-5d6bb3d4e535",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"10bb146d-b4a8-4171-9eac-c8b3dcf6951c",
"53dba171-19c0-42d7-b681-c7ab3cd4bc8f"
]
},
"CreateWizard": {
"Uid": "00b59b72-eaff-45ae-a2d6-f729148f771d",
"Steps": [
{
"Properties": [
{
"PropertyUid": "a3013181-b0d2-49d4-9742-517dea92487c",
"Mandatory": true,
"Uid": "4b618f7d-063b-4325-83bd-200f47e356ba",
"Type": "AttributeWizardPropertySetup"
},
{
"PropertyUid": "a086a704-f4f9-407c-b00a-d195f739c421",
"Mandatory": false,
"Uid": "59e53346-e2bd-47c7-abef-432eb0f87c3a",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "ee6998b3-1379-4d0b-b4f3-52cd979a141a",
"Headline": "Step 1 - basic information",
"Description": "Add basic information about the product",
"Type": "DynamicWizardStepSetup"
},
{
"Properties": [
{
"PropertyUid": "b66a58e6-8cc0-49ae-882d-142840f99333",
"Mandatory": true,
"Uid": "5807a5e3-ee48-4883-9a21-bf2ce7a05f06",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "554279e1-abc0-4dba-b699-fe7d3c9a98e4",
"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": "53dba171-19c0-42d7-b681-c7ab3cd4bc8f",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "a3013181-b0d2-49d4-9742-517dea92487c",
"Type": "AttributeSetup"
},
{
"AttributeUid": "10bb146d-b4a8-4171-9eac-c8b3dcf6951c",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "a086a704-f4f9-407c-b00a-d195f739c421",
"Type": "AttributeSetup"
},
{
"AttributeUid": "3ea0e5ab-0fa5-446b-bba2-b882d72388e0",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "56ba72f2-2f0d-4273-86f1-a85140042d39",
"Type": "AttributeSetup"
},
{
"DisplayName": "Variant type",
"DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
"Uid": "2d8b55e6-1b32-4431-9714-128976305a83",
"Type": "VariationDefinitionSetup"
}
],
"Uid": "1bad4114-bcd5-470b-bffd-df8b4ff9d284",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Weight & Size information",
"Properties": [
{
"AttributeUid": "f9330ea5-e972-4c2f-b6e2-d9d8c51635cb",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "bc4913d1-12e7-485b-bc82-9aedec28761c",
"Type": "AttributeSetup"
},
{
"AttributeUid": "f91c256f-388e-4e7b-a45d-c721bf2cc575",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "73fe1478-5f40-4d78-b78d-5473f213d46d",
"Type": "AttributeSetup"
}
],
"Uid": "3def6be3-57c1-4853-902f-fb44fbee3a8f",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "107272c3-9f58-4ee2-ab97-a7f76f55e08f",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "Manage primary image and environment images for product",
"Properties": [
{
"AttributeUid": "454d0936-6128-4126-93df-5d6bb3d4e535",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "b66a58e6-8cc0-49ae-882d-142840f99333",
"Type": "AttributeSetup"
},
{
"AttributeUid": "8648c26e-91a1-4247-8469-b4917803feb8",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "88a7970d-bd1f-47b5-8f14-a41045baae62",
"Type": "AttributeSetup"
}
],
"Uid": "2d63d8dd-5bd8-4d08-a805-8e9089350d7f",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Videos",
"Properties": [
{
"AttributeUid": "8384511b-b133-4199-9a69-8bc9b9315e5f",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "3c3ffaf6-17f7-4439-85be-e23944323c65",
"Type": "AttributeSetup"
}
],
"Uid": "26e2cb8a-280f-46c6-9a09-f45e371f78db",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "0a5b2e6d-6964-459d-bc04-ae62a58992de",
"Type": "DynamicTabSetup"
},
{
"Uid": "817a0fe8-2d02-4a87-aac6-cc3b1b5703bd",
"Type": "ClassificationsTabSetup"
},
{
"Uid": "fff561c7-9557-49e8-8e9d-4c091f81e93c",
"Type": "VariantsTabSetup"
}
]
},
"VariantConfiguration": {
"ThumbnailReference": "Variant_454d0936-6128-4126-93df-5d6bb3d4e535",
"CreateWizard": {
"Uid": "86f757c3-c054-46bf-b71c-1fa9fb4e7c81",
"Steps": [
{
"Properties": [
{
"PropertyUid": "f3ff30e2-6753-4990-a349-900c32d7c40b",
"Mandatory": true,
"Uid": "dbf665da-a87d-4f4a-a1ed-0eb5aeaa3bf9",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "7f0f21e2-f622-4d6a-80a9-8a882a0ecbd9",
"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": "49a56053-ea45-4750-8c39-30e0486f8deb",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "f3ff30e2-6753-4990-a349-900c32d7c40b",
"Type": "AttributeSetup"
},
{
"AttributeUid": "48a3fb98-e4ff-44ec-99c8-0190ea8a19cf",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "07443d83-76b3-4d7e-b576-b854fc4999ac",
"Type": "AttributeSetup"
},
{
"AttributeUid": "ce2bdc47-460d-42bd-9c32-f75fe48d8dc7",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "44b84c1d-0ad3-4a8f-bcd9-fd52882ef1a3",
"Type": "AttributeSetup"
}
],
"Uid": "c03320ff-fb4b-4fe3-991d-3e80ce2ba395",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "b95c04d0-d7cd-4cd1-8400-734e1bd832d2",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "View and override product image if necessary",
"Properties": [
{
"AttributeUid": "454d0936-6128-4126-93df-5d6bb3d4e535",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": true,
"Uid": "53dde47f-3602-4718-887c-12bb9a5317bc",
"Type": "AttributeSetup"
}
],
"Uid": "4271a25e-1277-4d28-8058-73024b625953",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "212f31e7-4531-4a4d-954c-8cabcce23c49",
"Type": "DynamicTabSetup"
}
]
},
"VariationDefinitions": [
{
"Uid": "2f30ee6e-0e5f-4297-b3a2-70516b5580cd",
"Alias": "ColorVariants",
"Name": "Color variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"49a56053-ea45-4750-8c39-30e0486f8deb",
"48a3fb98-e4ff-44ec-99c8-0190ea8a19cf"
]
},
"DefiningAttributes": [
"48a3fb98-e4ff-44ec-99c8-0190ea8a19cf"
],
"SortOrder": 1
},
{
"Uid": "f5e232c0-7d67-4e3d-85b7-56d7e7939eab",
"Alias": "SizeVariants",
"Name": "Size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"49a56053-ea45-4750-8c39-30e0486f8deb",
"ce2bdc47-460d-42bd-9c32-f75fe48d8dc7"
]
},
"DefiningAttributes": [
"ce2bdc47-460d-42bd-9c32-f75fe48d8dc7"
],
"SortOrder": 1
},
{
"Uid": "854472d3-4fd0-4134-979e-15feda055fbc",
"Alias": "ColorAndSizeVariants",
"Name": "Color/size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1} / {2}",
"NameAttributes": [
"49a56053-ea45-4750-8c39-30e0486f8deb",
"48a3fb98-e4ff-44ec-99c8-0190ea8a19cf",
"ce2bdc47-460d-42bd-9c32-f75fe48d8dc7"
]
},
"DefiningAttributes": [
"48a3fb98-e4ff-44ec-99c8-0190ea8a19cf",
"ce2bdc47-460d-42bd-9c32-f75fe48d8dc7"
],
"SortOrder": 3
}
],
"ProductIdentifierDefinitions": [
{
"Uid": "6053947a-addd-4029-bed2-82934036248d",
"Alias": "ModelNoIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"10bb146d-b4a8-4171-9eac-c8b3dcf6951c"
]
}
],
"VariantIdentifierDefinitions": [
{
"Uid": "4ebfcea2-f3bb-436d-80db-7961deeed486",
"Alias": "SKUIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"49a56053-ea45-4750-8c39-30e0486f8deb"
]
}
]
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
model | body | object : ProductStructure |
Updated product structure |
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 |
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 |
Property name | Data type | Description |
---|---|---|
NamePattern | string |
Pattern defining how attribute values shall be concatenated to form a name. Ex. {0} - {1} |
NameAttributes | array |
Uids of attributes to use in rendering. Number of attributes must match number of referenced attributes in NamePattern |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard setup |
Steps | array : WizardStepSetup |
The steps that are part of this wizard |
Property name | Data type | Description |
---|---|---|
Properties | array : WizardPropertySetup |
Properties that shall be shown on this wizard step |
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
PropertyUid | string |
Reference to property uid on configuration defining the attribute |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Mandatory | boolean |
Defines if the defining attributes are mandatory in the step they are shown |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Add an optional display name to show for the property in the backoffice wizard |
DisplayDescription | string |
Add an optional description to show for the property in the backoffice wizard |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Label | string |
The headline this tab shall be presented with in the backoffice |
Sections | array : SectionSetup |
The sections shown on this tab in the backoffice |
ShowSidebar | boolean |
Shows product status sidebar in backoffice |
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Headline | string |
Headline of section |
Description | string |
Description to show on section |
Properties | array : PropertySetup |
Properties shown in section |
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Width | integer |
Width of the preview property |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
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 |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Name to show for the property in the backoffice |
DisplayDescription | string |
Description to show for the property in the backoffice |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
AttributeUid | string |
Uid of attribute |
ReadOnly | boolean |
Defines if the attribute value is read only |
Mandatory | boolean |
Defines if the attribute must have a value before the user can save the tab |
Unchangeable | boolean |
Defines if the attribute value cannot change, once it has gotten a value |
Inherits | boolean |
Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default. |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
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 |
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 |
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 |
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)
POST /productstructures Create new product structure
#Available from v.3.2.0
{
"Uid": "eca37961-68f2-4d3d-901c-324f6b361f15",
"Alias": "NonFood",
"Label": "Non-food",
"HasVariants": true,
"HasVariantGroups": false,
"ProductConfiguration": {
"ThumbnailReference": "Product_7e3ea472-a65b-4239-bc9a-fb30c3d7fe1f",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"99bdd256-7ac6-4148-8c07-619a06f560f9",
"aa73a0d8-f3d3-47a1-84bd-0a7056a5d5a3"
]
},
"CreateWizard": {
"Uid": "1231916b-a958-41d0-bd45-af7c61babe6c",
"Steps": [
{
"Properties": [
{
"PropertyUid": "d9aca46e-9b74-4f52-8308-c294302ff106",
"Mandatory": true,
"Uid": "01d98225-3ec7-4d16-9729-7b309576281e",
"Type": "AttributeWizardPropertySetup"
},
{
"PropertyUid": "7323a987-7343-4fa8-978a-7b5d055a244e",
"Mandatory": false,
"Uid": "863a4bb7-c5ea-4a4a-a2dd-601ed9d6f088",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "2c7a723d-98a7-41e6-b1ce-5698e8b7abcb",
"Headline": "Step 1 - basic information",
"Description": "Add basic information about the product",
"Type": "DynamicWizardStepSetup"
},
{
"Properties": [
{
"PropertyUid": "6a0e0d00-ecc3-498c-b169-c25dab22b5cb",
"Mandatory": true,
"Uid": "a7ac4780-72e8-468b-938e-79e6053e7f6c",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "5178555a-58ae-441f-b14e-b72b97af5309",
"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": "aa73a0d8-f3d3-47a1-84bd-0a7056a5d5a3",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "d9aca46e-9b74-4f52-8308-c294302ff106",
"Type": "AttributeSetup"
},
{
"AttributeUid": "99bdd256-7ac6-4148-8c07-619a06f560f9",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "7323a987-7343-4fa8-978a-7b5d055a244e",
"Type": "AttributeSetup"
},
{
"AttributeUid": "53e7cef2-a97c-4750-99ca-5368da28f8dd",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "49414c55-2302-4c54-b32c-6b6ab7ab0cd4",
"Type": "AttributeSetup"
},
{
"DisplayName": "Variant type",
"DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
"Uid": "4c62d181-b443-4ad1-b65d-254b9a60fc00",
"Type": "VariationDefinitionSetup"
}
],
"Uid": "9d072825-bfb6-459d-ac5e-e9527b5dc044",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Weight & Size information",
"Properties": [
{
"AttributeUid": "751b1f6e-8ab6-4c34-8f65-bfcec8e50dc5",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "052f7bf3-3871-4248-a561-6c57eeb3b04b",
"Type": "AttributeSetup"
},
{
"AttributeUid": "6958a732-b143-476b-9c78-0e71ff73fa98",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "d77044a1-e1a3-41f4-ae78-ce7c049e04ce",
"Type": "AttributeSetup"
}
],
"Uid": "f9acc0e0-3346-4b65-a3b6-9531fdd7ba7c",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "9a044f6d-187c-4779-8d81-e75d55e83598",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "Manage primary image and environment images for product",
"Properties": [
{
"AttributeUid": "7e3ea472-a65b-4239-bc9a-fb30c3d7fe1f",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "6a0e0d00-ecc3-498c-b169-c25dab22b5cb",
"Type": "AttributeSetup"
},
{
"AttributeUid": "a90ad67f-6136-4d62-9cdb-61bb1e16c18a",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "9e8c30ca-d497-4613-b435-1ecd6d23804d",
"Type": "AttributeSetup"
}
],
"Uid": "0c6f696c-28b9-4cfe-b7cf-ab82f0bb2d94",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Videos",
"Properties": [
{
"AttributeUid": "8dd5744b-36b1-4000-91e4-42fa2e61ee81",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "69e1060b-683c-474f-85e5-a65ac093fb0a",
"Type": "AttributeSetup"
}
],
"Uid": "58f4574b-4f6b-409e-aea1-cd8c0861036f",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "c3716891-30a9-4421-b745-84b50091c58e",
"Type": "DynamicTabSetup"
},
{
"Uid": "8c7405a3-9f1e-494d-8930-9c9f131090db",
"Type": "ClassificationsTabSetup"
},
{
"Uid": "3f6574e9-cf12-4b0f-958a-e3091d224a6a",
"Type": "VariantsTabSetup"
}
]
},
"VariantConfiguration": {
"ThumbnailReference": "Variant_7e3ea472-a65b-4239-bc9a-fb30c3d7fe1f",
"CreateWizard": {
"Uid": "db9a5a29-60dd-409d-90fd-f554071b6684",
"Steps": [
{
"Properties": [
{
"PropertyUid": "13982a0f-a86d-4e21-afbb-edcc3026cd29",
"Mandatory": true,
"Uid": "9fa3d650-3fa5-4f7c-9b6a-262e1240f46a",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "31ace3e3-7dd0-4fb7-9e6b-b155814e64a6",
"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": "7f662ab0-a342-4c36-9336-52a2e95a5ea1",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "13982a0f-a86d-4e21-afbb-edcc3026cd29",
"Type": "AttributeSetup"
},
{
"AttributeUid": "e89270aa-5d23-4507-835f-92256b648763",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "e18a0c8c-1e71-40f5-bcbd-0651e839bf84",
"Type": "AttributeSetup"
},
{
"AttributeUid": "315346e9-7a61-47db-b4f9-31fee05cc3d1",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "5fb4fe8b-e647-46fc-a69d-f9be1cec00e5",
"Type": "AttributeSetup"
}
],
"Uid": "828d61d9-30b9-435b-93fc-4e271073be69",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "e7ac2d03-bc9f-4ca6-8377-0b7f11ed45b0",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "View and override product image if necessary",
"Properties": [
{
"AttributeUid": "7e3ea472-a65b-4239-bc9a-fb30c3d7fe1f",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": true,
"Uid": "598d5e2d-2bb4-4612-bc88-e97297846bec",
"Type": "AttributeSetup"
}
],
"Uid": "85b34990-d2ec-485d-adc0-b943fcb87cc5",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "efb08377-9400-4e91-bc4e-ec6ee6d8502d",
"Type": "DynamicTabSetup"
}
]
},
"VariationDefinitions": [
{
"Uid": "e11d5f25-6dfa-4dc5-a714-c425ec3bfa0a",
"Alias": "ColorVariants",
"Name": "Color variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"7f662ab0-a342-4c36-9336-52a2e95a5ea1",
"e89270aa-5d23-4507-835f-92256b648763"
]
},
"DefiningAttributes": [
"e89270aa-5d23-4507-835f-92256b648763"
],
"SortOrder": 1
},
{
"Uid": "c249d4ab-a642-4b26-ba5c-5812c72165e0",
"Alias": "SizeVariants",
"Name": "Size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"7f662ab0-a342-4c36-9336-52a2e95a5ea1",
"315346e9-7a61-47db-b4f9-31fee05cc3d1"
]
},
"DefiningAttributes": [
"315346e9-7a61-47db-b4f9-31fee05cc3d1"
],
"SortOrder": 1
},
{
"Uid": "747a9d82-2232-44d3-bccd-72af33c660b5",
"Alias": "ColorAndSizeVariants",
"Name": "Color/size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1} / {2}",
"NameAttributes": [
"7f662ab0-a342-4c36-9336-52a2e95a5ea1",
"e89270aa-5d23-4507-835f-92256b648763",
"315346e9-7a61-47db-b4f9-31fee05cc3d1"
]
},
"DefiningAttributes": [
"e89270aa-5d23-4507-835f-92256b648763",
"315346e9-7a61-47db-b4f9-31fee05cc3d1"
],
"SortOrder": 3
}
],
"ProductIdentifierDefinitions": [
{
"Uid": "c55a5984-9a29-4a45-9b98-ac73bbbd65f1",
"Alias": "ModelNoIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"99bdd256-7ac6-4148-8c07-619a06f560f9"
]
}
],
"VariantIdentifierDefinitions": [
{
"Uid": "578ea32d-7909-406a-a890-80ecbaae30fc",
"Alias": "SKUIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"7f662ab0-a342-4c36-9336-52a2e95a5ea1"
]
}
]
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
model | body | object : ProductStructure |
Product structure to create |
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 |
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 |
Property name | Data type | Description |
---|---|---|
NamePattern | string |
Pattern defining how attribute values shall be concatenated to form a name. Ex. {0} - {1} |
NameAttributes | array |
Uids of attributes to use in rendering. Number of attributes must match number of referenced attributes in NamePattern |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard setup |
Steps | array : WizardStepSetup |
The steps that are part of this wizard |
Property name | Data type | Description |
---|---|---|
Properties | array : WizardPropertySetup |
Properties that shall be shown on this wizard step |
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
PropertyUid | string |
Reference to property uid on configuration defining the attribute |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Mandatory | boolean |
Defines if the defining attributes are mandatory in the step they are shown |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Add an optional display name to show for the property in the backoffice wizard |
DisplayDescription | string |
Add an optional description to show for the property in the backoffice wizard |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Label | string |
The headline this tab shall be presented with in the backoffice |
Sections | array : SectionSetup |
The sections shown on this tab in the backoffice |
ShowSidebar | boolean |
Shows product status sidebar in backoffice |
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Headline | string |
Headline of section |
Description | string |
Description to show on section |
Properties | array : PropertySetup |
Properties shown in section |
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Width | integer |
Width of the preview property |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
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 |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Name to show for the property in the backoffice |
DisplayDescription | string |
Description to show for the property in the backoffice |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
AttributeUid | string |
Uid of attribute |
ReadOnly | boolean |
Defines if the attribute value is read only |
Mandatory | boolean |
Defines if the attribute must have a value before the user can save the tab |
Unchangeable | boolean |
Defines if the attribute value cannot change, once it has gotten a value |
Inherits | boolean |
Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default. |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
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 |
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 |
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 |
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)
GET /productstructures/{uid} Get a product structure
#Available from v.3.2.0
{
"Uid": "4d6dd3bc-75e6-49cc-b966-4390b572980d",
"Alias": "NonFood",
"Label": "Non-food",
"HasVariants": true,
"HasVariantGroups": false,
"ProductConfiguration": {
"ThumbnailReference": "Product_df0e4e6b-b44f-4916-aed3-a2d454a1f906",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"0550ef0a-5a6d-440b-a1c9-6f024ced5a61",
"d38ba2bc-619a-4948-96ee-df94fb397c33"
]
},
"CreateWizard": {
"Uid": "03da005e-dc57-4d6d-bfe6-01fcc7edd9b4",
"Steps": [
{
"Properties": [
{
"PropertyUid": "14ea2789-5dfe-4c97-9a55-bfbd90f4f2f5",
"Mandatory": true,
"Uid": "5163ca37-920d-417c-a686-0560f088b2b6",
"Type": "AttributeWizardPropertySetup"
},
{
"PropertyUid": "8db00cac-9a0a-49bb-b020-6d22a3d481a7",
"Mandatory": false,
"Uid": "9da94bf6-cf14-4d5c-b187-b3a85703ec69",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "c0cde432-1354-44f2-b381-ee82aa438723",
"Headline": "Step 1 - basic information",
"Description": "Add basic information about the product",
"Type": "DynamicWizardStepSetup"
},
{
"Properties": [
{
"PropertyUid": "fa386d97-a32e-4393-be65-8671047aaab7",
"Mandatory": true,
"Uid": "6507f7b3-d478-42a3-a0e7-d36e6a9d5baa",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "c6de893e-0699-444f-88a4-bb83b9afc947",
"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": "d38ba2bc-619a-4948-96ee-df94fb397c33",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "14ea2789-5dfe-4c97-9a55-bfbd90f4f2f5",
"Type": "AttributeSetup"
},
{
"AttributeUid": "0550ef0a-5a6d-440b-a1c9-6f024ced5a61",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "8db00cac-9a0a-49bb-b020-6d22a3d481a7",
"Type": "AttributeSetup"
},
{
"AttributeUid": "c4c77ef7-f8c1-4458-9c0a-aef384d68658",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "44f9eb98-cce2-4f7c-8c90-e7d5a7666bd5",
"Type": "AttributeSetup"
},
{
"DisplayName": "Variant type",
"DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
"Uid": "2f7c6ada-cf36-4569-b162-7c0c70649f60",
"Type": "VariationDefinitionSetup"
}
],
"Uid": "2e5cb20d-3397-45ed-8f61-b0df9794f5d3",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Weight & Size information",
"Properties": [
{
"AttributeUid": "be635401-49a3-4c35-b79c-17330e909946",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "7c53165e-8681-4b00-a64e-771b1434b700",
"Type": "AttributeSetup"
},
{
"AttributeUid": "1b6d95cf-1f84-4d45-8fb4-573b9c5a4645",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "e9f78f6b-c5f2-4cde-b80a-9fe0388ed869",
"Type": "AttributeSetup"
}
],
"Uid": "722eab88-2a25-4450-be5c-bd3674ba1a03",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "739ffa57-cee3-4c22-95ff-b4e1f2a3139d",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "Manage primary image and environment images for product",
"Properties": [
{
"AttributeUid": "df0e4e6b-b44f-4916-aed3-a2d454a1f906",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "fa386d97-a32e-4393-be65-8671047aaab7",
"Type": "AttributeSetup"
},
{
"AttributeUid": "58939215-976d-43b4-b401-2b21438ee83d",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "7fef1ee8-085e-4815-9ad5-91d6e3c4a9e6",
"Type": "AttributeSetup"
}
],
"Uid": "e74daa9a-1f37-44af-8b97-4b50b50ac4d3",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Videos",
"Properties": [
{
"AttributeUid": "f655ebea-949c-40e3-93ba-5fd748bf7b91",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "5168038d-330a-4315-a1c4-5103af31518d",
"Type": "AttributeSetup"
}
],
"Uid": "bb4d49d3-b03c-41e4-97fe-dd6b05d662bf",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "94db24ec-1a29-45c7-8276-2b2b4efded47",
"Type": "DynamicTabSetup"
},
{
"Uid": "27e2271b-ce8d-4c02-bdb1-e16dce9ae89f",
"Type": "ClassificationsTabSetup"
},
{
"Uid": "7d0d8c77-68d5-465b-a9fb-01df948012ab",
"Type": "VariantsTabSetup"
}
]
},
"VariantConfiguration": {
"ThumbnailReference": "Variant_df0e4e6b-b44f-4916-aed3-a2d454a1f906",
"CreateWizard": {
"Uid": "c41d203d-88b6-4099-9d8b-c982b5dfe81b",
"Steps": [
{
"Properties": [
{
"PropertyUid": "2298a1ee-e60b-47c7-9353-8c446d10c5b0",
"Mandatory": true,
"Uid": "800149bd-f5b1-4f88-9daa-6ec597c44da2",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "3e5a0c7e-b6ce-4758-ba16-3095fd4e8540",
"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": "37e38a4b-0ddf-44b4-927f-48e4d7a791c4",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "2298a1ee-e60b-47c7-9353-8c446d10c5b0",
"Type": "AttributeSetup"
},
{
"AttributeUid": "852f265d-0d44-46e6-9c3d-f9bab2d37640",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "ff7f5935-e5a0-46eb-bca7-6118eade2f57",
"Type": "AttributeSetup"
},
{
"AttributeUid": "f84a8113-b15a-410e-90f3-f065915ea043",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "2a35f279-6c91-4dbb-8275-af823715ff9d",
"Type": "AttributeSetup"
}
],
"Uid": "e3322cda-a765-442d-be67-26718ec2df22",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "42d109e9-ef1f-49a4-8f45-93cad2a11f76",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "View and override product image if necessary",
"Properties": [
{
"AttributeUid": "df0e4e6b-b44f-4916-aed3-a2d454a1f906",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": true,
"Uid": "f5350213-a5a0-45dc-8cbe-5a2ccf8b5266",
"Type": "AttributeSetup"
}
],
"Uid": "86803cd1-c6fc-48c5-942f-f9c8224a8719",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "b3ae8573-0fa8-42ab-ab90-b85a451ad322",
"Type": "DynamicTabSetup"
}
]
},
"VariationDefinitions": [
{
"Uid": "1d6ddb24-d4e3-42b8-97f0-d1253b27f360",
"Alias": "ColorVariants",
"Name": "Color variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"37e38a4b-0ddf-44b4-927f-48e4d7a791c4",
"852f265d-0d44-46e6-9c3d-f9bab2d37640"
]
},
"DefiningAttributes": [
"852f265d-0d44-46e6-9c3d-f9bab2d37640"
],
"SortOrder": 1
},
{
"Uid": "761c4e33-b68f-4840-a365-955e0699e5fc",
"Alias": "SizeVariants",
"Name": "Size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"37e38a4b-0ddf-44b4-927f-48e4d7a791c4",
"f84a8113-b15a-410e-90f3-f065915ea043"
]
},
"DefiningAttributes": [
"f84a8113-b15a-410e-90f3-f065915ea043"
],
"SortOrder": 1
},
{
"Uid": "de3ec87c-5e6b-47b8-94fa-d018d43238e7",
"Alias": "ColorAndSizeVariants",
"Name": "Color/size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1} / {2}",
"NameAttributes": [
"37e38a4b-0ddf-44b4-927f-48e4d7a791c4",
"852f265d-0d44-46e6-9c3d-f9bab2d37640",
"f84a8113-b15a-410e-90f3-f065915ea043"
]
},
"DefiningAttributes": [
"852f265d-0d44-46e6-9c3d-f9bab2d37640",
"f84a8113-b15a-410e-90f3-f065915ea043"
],
"SortOrder": 3
}
],
"ProductIdentifierDefinitions": [
{
"Uid": "097b7d91-0878-465f-8e19-a36333e30d7d",
"Alias": "ModelNoIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"0550ef0a-5a6d-440b-a1c9-6f024ced5a61"
]
}
],
"VariantIdentifierDefinitions": [
{
"Uid": "087b0f15-b55d-4ea9-b704-5e6a6a7ca9dc",
"Alias": "SKUIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"37e38a4b-0ddf-44b4-927f-48e4d7a791c4"
]
}
]
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
uid | path | string |
Unique id of product structure |
Response status OK (200)
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 |
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 |
Property name | Data type | Description |
---|---|---|
NamePattern | string |
Pattern defining how attribute values shall be concatenated to form a name. Ex. {0} - {1} |
NameAttributes | array |
Uids of attributes to use in rendering. Number of attributes must match number of referenced attributes in NamePattern |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard setup |
Steps | array : WizardStepSetup |
The steps that are part of this wizard |
Property name | Data type | Description |
---|---|---|
Properties | array : WizardPropertySetup |
Properties that shall be shown on this wizard step |
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of wizard step |
Headline | string |
Headline for wizard step |
Description | string |
Description for wizard step |
Type | string |
The type of wizard step defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
PropertyUid | string |
Reference to property uid on configuration defining the attribute |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Mandatory | boolean |
Defines if the defining attributes are mandatory in the step they are shown |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Add an optional display name to show for the property in the backoffice wizard |
DisplayDescription | string |
Add an optional description to show for the property in the backoffice wizard |
Mandatory | boolean |
Defines if this property must be fulfilled for the user to be able to go to next step in the wizard |
Uid | string |
Unique id of wizard property |
Type | string |
The type of wizard property defining the actual implementation type of the abstract WizardStep |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Label | string |
The headline this tab shall be presented with in the backoffice |
Sections | array : SectionSetup |
The sections shown on this tab in the backoffice |
ShowSidebar | boolean |
Shows product status sidebar in backoffice |
Uid | string |
Unique id of tab |
ViewPermission | string |
Uid of permision required to view this tab |
SavePermission | string |
Uid of permission required to edit data on this tab |
Type | string |
The type of tab defining the actual implementation type of the abstract Tab |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Headline | string |
Headline of section |
Description | string |
Description to show on section |
Properties | array : PropertySetup |
Properties shown in section |
Uid | string |
Unique id of section |
ViewPermission | string |
Permission required to view section |
SavePermission | string |
Permission required to edit data in this section |
Type | string |
The type of section defining the actual implementation type of the abstract Section |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Width | integer |
Width of the preview property |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
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 |
Property name | Data type | Description |
---|---|---|
DisplayName | string |
Name to show for the property in the backoffice |
DisplayDescription | string |
Description to show for the property in the backoffice |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
AttributeUid | string |
Uid of attribute |
ReadOnly | boolean |
Defines if the attribute value is read only |
Mandatory | boolean |
Defines if the attribute must have a value before the user can save the tab |
Unchangeable | boolean |
Defines if the attribute value cannot change, once it has gotten a value |
Inherits | boolean |
Can relevant to variant configuration. If the same attribute is connected to the product configuration and variant configuration of a product structure, setting Inherits to true will make the value set on the product inherit to its variants by default. |
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of property |
ViewPermission | string |
Permission required to view property |
SavePermission | string |
Permission required to edit property |
Type | string |
The type of property defining the actual implementation type of the abstract Property |
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 |
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 |
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 |
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 |