Product Structures
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.
#Available from v.3.4.0
Authorizations
AuthorizationstringRequired
Responses
200
OK
application/json
Product structure is the model that defines the fields available on products and variants as well as how these are presented in tabs and sections in the PIM backoffice
Uidstring · uuidOptional
Unique id of product structure
Aliasstring · nullableOptional
Unique human readable alias of product structure
Labelstring · nullableOptional
Presented name of product structure in backoffice
HasVariantsbooleanOptional
Indicates whether products using this product structure can have variants. VariantConfiguration is required when this is true
HasVariantGroupsbooleanOptional
Indicates whether products using this product structure can have variant groups. VariantGroupConfiguration is required when this is true
AlwaysOnDefiningAttributesstring · uuid[] · nullableOptional
Set defining attributes that must always be available no matter if they are part of the variation definition for a variant or not
get/v1/productstructures
GET /v1/productstructures HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200
OK
[
{
"Uid": "095c8ee0-2cac-4efc-8c5c-82fd94c94db3",
"Alias": "NonFood",
"Label": "Non-food",
"HasVariants": true,
"HasVariantGroups": false,
"ProductConfiguration": {
"ThumbnailReference": "Product_c2ec82f4-9734-411c-b39c-c1fe9756fc08",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"db208b66-60b5-4961-8f76-099da6900a58",
"a7556adc-6237-4b40-bde8-6bcc36979722"
]
},
"CreateWizard": {
"Uid": "132e11d7-05de-4e96-b95f-10c7ae8f7cdc",
"Steps": [
{
"Properties": [
{
"PropertyUid": "11c3d4f5-9bb8-4ffb-a8ae-047fb2d3e7fb",
"Mandatory": true,
"Uid": "ce2f6504-76f4-4899-b31a-5cdaedbd8f26",
"Type": "AttributeWizardPropertySetup"
},
{
"PropertyUid": "5b4f90c0-2b21-4131-b28d-4ab78aa5cefc",
"Mandatory": false,
"Uid": "1360cecc-76b8-4a61-968f-5699746c0ef5",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "ba2da1a2-6c2d-4dfa-adb4-3936620ea645",
"Headline": "Step 1 - basic information",
"Description": "Add basic information about the product",
"Type": "DynamicWizardStepSetup"
},
{
"Properties": [
{
"PropertyUid": "827b3bee-06c2-451d-b11d-c0adca5b772e",
"Mandatory": true,
"Uid": "e5074c6f-68dd-47d4-9333-3be9088247cd",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "24aa848e-558b-4d54-a1d5-bc6ae0dc4a5f",
"Headline": "Step 2 - Media",
"Description": "Add an image to the product",
"Type": "DynamicWizardStepSetup"
}
]
},
"CopyWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "Basic information about the product",
"Properties": [
{
"AttributeUid": "a7556adc-6237-4b40-bde8-6bcc36979722",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "11c3d4f5-9bb8-4ffb-a8ae-047fb2d3e7fb",
"ViewPermission": "db550971-f2f3-4234-83f1-ff250238749c",
"SavePermission": "68b31e1b-36fd-45f7-8480-29ce43255e40",
"Type": "AttributeSetup"
},
{
"AttributeUid": "db208b66-60b5-4961-8f76-099da6900a58",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "5b4f90c0-2b21-4131-b28d-4ab78aa5cefc",
"ViewPermission": "c80542e2-41df-4a5f-80cc-7a5ae98ea7fd",
"SavePermission": "70dd9f38-cc0d-483e-9191-1594d080eafd",
"Type": "AttributeSetup"
},
{
"AttributeUid": "29b121e6-0a0d-4d95-90d0-12928ff9d64a",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "80f60945-e795-4546-ad60-b7855c77457b",
"ViewPermission": "da9ea1c4-5de5-41d4-892e-3d50b64fa7b1",
"SavePermission": "31d38432-0922-4d41-8211-4ac93acdc661",
"Type": "AttributeSetup"
},
{
"DisplayName": "Variant type",
"DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
"Uid": "75928960-c7c1-4404-b4e5-8a49e87ff195",
"ViewPermission": "73c7911d-391f-487c-939d-c3d31822587c",
"SavePermission": "bed577fb-f1c7-46da-be34-b91c4bf65465",
"Type": "VariationDefinitionSetup"
}
],
"Uid": "9faedd0b-e0a1-4c6d-8fcd-2a17f764c92d",
"ViewPermission": "840bb0fa-ef1c-418a-9ac5-0c9c09fe136f",
"SavePermission": "af94d8d0-f59f-4556-a074-6d750a9b6e2e",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Weight & Size information",
"Description": "",
"Properties": [
{
"AttributeUid": "e476750d-943e-4c69-bc48-dcbb965f6c6f",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "19574817-c1fc-480b-b3f2-36943ceedcce",
"ViewPermission": "a6633589-c816-4d47-b139-9e654215c30e",
"SavePermission": "1c0ff32a-c8db-4db0-ab8f-ade271a001ce",
"Type": "AttributeSetup"
},
{
"AttributeUid": "3cced2bc-a7b5-4148-b243-07594af38973",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "245031c0-8289-4cd7-8764-01fad3969fc4",
"ViewPermission": "d4af6534-fdef-41b8-993b-68fcefa14a42",
"SavePermission": "fce1f9f8-e547-4ec2-8a0b-b98009e7e604",
"Type": "AttributeSetup"
}
],
"Uid": "72bb447d-8310-43f0-b567-c67bd9cc0cce",
"ViewPermission": "6d760342-2b78-43c9-9c64-36016a0aefa5",
"SavePermission": "317c14aa-5b6b-4c74-9d5f-7acf5c2ea09a",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "86594655-291d-4b65-a0a8-acb988b7682f",
"ViewPermission": "9775dfb9-c45d-406c-9086-c97e7b428a86",
"SavePermission": "193cd53c-35d3-4dd8-8d8d-bc11cf608fbe",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "Manage primary image and environment images for product",
"Properties": [
{
"AttributeUid": "c2ec82f4-9734-411c-b39c-c1fe9756fc08",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "827b3bee-06c2-451d-b11d-c0adca5b772e",
"ViewPermission": "44451d0a-21c9-400a-ab28-d37146050d63",
"SavePermission": "03bef8c4-44b6-4695-99cf-de4f0e7fb754",
"Type": "AttributeSetup"
},
{
"AttributeUid": "982de2f5-165e-4ab2-8557-57fcd7fc24ea",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "c16a5f08-cdb3-479e-9baa-1552a5f82f04",
"ViewPermission": "d2c9379d-3028-4a14-a6a2-68d758ff8903",
"SavePermission": "00d2d128-8a0e-4508-b99f-61864e3aacab",
"Type": "AttributeSetup"
}
],
"Uid": "8304afae-a13f-4183-9da2-46c98505ba42",
"ViewPermission": "0fc533ae-41e1-49f8-a6e8-143058ef427f",
"SavePermission": "1e2d3259-4720-407a-bc15-69cbf61e706c",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Videos",
"Description": null,
"Properties": [
{
"AttributeUid": "25f4210b-3989-4cdc-a1f0-e9c39f1f30f0",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "31744c34-3469-49d3-8ce4-d1b507c4dfc0",
"ViewPermission": "6d6c496f-3292-4fcc-8e9e-623ac7967314",
"SavePermission": "e6d26a14-4914-4967-94ce-c91c90b6c2b2",
"Type": "AttributeSetup"
}
],
"Uid": "a3917154-a21f-4261-a674-f7d9e3620974",
"ViewPermission": "2d9c465e-9b4b-4334-828e-4d585c333027",
"SavePermission": "8ca4fe12-d072-467e-b213-49de6987fafc",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "28b2f70c-fa50-4778-9c85-d5c452493f39",
"ViewPermission": "bdca15c4-03dd-4f09-af62-9817017f716b",
"SavePermission": "22c00d6f-0274-4fa8-bddd-c052b138aaa8",
"Type": "DynamicTabSetup"
},
{
"Uid": "441f4129-a46d-4251-8c2d-4b1bb8ffff34",
"ViewPermission": "ff653bd0-2e9f-4b39-b917-1f69dc98a92a",
"SavePermission": "4e3be88f-906e-48cf-8845-d4089e298ad8",
"Type": "ClassificationsTabSetup"
},
{
"Uid": "fb20da3d-55f2-4c39-a7bd-6f24c2147c93",
"ViewPermission": "b6a6149c-c2e4-4d23-ac19-bd7a945dd197",
"SavePermission": "2eb529c8-7fac-4a4c-be74-452a44585637",
"Type": "VariantsTabSetup"
}
]
},
"VariantGroupConfiguration": null,
"VariantConfiguration": {
"ThumbnailReference": "Variant_c2ec82f4-9734-411c-b39c-c1fe9756fc08",
"CreateWizard": {
"Uid": "8d39e76f-e0f7-4441-b517-196598b41c78",
"Steps": [
{
"Properties": [
{
"PropertyUid": "cd445e64-3885-40cb-a9c8-fb9a393f1582",
"Mandatory": true,
"Uid": "2f6a448e-a15d-4077-9b7d-d321962912d3",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "f2bad8eb-3b5a-48d6-93cd-425dbda68b90",
"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": "13a39a67-885f-4b78-841e-c2f11c7c04dd",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "cd445e64-3885-40cb-a9c8-fb9a393f1582",
"ViewPermission": "9744fa16-c56b-4211-ab18-01686ea8a051",
"SavePermission": "ac0de76d-277f-4812-842a-0e0ce9b4c286",
"Type": "AttributeSetup"
},
{
"AttributeUid": "cfe97995-3295-4c70-a128-ac9c69a99cf3",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "ccc07cc7-8669-4543-9317-0070919bbe63",
"ViewPermission": "2c9f9d18-40f8-42c8-a065-6fe8a9fab2bf",
"SavePermission": "02e9889b-0ad7-4e1f-8582-0c2fde50332d",
"Type": "AttributeSetup"
},
{
"AttributeUid": "4e0914df-262a-4a88-8719-3867408f4045",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "aeddde8d-ad25-4570-9475-73a24fc9f861",
"ViewPermission": "c1f778dd-1920-4c82-8fce-5c8b764d6d28",
"SavePermission": "1ddc301f-7d40-472b-b10e-1e51f3440833",
"Type": "AttributeSetup"
}
],
"Uid": "cbb35be6-dbef-4238-b40f-4ce17f458a9d",
"ViewPermission": "a8af2b3a-89fa-497b-9655-a06dc5f45b9f",
"SavePermission": "62c793db-868b-4450-9b3a-27b669964d70",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "228f1d59-bc7e-4feb-b086-415c41c6a5e9",
"ViewPermission": "b619e9bc-c48c-416c-bc99-3e25e0af5ab5",
"SavePermission": "59ef5994-8427-4dd6-b490-95dace0d6325",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "View and override product image if necessary",
"Properties": [
{
"AttributeUid": "c2ec82f4-9734-411c-b39c-c1fe9756fc08",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": true,
"Uid": "92b63421-a90e-488a-a449-a0700d63dc36",
"ViewPermission": "37c7c160-3ebd-47e0-8e19-efa3d0989e1f",
"SavePermission": "deaf03a3-b2f8-4294-9018-c8fb9283e9de",
"Type": "AttributeSetup"
}
],
"Uid": "1c9280d6-0c29-4e38-90d5-b5df2409d604",
"ViewPermission": "25022b49-afbf-4252-b82f-1964f4522db8",
"SavePermission": "bdc66e17-abb6-4a03-8e5f-0ff82012fe8e",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "eef56724-f41e-4142-b1eb-76a07473457d",
"ViewPermission": "5c2c4f91-65e1-4fed-aeb1-f14828c3c57f",
"SavePermission": "ec54019b-39e9-44df-b158-615ed7597280",
"Type": "DynamicTabSetup"
}
]
},
"VariationDefinitions": [
{
"Uid": "b615be5a-c111-4bba-8113-2042dcc69ff6",
"Alias": "ColorVariants",
"Name": "Color variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"13a39a67-885f-4b78-841e-c2f11c7c04dd",
"cfe97995-3295-4c70-a128-ac9c69a99cf3"
]
},
"DefiningAttributes": [
"cfe97995-3295-4c70-a128-ac9c69a99cf3"
],
"SortOrder": 1
},
{
"Uid": "b5ae71b9-b206-4fd7-823a-acecfb9100c7",
"Alias": "SizeVariants",
"Name": "Size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"13a39a67-885f-4b78-841e-c2f11c7c04dd",
"4e0914df-262a-4a88-8719-3867408f4045"
]
},
"DefiningAttributes": [
"4e0914df-262a-4a88-8719-3867408f4045"
],
"SortOrder": 1
},
{
"Uid": "21995003-e46b-4a21-9e77-7cc6473852f6",
"Alias": "ColorAndSizeVariants",
"Name": "Color/size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1} / {2}",
"NameAttributes": [
"13a39a67-885f-4b78-841e-c2f11c7c04dd",
"cfe97995-3295-4c70-a128-ac9c69a99cf3",
"4e0914df-262a-4a88-8719-3867408f4045"
]
},
"DefiningAttributes": [
"cfe97995-3295-4c70-a128-ac9c69a99cf3",
"4e0914df-262a-4a88-8719-3867408f4045"
],
"SortOrder": 3
}
],
"AlwaysOnDefiningAttributes": null,
"ProductIdentifierDefinitions": [
{
"Uid": "30adba6e-1117-4d5e-8725-9eb9efc0de25",
"Alias": "ModelNoIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"db208b66-60b5-4961-8f76-099da6900a58"
]
}
],
"VariantGroupIdentifierDefinitions": null,
"VariantIdentifierDefinitions": [
{
"Uid": "8075fac6-934f-460b-8abe-eba7f637e1ab",
"Alias": "SKUIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"13a39a67-885f-4b78-841e-c2f11c7c04dd"
]
}
]
}
]#Available from v.3.2.0
Authorizations
AuthorizationstringRequired
Body
Product structure is the model that defines the fields available on products and variants as well as how these are presented in tabs and sections in the PIM backoffice
Uidstring · uuidOptional
Unique id of product structure
Aliasstring · nullableOptional
Unique human readable alias of product structure
Labelstring · nullableOptional
Presented name of product structure in backoffice
HasVariantsbooleanOptional
Indicates whether products using this product structure can have variants. VariantConfiguration is required when this is true
HasVariantGroupsbooleanOptional
Indicates whether products using this product structure can have variant groups. VariantGroupConfiguration is required when this is true
AlwaysOnDefiningAttributesstring · uuid[] · nullableOptional
Set defining attributes that must always be available no matter if they are part of the variation definition for a variant or not
Responses
200
OK
No content
400
Bad Request
application/json
post/v1/productstructures
POST /v1/productstructures HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10362
{
"Uid": "f9691617-8add-4dea-a9c3-26cfe445ce5d",
"Alias": "NonFood",
"Label": "Non-food",
"HasVariants": true,
"HasVariantGroups": false,
"ProductConfiguration": {
"ThumbnailReference": "Product_7cceb816-cc0a-4479-ba4c-50b3a4bdfaf8",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"c67206d5-186e-45c0-a35a-1e5549412262",
"cc6d6943-c23d-4a50-9f3c-de34686d1674"
]
},
"CreateWizard": {
"Uid": "ca7e53e7-a2c0-4388-8033-4f8c898993b4",
"Steps": [
{
"Properties": [
{
"PropertyUid": "11bf7301-d167-406e-b8a9-d4cc16575650",
"Mandatory": true,
"Uid": "53044271-3052-4796-a674-8b11de68aad9",
"Type": "AttributeWizardPropertySetup"
},
{
"PropertyUid": "bb64bbfc-a2ca-4dc8-b0e3-6d6a3bdae7db",
"Mandatory": false,
"Uid": "3361749a-5a4e-46a1-b82d-1e0f65e4f70f",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "4edb4296-9a8f-4d06-a37f-64b280d1a7a7",
"Headline": "Step 1 - basic information",
"Description": "Add basic information about the product",
"Type": "DynamicWizardStepSetup"
},
{
"Properties": [
{
"PropertyUid": "0bb338f4-5c5b-4de0-aeaa-b4ffb7e85653",
"Mandatory": true,
"Uid": "9a01035f-606d-49c0-8acf-e30c1d118800",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "62f88319-4404-4bd7-9d88-ecb2aafc7541",
"Headline": "Step 2 - Media",
"Description": "Add an image to the product",
"Type": "DynamicWizardStepSetup"
}
]
},
"CopyWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "Basic information about the product",
"Properties": [
{
"AttributeUid": "cc6d6943-c23d-4a50-9f3c-de34686d1674",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "11bf7301-d167-406e-b8a9-d4cc16575650",
"ViewPermission": "986d5445-693d-4176-bed7-6646d6d2ac00",
"SavePermission": "e2090ad8-b83d-4f67-ac8b-543b07c24af9",
"Type": "AttributeSetup"
},
{
"AttributeUid": "c67206d5-186e-45c0-a35a-1e5549412262",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "bb64bbfc-a2ca-4dc8-b0e3-6d6a3bdae7db",
"ViewPermission": "cd58b220-6aaf-4169-9491-08a0abb1087c",
"SavePermission": "fa279220-65a6-41fc-b253-a50c85b39b2a",
"Type": "AttributeSetup"
},
{
"AttributeUid": "688fe482-0926-4fa0-bd68-c3bf4dd0d587",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "a31a614a-19c1-4dff-afb2-0f78e90ed424",
"ViewPermission": "8d16b870-9c49-4704-8297-f10e4cb699e0",
"SavePermission": "50a8c1d6-212e-460e-a931-5a11e3565ad0",
"Type": "AttributeSetup"
},
{
"DisplayName": "Variant type",
"DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
"Uid": "1f9de0c0-28e2-4aba-8037-ff6ea2414910",
"ViewPermission": "0221470f-98a1-4f49-9a00-03671db2982f",
"SavePermission": "df27bfde-c7ea-47e8-941a-72ca3f7471f0",
"Type": "VariationDefinitionSetup"
}
],
"Uid": "04681c8c-6661-43cb-af75-bc9a06066b18",
"ViewPermission": "79d730ae-1bb4-4531-ae88-6aff47ffb4a2",
"SavePermission": "0e676b72-17d9-40c2-bc0c-cb1e843caf00",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Weight & Size information",
"Description": "",
"Properties": [
{
"AttributeUid": "e399d5d6-ebe0-45f7-a73b-4fedb4207d02",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "93fa1557-0a0a-4e19-8ad0-15cc0f68d803",
"ViewPermission": "08d97f76-8d35-4f22-a141-aa7095e7bde7",
"SavePermission": "881d0224-3ee4-44e2-aaed-9fa4456ddd11",
"Type": "AttributeSetup"
},
{
"AttributeUid": "a36fba6a-d8c7-4dc1-b6f0-4c288c09e97b",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "897bd0fd-c384-49d8-9f60-c14ca405fa7e",
"ViewPermission": "15a2e9c7-eb6f-4423-bcae-760ae1364978",
"SavePermission": "cda76c03-eceb-4fdb-b7a0-8165d415da29",
"Type": "AttributeSetup"
}
],
"Uid": "ad2d8a55-0ef4-4c5e-8418-0cd20b692d11",
"ViewPermission": "d9a9fb54-46b9-42f3-b9e2-72cbc85001fe",
"SavePermission": "4e96691a-aca4-42e2-96f4-dc47ccc80c32",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "9e79f94d-a2d5-4a1b-9ba3-9e0e90814901",
"ViewPermission": "aab8a11b-30b3-4ca8-92ae-3f1448b809f2",
"SavePermission": "2857cb94-1108-4eb1-a22d-df14821a96c9",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "Manage primary image and environment images for product",
"Properties": [
{
"AttributeUid": "7cceb816-cc0a-4479-ba4c-50b3a4bdfaf8",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "0bb338f4-5c5b-4de0-aeaa-b4ffb7e85653",
"ViewPermission": "08857b7e-5995-49c9-adb0-181648ed34e2",
"SavePermission": "b6f517a7-06d0-457e-9e97-ed3e03ea4c94",
"Type": "AttributeSetup"
},
{
"AttributeUid": "ea830a91-1a75-4d28-a2e2-368553baae28",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "cb06af9b-0128-4a33-be6f-35c8534d044c",
"ViewPermission": "c4c8a09b-38e7-4fbe-8753-ef1eca337733",
"SavePermission": "10dcb60f-0416-4ad8-ab15-102bc536ae72",
"Type": "AttributeSetup"
}
],
"Uid": "af627659-5352-46f8-ae1c-5d1f051e706d",
"ViewPermission": "87014dcd-07b7-4fd6-84e2-78ca9d9888a2",
"SavePermission": "a0dc482f-2386-4c89-a24b-ed6e6d3a317a",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Videos",
"Description": null,
"Properties": [
{
"AttributeUid": "c77e0e1c-8f3f-4447-810c-74cb7fd03808",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "beaa5afa-4e4b-4b80-998d-9cbb8c3e8b35",
"ViewPermission": "983bb292-0f50-497d-9011-2c58d8c9671e",
"SavePermission": "bf008015-6439-4e67-9c5b-a195f9e3ff58",
"Type": "AttributeSetup"
}
],
"Uid": "d366ff18-810e-4c1f-93b4-ca16052849a7",
"ViewPermission": "a2e530d3-4c0a-4cd2-a86e-9c3da2518c14",
"SavePermission": "ce64f562-8b09-4aaa-a438-41a05bef23fb",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "e3c01b67-45d7-4373-92b4-114a30e803ed",
"ViewPermission": "fe814d5a-3b04-4d4a-ace8-3516f94997d2",
"SavePermission": "3c4ad69d-9024-4d0e-98f5-13f2774184ee",
"Type": "DynamicTabSetup"
},
{
"Uid": "94c4c089-6274-4625-a1ca-0c53569ba20c",
"ViewPermission": "c24406e3-5522-428b-8085-402817891d74",
"SavePermission": "353876c4-de9a-42c1-a2c6-b4232ead0a57",
"Type": "ClassificationsTabSetup"
},
{
"Uid": "11b5bb1b-47b3-4a7b-9044-b2a0a09bd349",
"ViewPermission": "146a8b62-e757-47c4-9033-50117f359ef5",
"SavePermission": "e8008b7c-c259-4731-8472-918c493bf05a",
"Type": "VariantsTabSetup"
}
]
},
"VariantGroupConfiguration": null,
"VariantConfiguration": {
"ThumbnailReference": "Variant_7cceb816-cc0a-4479-ba4c-50b3a4bdfaf8",
"CreateWizard": {
"Uid": "8052c58e-06a0-4cd3-ae4b-bc1ca40c1544",
"Steps": [
{
"Properties": [
{
"PropertyUid": "ba362d0c-be7d-46a1-ac55-7488611b70ba",
"Mandatory": true,
"Uid": "2ee74811-02c6-4b0d-a673-fe608dd6b203",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "075685be-a32f-4f18-aabb-0609f712e39e",
"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": "f43fee5b-649a-4d93-84a6-4dfb48bc0527",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "ba362d0c-be7d-46a1-ac55-7488611b70ba",
"ViewPermission": "d77b4212-6aa4-444e-8997-731e46447c71",
"SavePermission": "1056fe15-dca8-449e-bc27-450380d15b32",
"Type": "AttributeSetup"
},
{
"AttributeUid": "e59438f3-125f-4474-b616-63648c255623",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "f4f71152-642a-40c8-8d8c-2250decfec43",
"ViewPermission": "7dad5e5e-6049-47a5-aab6-c42f91b04fbd",
"SavePermission": "33ab977c-c0ed-4c19-848c-9a63acc8e8dd",
"Type": "AttributeSetup"
},
{
"AttributeUid": "201d0ec6-2bbf-43a1-be64-68682a74d176",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "f8cad88a-f419-4bfa-8e70-00b5bb5abe5b",
"ViewPermission": "a2b2e584-4a75-40ab-b17c-d92d81b3b3b6",
"SavePermission": "be682df9-59e0-4cbf-9c78-a5959a0632ef",
"Type": "AttributeSetup"
}
],
"Uid": "0535a6b0-0425-46dc-aa07-edfb2f854320",
"ViewPermission": "4fb74749-465a-49e3-8597-b46e6ca21bd1",
"SavePermission": "ddb8a16f-9c6a-4e2a-9db4-2c3d25dfd34d",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "912170e4-f671-4698-97e5-f706d7cdc934",
"ViewPermission": "1c7ef330-0b8e-4ef2-b2f4-7652f09c11d2",
"SavePermission": "b41662ab-5663-482d-ac5b-e3cbf333c3aa",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "View and override product image if necessary",
"Properties": [
{
"AttributeUid": "7cceb816-cc0a-4479-ba4c-50b3a4bdfaf8",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": true,
"Uid": "6df41684-608d-4ed3-b265-1c22aaf04adf",
"ViewPermission": "6efe7ed2-45ff-4826-b8d7-ae3baed0f871",
"SavePermission": "641c1cb0-2c35-4616-87c0-45bb8c63580f",
"Type": "AttributeSetup"
}
],
"Uid": "449f67d0-8dfa-4873-8a7a-c70031f6f4e9",
"ViewPermission": "60f3d359-12dc-4e20-90c9-5ac7bc73fdd9",
"SavePermission": "9970bac0-1741-443f-8c02-2325ff9b0115",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "487b35fd-6be6-457e-8386-bb5f6c11f62a",
"ViewPermission": "cf68f627-8034-426c-a725-976be0f7aabf",
"SavePermission": "2bb378ec-2c99-4681-bad7-9019b9cfe5a8",
"Type": "DynamicTabSetup"
}
]
},
"VariationDefinitions": [
{
"Uid": "35e1f588-d5c6-4708-aa3f-4c7ea3e6f516",
"Alias": "ColorVariants",
"Name": "Color variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"f43fee5b-649a-4d93-84a6-4dfb48bc0527",
"e59438f3-125f-4474-b616-63648c255623"
]
},
"DefiningAttributes": [
"e59438f3-125f-4474-b616-63648c255623"
],
"SortOrder": 1
},
{
"Uid": "f162f9f2-b75c-45f8-a26e-d88b684340fe",
"Alias": "SizeVariants",
"Name": "Size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"f43fee5b-649a-4d93-84a6-4dfb48bc0527",
"201d0ec6-2bbf-43a1-be64-68682a74d176"
]
},
"DefiningAttributes": [
"201d0ec6-2bbf-43a1-be64-68682a74d176"
],
"SortOrder": 1
},
{
"Uid": "3025af35-ce2e-4bec-b1cd-3d6a6022914a",
"Alias": "ColorAndSizeVariants",
"Name": "Color/size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1} / {2}",
"NameAttributes": [
"f43fee5b-649a-4d93-84a6-4dfb48bc0527",
"e59438f3-125f-4474-b616-63648c255623",
"201d0ec6-2bbf-43a1-be64-68682a74d176"
]
},
"DefiningAttributes": [
"e59438f3-125f-4474-b616-63648c255623",
"201d0ec6-2bbf-43a1-be64-68682a74d176"
],
"SortOrder": 3
}
],
"AlwaysOnDefiningAttributes": null,
"ProductIdentifierDefinitions": [
{
"Uid": "f70bf8cd-e7c5-45c9-94f5-e4e2dd40fe1f",
"Alias": "ModelNoIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"c67206d5-186e-45c0-a35a-1e5549412262"
]
}
],
"VariantGroupIdentifierDefinitions": null,
"VariantIdentifierDefinitions": [
{
"Uid": "faa52a03-bbfb-4db4-a52e-70a5a123ca9e",
"Alias": "SKUIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"f43fee5b-649a-4d93-84a6-4dfb48bc0527"
]
}
]
}No content
#Available from v.3.2.0
Authorizations
AuthorizationstringRequired
Body
Product structure is the model that defines the fields available on products and variants as well as how these are presented in tabs and sections in the PIM backoffice
Uidstring · uuidOptional
Unique id of product structure
Aliasstring · nullableOptional
Unique human readable alias of product structure
Labelstring · nullableOptional
Presented name of product structure in backoffice
HasVariantsbooleanOptional
Indicates whether products using this product structure can have variants. VariantConfiguration is required when this is true
HasVariantGroupsbooleanOptional
Indicates whether products using this product structure can have variant groups. VariantGroupConfiguration is required when this is true
AlwaysOnDefiningAttributesstring · uuid[] · nullableOptional
Set defining attributes that must always be available no matter if they are part of the variation definition for a variant or not
Responses
200
OK
No content
400
Bad Request
application/json
put/v1/productstructures
PUT /v1/productstructures HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10362
{
"Uid": "2c00950e-85ff-426c-998e-f6a3af0ff111",
"Alias": "NonFood",
"Label": "Non-food",
"HasVariants": true,
"HasVariantGroups": false,
"ProductConfiguration": {
"ThumbnailReference": "Product_690768b0-045e-422a-9f1c-28a1f45ddfcc",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"30cb0d97-a514-4b0f-b7f7-b4f5d0e1bba9",
"988eeeaf-1fd9-4d9f-8694-b770095a16c5"
]
},
"CreateWizard": {
"Uid": "ae563412-16b9-40bb-afcc-c3079d89a186",
"Steps": [
{
"Properties": [
{
"PropertyUid": "f6b7f92d-f8e6-44d0-83f8-3e1169f409b1",
"Mandatory": true,
"Uid": "086be778-199a-436c-bbd7-cab8acc15817",
"Type": "AttributeWizardPropertySetup"
},
{
"PropertyUid": "f7dbc085-373e-431b-96eb-e8017e6f15bb",
"Mandatory": false,
"Uid": "fd3885b3-5117-4760-869c-91d25d9babbf",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "dc82035c-9ba4-470b-bde1-57bebef26032",
"Headline": "Step 1 - basic information",
"Description": "Add basic information about the product",
"Type": "DynamicWizardStepSetup"
},
{
"Properties": [
{
"PropertyUid": "d95d7e0b-b868-424f-b67d-46592b395879",
"Mandatory": true,
"Uid": "afee5dbf-b079-453b-9289-9e520f55d557",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "5186eff4-4ce9-45e4-9899-b24881dd16b1",
"Headline": "Step 2 - Media",
"Description": "Add an image to the product",
"Type": "DynamicWizardStepSetup"
}
]
},
"CopyWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "Basic information about the product",
"Properties": [
{
"AttributeUid": "988eeeaf-1fd9-4d9f-8694-b770095a16c5",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "f6b7f92d-f8e6-44d0-83f8-3e1169f409b1",
"ViewPermission": "16a22eb5-37a9-4144-9ccc-0b17621f4b0a",
"SavePermission": "92cf7c35-b03a-4f7b-90a2-fb3e022d7ecd",
"Type": "AttributeSetup"
},
{
"AttributeUid": "30cb0d97-a514-4b0f-b7f7-b4f5d0e1bba9",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "f7dbc085-373e-431b-96eb-e8017e6f15bb",
"ViewPermission": "ea681203-c758-40e3-9672-50794249a136",
"SavePermission": "5e30fcc3-1d7a-46ed-933d-087130a6fff2",
"Type": "AttributeSetup"
},
{
"AttributeUid": "ef2ffad9-e901-4a5b-9666-489bb49f46a2",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "a9da34f6-61f2-4a7b-a14a-184f750935e7",
"ViewPermission": "5e28e5fa-315b-49d0-a170-def47b7c0a2b",
"SavePermission": "e232c816-ac0d-4678-83ba-d5d4ff0d57be",
"Type": "AttributeSetup"
},
{
"DisplayName": "Variant type",
"DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
"Uid": "3567ab61-dd87-4721-be45-e7fd39d76f88",
"ViewPermission": "0835d2fa-b80a-4c22-972f-51f886dad093",
"SavePermission": "0ec4c940-34cd-4ebc-a885-12450341da15",
"Type": "VariationDefinitionSetup"
}
],
"Uid": "713151ce-1993-48a3-9a06-cab1df240a5a",
"ViewPermission": "f6bae59d-92ec-4f2b-beb4-7118ccf4b202",
"SavePermission": "d5c70d69-7d4f-4029-9a98-03a240033384",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Weight & Size information",
"Description": "",
"Properties": [
{
"AttributeUid": "f96e71f8-94db-4f60-a367-181a6a9eb4c3",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "5689a9ca-65a6-4a0c-99ef-96da12dfea15",
"ViewPermission": "3fb45aa9-37cb-48f5-92b9-660d29da2874",
"SavePermission": "9369ace1-645c-4147-9eac-068ad180054a",
"Type": "AttributeSetup"
},
{
"AttributeUid": "8eb14035-4612-4d5f-b379-1178775be131",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "9a8a2cf7-d352-4e82-a2d3-72dcc9606397",
"ViewPermission": "dc4c40b9-5a6c-4e53-a266-983d5ffdf14b",
"SavePermission": "9092ab08-a9b7-4a4f-aa78-06b5287e7aa4",
"Type": "AttributeSetup"
}
],
"Uid": "3bd42930-88f6-4853-85c8-a05bd6c43bd0",
"ViewPermission": "a73192e6-0f70-4d28-9a28-4d6530bf4c01",
"SavePermission": "e6c7ca0b-54ee-4fe5-a97b-2438a2699426",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "f9eca380-c033-47e2-ad5f-cee31f442d3f",
"ViewPermission": "8f4fedc2-16ec-4164-859d-32c5702923a8",
"SavePermission": "2d1d18cb-aa91-4d1a-95e2-80144fe064c7",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "Manage primary image and environment images for product",
"Properties": [
{
"AttributeUid": "690768b0-045e-422a-9f1c-28a1f45ddfcc",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "d95d7e0b-b868-424f-b67d-46592b395879",
"ViewPermission": "2732c240-144a-4f3e-a3a4-a7a2bef4e58f",
"SavePermission": "b81b518a-de7b-4814-8019-e2416b59d9b3",
"Type": "AttributeSetup"
},
{
"AttributeUid": "ee521ef8-dcec-40a0-8aee-3170b488c49a",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "ebc34569-e301-4c1d-b97f-ce613c05d8d9",
"ViewPermission": "5b5303db-f5a4-4385-8d77-be4d9d3da61f",
"SavePermission": "dc55658f-dfcc-4019-87db-65c9546b8e70",
"Type": "AttributeSetup"
}
],
"Uid": "7f26b904-0904-4577-92d7-96455fd6524e",
"ViewPermission": "29fcec17-fec5-4dfc-9f4a-77e45321b00f",
"SavePermission": "6549b77f-50e4-4446-bd7d-6f9a5905b67b",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Videos",
"Description": null,
"Properties": [
{
"AttributeUid": "def5dcde-b4e3-49f0-80ee-d4be38ea73c1",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "d84b5b90-0606-498e-93ac-4b4ffa74e67f",
"ViewPermission": "b06d0f05-13f2-40e1-9119-efa1565963c9",
"SavePermission": "d9bde515-c236-4464-8330-fbc27d9e9306",
"Type": "AttributeSetup"
}
],
"Uid": "43020973-a916-4de3-b105-759b4d24b030",
"ViewPermission": "c87cba7b-0daa-4740-9ba9-782c7bc0a917",
"SavePermission": "a0819255-2588-479d-8795-42aac6bdbc67",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "104f2fa3-8d06-4705-aaa6-c5f21fcb918b",
"ViewPermission": "c514ddef-4f8f-44b2-87a5-85b6ce3aadcd",
"SavePermission": "7410b1bb-b56f-4c32-b744-eea257498e42",
"Type": "DynamicTabSetup"
},
{
"Uid": "b3e7d9da-033f-4fbe-8176-e12a31c5aa71",
"ViewPermission": "e14de637-c5b1-4d04-a592-d8ce5ab9f092",
"SavePermission": "9de7cbdc-6425-420a-aa72-cc2417b0a158",
"Type": "ClassificationsTabSetup"
},
{
"Uid": "265f3959-7243-4dab-bea0-4743725570fe",
"ViewPermission": "1ebb7ae8-3b1f-49f6-9853-d17a38a33bc7",
"SavePermission": "476970ed-0d0c-4d93-a6c5-e6b800b23831",
"Type": "VariantsTabSetup"
}
]
},
"VariantGroupConfiguration": null,
"VariantConfiguration": {
"ThumbnailReference": "Variant_690768b0-045e-422a-9f1c-28a1f45ddfcc",
"CreateWizard": {
"Uid": "038fb8fb-9521-4668-8440-24804b0d4872",
"Steps": [
{
"Properties": [
{
"PropertyUid": "43c824fc-c5da-4665-a987-55704d940b8b",
"Mandatory": true,
"Uid": "6352bfff-9d59-435b-9b8a-92c6903516dc",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "ca9f2dd0-0057-4ca1-922a-77d563b1e7ef",
"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": "0c3be92c-6bd5-4ed8-8559-bc176ef92ef4",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "43c824fc-c5da-4665-a987-55704d940b8b",
"ViewPermission": "aa32bbf5-7a45-462a-aeb0-9844d398bf19",
"SavePermission": "6b97cb8f-b183-4ea2-ab3e-72926fdfeb79",
"Type": "AttributeSetup"
},
{
"AttributeUid": "5455bc5d-c110-4b57-b1ae-dfb2de16aa54",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "8112c177-99aa-47eb-92af-4dbe571fa7c1",
"ViewPermission": "752c91e0-8b3e-4c1b-a9e8-fa448aa3b893",
"SavePermission": "40aa68cb-0661-4d1c-a206-8ad1900eac73",
"Type": "AttributeSetup"
},
{
"AttributeUid": "8d93862d-abc0-4b46-a1dc-4ebb1d675185",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "924af1de-b905-4899-811b-86d9ba39ad6f",
"ViewPermission": "97883ab3-0d97-437e-91c5-fdbec8b3a86c",
"SavePermission": "8508ff95-f32d-4577-9784-6dfe0a650bbe",
"Type": "AttributeSetup"
}
],
"Uid": "c5153579-9f35-4fa2-a230-7f2bc976b519",
"ViewPermission": "b0186c52-7b3e-4588-ade5-a7dc447f5a20",
"SavePermission": "f17eae99-612b-493e-9d39-7fc8b8e592a8",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "53ea2af1-02c0-4b7d-a8fa-4219777bceef",
"ViewPermission": "f33c828a-79d8-4f4e-976b-2c136421b3b9",
"SavePermission": "c4ae475d-eb51-4431-80be-becee1a25664",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "View and override product image if necessary",
"Properties": [
{
"AttributeUid": "690768b0-045e-422a-9f1c-28a1f45ddfcc",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": true,
"Uid": "7e60e7cb-b2f1-46e9-85c7-79a3de9d5fa6",
"ViewPermission": "5fa68efe-e5b2-4438-b579-9b824dd1a1f5",
"SavePermission": "39ae75ff-b466-4fa4-bda6-7e61ad56ee95",
"Type": "AttributeSetup"
}
],
"Uid": "f9ee6208-8b35-41e0-b6c3-f4d32e6de195",
"ViewPermission": "21cd7dcf-d72a-41a7-98a6-6bf724c63eeb",
"SavePermission": "b5856fc4-6058-4487-addb-22daac27dba9",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "631e57f8-2056-49fa-8ad0-48f941db8cea",
"ViewPermission": "cdcd29be-f237-4549-bf2d-2bd974b5a619",
"SavePermission": "74c80a94-9ed8-4765-8cb8-6eb919c30d5b",
"Type": "DynamicTabSetup"
}
]
},
"VariationDefinitions": [
{
"Uid": "6fd8dd00-9ce7-4273-bc9b-4432cd7422f2",
"Alias": "ColorVariants",
"Name": "Color variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"0c3be92c-6bd5-4ed8-8559-bc176ef92ef4",
"5455bc5d-c110-4b57-b1ae-dfb2de16aa54"
]
},
"DefiningAttributes": [
"5455bc5d-c110-4b57-b1ae-dfb2de16aa54"
],
"SortOrder": 1
},
{
"Uid": "e4527dfa-f62a-452f-beac-d2b5b4695e0c",
"Alias": "SizeVariants",
"Name": "Size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"0c3be92c-6bd5-4ed8-8559-bc176ef92ef4",
"8d93862d-abc0-4b46-a1dc-4ebb1d675185"
]
},
"DefiningAttributes": [
"8d93862d-abc0-4b46-a1dc-4ebb1d675185"
],
"SortOrder": 1
},
{
"Uid": "f20c2d56-eabc-4dbf-9753-30852c5d99fc",
"Alias": "ColorAndSizeVariants",
"Name": "Color/size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1} / {2}",
"NameAttributes": [
"0c3be92c-6bd5-4ed8-8559-bc176ef92ef4",
"5455bc5d-c110-4b57-b1ae-dfb2de16aa54",
"8d93862d-abc0-4b46-a1dc-4ebb1d675185"
]
},
"DefiningAttributes": [
"5455bc5d-c110-4b57-b1ae-dfb2de16aa54",
"8d93862d-abc0-4b46-a1dc-4ebb1d675185"
],
"SortOrder": 3
}
],
"AlwaysOnDefiningAttributes": null,
"ProductIdentifierDefinitions": [
{
"Uid": "096cdc8b-4278-476f-85f2-4ca3f466162c",
"Alias": "ModelNoIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"30cb0d97-a514-4b0f-b7f7-b4f5d0e1bba9"
]
}
],
"VariantGroupIdentifierDefinitions": null,
"VariantIdentifierDefinitions": [
{
"Uid": "3d7e557d-9d5c-455d-97d3-517624a1ea58",
"Alias": "SKUIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"0c3be92c-6bd5-4ed8-8559-bc176ef92ef4"
]
}
]
}No content
#Available from v.3.2.0
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired
Unique id of product structure
Responses
200
OK
application/json
Product structure is the model that defines the fields available on products and variants as well as how these are presented in tabs and sections in the PIM backoffice
Uidstring · uuidOptional
Unique id of product structure
Aliasstring · nullableOptional
Unique human readable alias of product structure
Labelstring · nullableOptional
Presented name of product structure in backoffice
HasVariantsbooleanOptional
Indicates whether products using this product structure can have variants. VariantConfiguration is required when this is true
HasVariantGroupsbooleanOptional
Indicates whether products using this product structure can have variant groups. VariantGroupConfiguration is required when this is true
AlwaysOnDefiningAttributesstring · uuid[] · nullableOptional
Set defining attributes that must always be available no matter if they are part of the variation definition for a variant or not
404
Not Found
application/json
get/v1/productstructures/{uid}
GET /v1/productstructures/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"Uid": "0f296ca3-b013-4bb1-8e6c-fab699b92450",
"Alias": "NonFood",
"Label": "Non-food",
"HasVariants": true,
"HasVariantGroups": false,
"ProductConfiguration": {
"ThumbnailReference": "Product_3b1da0c5-a84b-4629-8d3b-d8c0e72fd7dc",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"5e100184-50da-4753-9a7f-dc8522c0aa41",
"5d0119b9-6459-46e0-9c34-32f40bc1dbb2"
]
},
"CreateWizard": {
"Uid": "807c7354-f120-4cde-801f-b4e9e8184ee6",
"Steps": [
{
"Properties": [
{
"PropertyUid": "7127bb30-cfd9-47b0-91ff-b687e4fe7a69",
"Mandatory": true,
"Uid": "e95b0977-3247-4fd5-8f40-0b08ea14966f",
"Type": "AttributeWizardPropertySetup"
},
{
"PropertyUid": "6060f20c-9171-4781-bc92-736e1378f97f",
"Mandatory": false,
"Uid": "b794bc01-721a-4318-9478-9fb9ae73dfc3",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "c1b319ea-06d7-4fdf-b773-9a30b1265d08",
"Headline": "Step 1 - basic information",
"Description": "Add basic information about the product",
"Type": "DynamicWizardStepSetup"
},
{
"Properties": [
{
"PropertyUid": "f85638d4-9c7a-4bd5-a56f-ddde3b9b300e",
"Mandatory": true,
"Uid": "8d89a73a-e583-456c-93b1-30885ddaaf23",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "8e00dca0-da04-4dc9-b83b-d333072029fc",
"Headline": "Step 2 - Media",
"Description": "Add an image to the product",
"Type": "DynamicWizardStepSetup"
}
]
},
"CopyWizard": null,
"Tabs": [
{
"Label": "General",
"Sections": [
{
"Headline": "Basic information",
"Description": "Basic information about the product",
"Properties": [
{
"AttributeUid": "5d0119b9-6459-46e0-9c34-32f40bc1dbb2",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "7127bb30-cfd9-47b0-91ff-b687e4fe7a69",
"ViewPermission": "0610e1f1-501f-43a4-a9ac-260e83587e3d",
"SavePermission": "ec734627-b21e-4ac5-b70d-a0098005ed9a",
"Type": "AttributeSetup"
},
{
"AttributeUid": "5e100184-50da-4753-9a7f-dc8522c0aa41",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "6060f20c-9171-4781-bc92-736e1378f97f",
"ViewPermission": "08ae577e-4646-404c-8486-b3c64f0f0f1a",
"SavePermission": "490cba02-d498-4d2e-8b99-3fa391026e57",
"Type": "AttributeSetup"
},
{
"AttributeUid": "c8ebc0e5-46f2-4382-b617-a62a3e52753f",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "9197f848-a47b-45d8-81e3-38fbbdd255c9",
"ViewPermission": "63eff015-cb66-4b87-a061-66363bca9907",
"SavePermission": "5308f2a8-30c6-4be5-ae21-87cb8d778fb8",
"Type": "AttributeSetup"
},
{
"DisplayName": "Variant type",
"DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
"Uid": "9843e5e5-6013-45f5-bf9b-2846169a55d9",
"ViewPermission": "f371ec20-d41d-49fe-9b50-848e5cfec4d9",
"SavePermission": "14faf604-d17c-43b2-9d97-c983285b7f51",
"Type": "VariationDefinitionSetup"
}
],
"Uid": "4a1ae9c3-e59b-4051-a5ec-f506596653a9",
"ViewPermission": "eaafcb63-775a-441c-b426-d6e7671487b4",
"SavePermission": "992ab489-827c-4f06-a2ed-6d1e4f5e6099",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Weight & Size information",
"Description": "",
"Properties": [
{
"AttributeUid": "c5ebfae2-7658-42bb-b3ea-6a4b6834cd47",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "8e4473b4-88d6-40ff-8ed8-64bb5dd5c9f8",
"ViewPermission": "29d73a3f-08f7-422b-9eb2-5f802dd72ff2",
"SavePermission": "ddf7047a-92b1-4d21-8e0e-e07babe19a3f",
"Type": "AttributeSetup"
},
{
"AttributeUid": "b570d891-3555-4e4e-8286-f88c1a234315",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "842222cb-80b6-4247-b6fa-945a29b10b33",
"ViewPermission": "c0807e3d-a317-4750-8acf-dab6af2b5fb3",
"SavePermission": "4d25f856-779b-4806-9c1a-179726d6fa83",
"Type": "AttributeSetup"
}
],
"Uid": "5c25031a-f055-4dfe-8717-3cc9919179ea",
"ViewPermission": "50e64fbc-5aff-4895-b247-d80753d46ade",
"SavePermission": "d49765af-6016-4040-a51f-4a1e913554fe",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "9f7f527b-7337-48e9-bdaf-22428422ac38",
"ViewPermission": "7de5a65f-97a8-48e9-9350-884376eb9956",
"SavePermission": "e2c11728-9493-4d42-a7ce-86569c040608",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "Manage primary image and environment images for product",
"Properties": [
{
"AttributeUid": "3b1da0c5-a84b-4629-8d3b-d8c0e72fd7dc",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "f85638d4-9c7a-4bd5-a56f-ddde3b9b300e",
"ViewPermission": "7b8dd4e3-cc30-4000-8dec-5d58eef53472",
"SavePermission": "d9259ddb-5ea7-414f-91dc-a4eb80d98bb1",
"Type": "AttributeSetup"
},
{
"AttributeUid": "b7466bdd-a864-4fac-bfec-e44cda74d381",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "7cde7bd9-b1c9-4f35-97bd-90af4ae32194",
"ViewPermission": "da9a47ad-078a-472d-b728-c07aa7fa19b5",
"SavePermission": "c39090bb-67d0-4b16-bfa9-b16fd0e7d333",
"Type": "AttributeSetup"
}
],
"Uid": "07cc01ae-1b6b-479b-886a-01fa5e65390c",
"ViewPermission": "bef28b92-8fec-4f7a-ab90-21ce1eca3b3e",
"SavePermission": "c7b08968-0fba-4c70-a93f-2ba2da4bd4ce",
"Type": "DynamicSectionSetup"
},
{
"Headline": "Videos",
"Description": null,
"Properties": [
{
"AttributeUid": "fca6374f-88f9-4e4b-ae1a-4bb38c630176",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "38b8ba84-bd45-4db0-bc4f-7dd78cfe406d",
"ViewPermission": "94788a95-ac5b-4a5b-8915-7f5f96b83531",
"SavePermission": "54bee1a4-8baf-4478-b41e-7463d44d87a3",
"Type": "AttributeSetup"
}
],
"Uid": "e97dcf02-52c8-4af8-ba81-f3d01aee2861",
"ViewPermission": "3d622eaa-19b4-4507-96b4-d5c3bdb7f3b5",
"SavePermission": "07ddfe7b-1c8d-4040-b7a8-a13ccc6e4cdc",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "5e0b9253-cf0d-463c-9350-7592d199d343",
"ViewPermission": "935cdf5e-7615-4695-afaf-71361146b8c6",
"SavePermission": "5cfe651d-c914-4384-b7f7-975bcc75d32e",
"Type": "DynamicTabSetup"
},
{
"Uid": "10005d91-3abd-4017-bee1-44f8253dcd09",
"ViewPermission": "a1fb1162-1f74-4d23-8a29-ff2262f4e9e5",
"SavePermission": "a2f37cb2-9e1a-4b17-8197-485d031a97f8",
"Type": "ClassificationsTabSetup"
},
{
"Uid": "b5aa2e1a-3855-4eb5-8f31-e2288596a6b3",
"ViewPermission": "402e2831-dc40-4b07-bbe6-6c449a47f423",
"SavePermission": "50860d76-5749-435e-a8e0-5a90b8e16c6d",
"Type": "VariantsTabSetup"
}
]
},
"VariantGroupConfiguration": null,
"VariantConfiguration": {
"ThumbnailReference": "Variant_3b1da0c5-a84b-4629-8d3b-d8c0e72fd7dc",
"CreateWizard": {
"Uid": "71248991-793d-4867-9751-7477a41d07f5",
"Steps": [
{
"Properties": [
{
"PropertyUid": "0a3f2132-c0c1-4a24-b1b1-64e74b78c71e",
"Mandatory": true,
"Uid": "04c22871-59f4-4cbe-8adf-871ad78a9e08",
"Type": "AttributeWizardPropertySetup"
}
],
"Uid": "fa5af183-132a-4f1d-997e-bb9ee7bb1a1c",
"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": "6f1715d7-f08c-4aa4-a2c1-798ec6cf2dd5",
"ReadOnly": false,
"Mandatory": true,
"Unchangeable": false,
"Inherits": false,
"Uid": "0a3f2132-c0c1-4a24-b1b1-64e74b78c71e",
"ViewPermission": "2fc2e183-8f15-4f83-8bb3-6234317c9115",
"SavePermission": "3722a198-23e7-40bb-95c2-12477fda9f08",
"Type": "AttributeSetup"
},
{
"AttributeUid": "a9b13e8b-f60a-4ef1-83b7-bcaa27e389b7",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "493a0c3d-1163-4bf6-894f-86481fa3b904",
"ViewPermission": "9565c4f8-711a-438a-a699-9f7b56c63ec4",
"SavePermission": "40532d26-9ca7-4b28-9318-b20c2600ae96",
"Type": "AttributeSetup"
},
{
"AttributeUid": "9dbfd765-1350-4f73-ba27-7a07e2af5771",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": false,
"Uid": "79c0ce14-bce5-469d-ab39-9e67e139c8e4",
"ViewPermission": "608f66a5-cbfc-437b-af80-b9ccb174333f",
"SavePermission": "e6e2c2c9-a2f3-4156-bce8-cf3c9965d583",
"Type": "AttributeSetup"
}
],
"Uid": "5e5a34df-7249-4c46-85fb-5a0e063dff20",
"ViewPermission": "ee417407-c8a8-4abc-b302-7e15c8dbde62",
"SavePermission": "ddb3a4af-028b-4104-b34c-10ed80fb15c6",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "f1839967-1edb-492b-8580-d011132f4fea",
"ViewPermission": "80c253be-2631-4b9a-a621-c5250d9af66b",
"SavePermission": "22094988-fd7d-4d38-93e0-dd7b2f9c1adf",
"Type": "DynamicTabSetup"
},
{
"Label": "Media",
"Sections": [
{
"Headline": "Images",
"Description": "View and override product image if necessary",
"Properties": [
{
"AttributeUid": "3b1da0c5-a84b-4629-8d3b-d8c0e72fd7dc",
"ReadOnly": false,
"Mandatory": false,
"Unchangeable": false,
"Inherits": true,
"Uid": "bfa689f8-ea0f-4799-b761-648b792df889",
"ViewPermission": "69b5547b-5cfe-4dfe-8cd1-184feafa1ee2",
"SavePermission": "8867931a-4e93-4df2-b787-0151781707e1",
"Type": "AttributeSetup"
}
],
"Uid": "58e8d653-9c92-4fbd-965a-63cdf28bc9a5",
"ViewPermission": "132142fd-00e3-429b-ae5d-e590f000c0b6",
"SavePermission": "5c170a61-ecde-4cf1-b312-88cba01901bc",
"Type": "DynamicSectionSetup"
}
],
"ShowSidebar": false,
"Uid": "9611bfaf-7020-4e10-b2fc-43a7fdf04345",
"ViewPermission": "70031daa-eeab-4b98-8c0b-8906e2903788",
"SavePermission": "f7e50535-d451-4830-91cd-e8b9b499ae2d",
"Type": "DynamicTabSetup"
}
]
},
"VariationDefinitions": [
{
"Uid": "5c442117-d933-4e46-8398-3076284b2b82",
"Alias": "ColorVariants",
"Name": "Color variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"6f1715d7-f08c-4aa4-a2c1-798ec6cf2dd5",
"a9b13e8b-f60a-4ef1-83b7-bcaa27e389b7"
]
},
"DefiningAttributes": [
"a9b13e8b-f60a-4ef1-83b7-bcaa27e389b7"
],
"SortOrder": 1
},
{
"Uid": "9b81aa5f-19c4-4148-b694-ab95ec28d486",
"Alias": "SizeVariants",
"Name": "Size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1}",
"NameAttributes": [
"6f1715d7-f08c-4aa4-a2c1-798ec6cf2dd5",
"9dbfd765-1350-4f73-ba27-7a07e2af5771"
]
},
"DefiningAttributes": [
"9dbfd765-1350-4f73-ba27-7a07e2af5771"
],
"SortOrder": 1
},
{
"Uid": "9326ab89-396e-438b-8ec8-c9da997c56af",
"Alias": "ColorAndSizeVariants",
"Name": "Color/size variants",
"NameConfiguration": {
"NamePattern": "{0} - {1} / {2}",
"NameAttributes": [
"6f1715d7-f08c-4aa4-a2c1-798ec6cf2dd5",
"a9b13e8b-f60a-4ef1-83b7-bcaa27e389b7",
"9dbfd765-1350-4f73-ba27-7a07e2af5771"
]
},
"DefiningAttributes": [
"a9b13e8b-f60a-4ef1-83b7-bcaa27e389b7",
"9dbfd765-1350-4f73-ba27-7a07e2af5771"
],
"SortOrder": 3
}
],
"AlwaysOnDefiningAttributes": null,
"ProductIdentifierDefinitions": [
{
"Uid": "2af2a381-3905-4329-a506-3039337b64c6",
"Alias": "ModelNoIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"5e100184-50da-4753-9a7f-dc8522c0aa41"
]
}
],
"VariantGroupIdentifierDefinitions": null,
"VariantIdentifierDefinitions": [
{
"Uid": "89832534-1fc4-4ba1-b96e-ca1cbf53e4e3",
"Alias": "SKUIdentifier",
"IdentifierPattern": "{0}",
"IdentifierAttributes": [
"6f1715d7-f08c-4aa4-a2c1-798ec6cf2dd5"
]
}
]
}#Available from v.3.2.0
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired
Unique id of product structure to delete
Responses
200
OK
No content
delete/v1/productstructures/{uid}
DELETE /v1/productstructures/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200
OK
No content
Last updated