ProductStructures

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 all product structures

get

#Available from v.3.4.0

Authorizations

ApiKey

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

HTTPcURLJavaScriptPython

GET /v1/productstructures HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "89fc9c20-d4cc-4a93-a341-62e92e1cfecd",
    "Alias": "NonFood",
    "Label": "Non-food",
    "HasVariants": true,
    "HasVariantGroups": false,
    "ProductConfiguration": {
      "ThumbnailReference": "Product_1b4f9de5-8798-440d-a057-1c66a6ffe62c",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "91e58f48-7f11-4cca-af30-deada8345416",
          "fdb2808c-2414-48dd-9e90-bf551694c75d"
        ]
      },
      "CreateWizard": {
        "Uid": "2ed7802f-8382-4778-b766-dc9f79de155b",
        "Steps": [
          {
            "Properties": [
              {
                "PropertyUid": "52018216-5795-4e67-867b-1de4d8757e3e",
                "Mandatory": true,
                "Uid": "760f21aa-3da5-4163-ac2e-0206d7934806",
                "Type": "AttributeWizardPropertySetup"
              },
              {
                "PropertyUid": "a5c515d6-f62e-4475-b7d7-0a74de99d6a7",
                "Mandatory": false,
                "Uid": "ed763b03-9f31-4f52-9ba9-c6f9ea6aa9c9",
                "Type": "AttributeWizardPropertySetup"
              }
            ],
            "Uid": "245bb5bf-cfc6-45cb-a7a0-dd24dd00564f",
            "Headline": "Step 1 - basic information",
            "Description": "Add basic information about the product",
            "Type": "DynamicWizardStepSetup"
          },
          {
            "Properties": [
              {
                "PropertyUid": "4318fec0-bb65-4f34-a61b-de1423a8726b",
                "Mandatory": true,
                "Uid": "8092b780-79fc-4b0d-b422-21ca5663712b",
                "Type": "AttributeWizardPropertySetup"
              }
            ],
            "Uid": "62581e18-654c-4ace-bd56-143afba2e129",
            "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": "fdb2808c-2414-48dd-9e90-bf551694c75d",
                  "ReadOnly": false,
                  "Mandatory": true,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "52018216-5795-4e67-867b-1de4d8757e3e",
                  "ViewPermission": "b3dc8f88-d9f4-4f5c-97a8-6b7b542766a7",
                  "SavePermission": "b46068ab-a196-49e3-9860-ba30f1df1765",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "91e58f48-7f11-4cca-af30-deada8345416",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "a5c515d6-f62e-4475-b7d7-0a74de99d6a7",
                  "ViewPermission": "6b75dffa-986a-4805-80a7-b18a577b517a",
                  "SavePermission": "80a0193e-b64c-4b1b-8eeb-bfa541d56312",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "8c31daac-6d21-4fdb-98ba-a6fc152ebbe9",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "156a85b1-9e25-4678-8bae-0fd62ff74f97",
                  "ViewPermission": "8e590eea-ab17-4223-b167-bc6b882f3e15",
                  "SavePermission": "8284585d-3ccd-4870-aa38-9d6355db478c",
                  "Type": "AttributeSetup"
                },
                {
                  "DisplayName": "Variant type",
                  "DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
                  "Uid": "416da2c3-00ec-4d1f-ba79-cb3ed775834a",
                  "ViewPermission": "b533b84a-10fc-4baf-88d1-6da919edcf2d",
                  "SavePermission": "3a31f48e-fb2a-41c3-9849-c0cd8a1e21c2",
                  "Type": "VariationDefinitionSetup"
                }
              ],
              "Uid": "dd50b25d-87c2-4794-a423-1104a62a184e",
              "ViewPermission": "9878f511-f606-468d-be2d-98fcaf651f0d",
              "SavePermission": "7712c7a2-0acc-415c-8692-57902aaba54c",
              "Type": "DynamicSectionSetup"
            },
            {
              "Headline": "Weight & Size information",
              "Description": "",
              "Properties": [
                {
                  "AttributeUid": "774b0c99-e567-45a2-8f59-8fcb269c181f",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "e91c2f40-7540-4778-ad60-db3e8a83cd92",
                  "ViewPermission": "4b5e31a5-2a86-42e4-951a-4b4b22b0d287",
                  "SavePermission": "4e081ae2-0163-4196-a598-18c30fd0f2a9",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "541313bb-6bd0-42de-b03d-313ff9b88b3d",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "e3a8b96f-b5cc-4519-923c-1dfd41e1e3e7",
                  "ViewPermission": "e673c9bc-f86c-4ae8-9071-97bd3d05865c",
                  "SavePermission": "60a40f6d-0353-465a-a3b3-0e9abe90def4",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "396cd06a-313a-4117-8087-0796697d73a1",
              "ViewPermission": "0c9aca88-13dc-44e0-8b8e-84c080154df2",
              "SavePermission": "23cb3947-eb66-482a-a5ad-c7ef6e6fbc7a",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "d60d5d8d-5c42-4805-b48c-118149b3b6d4",
          "ViewPermission": "e53d69de-f0a7-4231-80a7-254da7bbd4ce",
          "SavePermission": "7a1c6212-e06a-4767-887c-d0422868905e",
          "Type": "DynamicTabSetup"
        },
        {
          "Label": "Media",
          "Sections": [
            {
              "Headline": "Images",
              "Description": "Manage primary image and environment images for product",
              "Properties": [
                {
                  "AttributeUid": "1b4f9de5-8798-440d-a057-1c66a6ffe62c",
                  "ReadOnly": false,
                  "Mandatory": true,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "4318fec0-bb65-4f34-a61b-de1423a8726b",
                  "ViewPermission": "0ae6db24-6296-402e-8208-649aa02ee806",
                  "SavePermission": "1e9acf8b-d2bd-4055-85ed-3f3e1ea6b7f3",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "528ec4f2-89bc-41a5-950f-5828603fb2c9",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "afd16fa5-2cd0-4d83-92e5-1641661e4694",
                  "ViewPermission": "88631e6b-be3c-4d74-9563-bed70a2d05f3",
                  "SavePermission": "2aa947d5-e461-43eb-aae9-b94cc0073a0d",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "37e33ff5-9973-40e1-a538-7ebcb53e909b",
              "ViewPermission": "a5b51d07-ef0d-40e4-823f-dfc452088e64",
              "SavePermission": "95b137ee-60d9-4862-b173-1a55674a8f35",
              "Type": "DynamicSectionSetup"
            },
            {
              "Headline": "Videos",
              "Description": null,
              "Properties": [
                {
                  "AttributeUid": "1b4429bd-4208-4d4a-b468-769c5d7f2889",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "b1b631c1-20eb-462a-a599-9f9242ad2cbb",
                  "ViewPermission": "d5b975b4-fe19-49e4-bce8-667dbe8e6c7f",
                  "SavePermission": "7b300d5d-9fd7-42b2-a271-f309925dd915",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "841db898-453d-4fb7-a249-9982549ca688",
              "ViewPermission": "d50f786d-ebd8-4dfe-b985-5ef57f70d3eb",
              "SavePermission": "d4ef6ec6-9e75-4879-9c59-b7d8f53b34c5",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "9ad2d4d7-5b99-4f8d-8583-af915380c60f",
          "ViewPermission": "3c072cc3-b332-438a-a688-90e218c2cb5a",
          "SavePermission": "72222e18-ebd8-46a3-bdea-3b7cd4c7ecab",
          "Type": "DynamicTabSetup"
        },
        {
          "Uid": "9e03a225-7cf7-4339-927a-61e99949e569",
          "ViewPermission": "730dd266-2b4a-4974-b799-38b51a874a92",
          "SavePermission": "f827c775-3840-440c-bf0a-78ee72f3c678",
          "Type": "ClassificationsTabSetup"
        },
        {
          "Uid": "471ab3d8-6327-4114-b198-d9ee347c63ff",
          "ViewPermission": "32e736a3-4967-4f5b-b71e-84790f5e492e",
          "SavePermission": "034f6f50-6f15-4744-b2b1-fefaa867a81f",
          "Type": "VariantsTabSetup"
        }
      ]
    },
    "VariantGroupConfiguration": null,
    "VariantConfiguration": {
      "ThumbnailReference": "Variant_1b4f9de5-8798-440d-a057-1c66a6ffe62c",
      "CreateWizard": {
        "Uid": "ded5da1f-a884-463e-949f-84298d2ac6ca",
        "Steps": [
          {
            "Properties": [
              {
                "PropertyUid": "6c569bee-b6e7-44e5-92cc-f5f628af1a09",
                "Mandatory": true,
                "Uid": "4241d25c-cc38-40ea-9b01-5011c8d7ee98",
                "Type": "AttributeWizardPropertySetup"
              }
            ],
            "Uid": "a8cd7bec-586d-4a0c-a79d-3f6d9da43aad",
            "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": "0ebc7f2e-9e70-4699-8941-10f70d9f3052",
                  "ReadOnly": false,
                  "Mandatory": true,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "6c569bee-b6e7-44e5-92cc-f5f628af1a09",
                  "ViewPermission": "fbd3a88d-ab75-40fc-b8b9-fdcb5f8ce86a",
                  "SavePermission": "ca0d70e3-5365-4d3e-97e4-12272a63c14e",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "4b3bd88c-3b5e-4270-929e-6f97be3598b1",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "b3b36882-03a9-4837-b77a-04acc7785cff",
                  "ViewPermission": "8791e6d0-f88d-419f-9e69-d5e6cf75ad26",
                  "SavePermission": "385deffd-2917-414f-9c7f-6f41c62f821a",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "199604b6-c9b4-486d-ba96-5186e9e2299c",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "1b670b59-ffb2-42c5-b236-0f8cc167b436",
                  "ViewPermission": "2f2a069f-ae59-4e96-b07b-76e89efdd5fb",
                  "SavePermission": "0d20cefa-bdf9-41a5-b1d8-0a33204efe48",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "e069f812-a77b-4e4e-b383-dbf23ab7eec5",
              "ViewPermission": "3d71cd85-9f06-49e6-8291-56f35a9ef69f",
              "SavePermission": "11cea26f-d2d9-412e-95e4-9c5f20419af8",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "4c2eda79-ebdf-42bb-bfcd-8e5c5c03635b",
          "ViewPermission": "c63214e4-481b-404f-8388-a5ea6fe1369c",
          "SavePermission": "d6130b71-389e-4cc3-9b0b-70b16b754266",
          "Type": "DynamicTabSetup"
        },
        {
          "Label": "Media",
          "Sections": [
            {
              "Headline": "Images",
              "Description": "View and override product image if necessary",
              "Properties": [
                {
                  "AttributeUid": "1b4f9de5-8798-440d-a057-1c66a6ffe62c",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": true,
                  "Uid": "5d0c505e-2e61-4c00-ba0c-92bc4a2fb519",
                  "ViewPermission": "bc931990-3d83-4c0c-9aa2-5cb91c7ebca3",
                  "SavePermission": "0489c34d-3836-495e-8e72-a007625029d3",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "9e1023e0-1e97-4671-982b-33a03814d055",
              "ViewPermission": "ac218896-ccb3-4e4a-8948-3ad6065035dc",
              "SavePermission": "d1391c4a-9fdd-458c-88b4-ec2712fb41f9",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "3159d4d7-18d0-4db3-92bd-98ba675bf412",
          "ViewPermission": "f073af81-b373-4601-887d-a0d551af1621",
          "SavePermission": "d5f6f0ed-f8d2-4264-b37f-ce326a04c1a1",
          "Type": "DynamicTabSetup"
        }
      ]
    },
    "VariationDefinitions": [
      {
        "Uid": "1225afb0-3b7f-48a8-9424-55682174a043",
        "Alias": "ColorVariants",
        "Name": "Color variants",
        "NameConfiguration": {
          "NamePattern": "{0} - {1}",
          "NameAttributes": [
            "0ebc7f2e-9e70-4699-8941-10f70d9f3052",
            "4b3bd88c-3b5e-4270-929e-6f97be3598b1"
          ]
        },
        "DefiningAttributes": [
          "4b3bd88c-3b5e-4270-929e-6f97be3598b1"
        ],
        "SortOrder": 1
      },
      {
        "Uid": "fac2d6ec-a28f-467e-b610-a6b9c5435182",
        "Alias": "SizeVariants",
        "Name": "Size variants",
        "NameConfiguration": {
          "NamePattern": "{0} - {1}",
          "NameAttributes": [
            "0ebc7f2e-9e70-4699-8941-10f70d9f3052",
            "199604b6-c9b4-486d-ba96-5186e9e2299c"
          ]
        },
        "DefiningAttributes": [
          "199604b6-c9b4-486d-ba96-5186e9e2299c"
        ],
        "SortOrder": 1
      },
      {
        "Uid": "888c1d4a-2941-4166-a342-d016970685ba",
        "Alias": "ColorAndSizeVariants",
        "Name": "Color/size variants",
        "NameConfiguration": {
          "NamePattern": "{0} - {1} / {2}",
          "NameAttributes": [
            "0ebc7f2e-9e70-4699-8941-10f70d9f3052",
            "4b3bd88c-3b5e-4270-929e-6f97be3598b1",
            "199604b6-c9b4-486d-ba96-5186e9e2299c"
          ]
        },
        "DefiningAttributes": [
          "4b3bd88c-3b5e-4270-929e-6f97be3598b1",
          "199604b6-c9b4-486d-ba96-5186e9e2299c"
        ],
        "SortOrder": 3
      }
    ],
    "AlwaysOnDefiningAttributes": null,
    "ProductIdentifierDefinitions": [
      {
        "Uid": "11015f0b-5683-4f4f-b8c9-2c813212f45e",
        "Alias": "ModelNoIdentifier",
        "IdentifierPattern": "{0}",
        "IdentifierAttributes": [
          "91e58f48-7f11-4cca-af30-deada8345416"
        ]
      }
    ],
    "VariantGroupIdentifierDefinitions": null,
    "VariantIdentifierDefinitions": [
      {
        "Uid": "31af7c44-9ad6-4936-a05d-3073b1eb53ca",
        "Alias": "SKUIdentifier",
        "IdentifierPattern": "{0}",
        "IdentifierAttributes": [
          "0ebc7f2e-9e70-4699-8941-10f70d9f3052"
        ]
      }
    ]
  }
]

Create new product structure

post

#Available from v.3.2.0

Authorizations

ApiKey

AuthorizationstringRequired

Body

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

Responses

200

OK

No content

400

Bad Request

application/json

post

/v1/productstructures

HTTPcURLJavaScriptPython

POST /v1/productstructures HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10362

{
  "Uid": "0e0a8cf2-845d-485d-9eb2-adcf2f7a4c5e",
  "Alias": "NonFood",
  "Label": "Non-food",
  "HasVariants": true,
  "HasVariantGroups": false,
  "ProductConfiguration": {
    "ThumbnailReference": "Product_0f4e8673-c64f-40d2-b476-6a0e82c96f95",
    "NameConfiguration": {
      "NamePattern": "{0} - {1}",
      "NameAttributes": [
        "6671bc33-d1ff-4f3e-8a55-314ad0325352",
        "8d6d9239-ba20-4eb9-81f1-ba71b5a92f33"
      ]
    },
    "CreateWizard": {
      "Uid": "382b35ee-d9c0-4acb-a61a-64c171d4afb6",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "ca3209ee-8a3b-4bdf-9f77-a20970e47dde",
              "Mandatory": true,
              "Uid": "2440487c-7151-473e-8d92-c27096c6975f",
              "Type": "AttributeWizardPropertySetup"
            },
            {
              "PropertyUid": "58e174d1-24c7-4359-b433-cc0ca5d54b16",
              "Mandatory": false,
              "Uid": "26b95b11-7dce-4911-9e54-8b06da703c56",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "c87196ae-b9dd-4e86-a776-2068d826c817",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the product",
          "Type": "DynamicWizardStepSetup"
        },
        {
          "Properties": [
            {
              "PropertyUid": "cae29af7-0a41-4842-bab3-22d148a657ae",
              "Mandatory": true,
              "Uid": "732fdd64-c34e-4ab4-85e1-cd6e52c0e291",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "ed365b01-fec8-4574-8857-88fb7bef75b0",
          "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": "8d6d9239-ba20-4eb9-81f1-ba71b5a92f33",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "ca3209ee-8a3b-4bdf-9f77-a20970e47dde",
                "ViewPermission": "1f0d6da9-4ff5-4676-bc51-6bbf54a0d0a3",
                "SavePermission": "7aed9003-94c0-4039-a2a2-0046ab79c283",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "6671bc33-d1ff-4f3e-8a55-314ad0325352",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "58e174d1-24c7-4359-b433-cc0ca5d54b16",
                "ViewPermission": "f06c5262-d70f-429b-893b-c6bb7bdca0b0",
                "SavePermission": "dc89f345-e7d1-4f3c-92cf-76ba9c73181d",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "2f434556-78be-477e-90b3-15bffc97d164",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "e3026dd6-4e50-41a5-b250-fab9da4b54d3",
                "ViewPermission": "1c3dbc77-b652-4af0-aa76-42d22c1870b5",
                "SavePermission": "9bf16269-011b-4d6d-b649-a31dd5185555",
                "Type": "AttributeSetup"
              },
              {
                "DisplayName": "Variant type",
                "DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
                "Uid": "2e90a704-7659-4ecc-a665-2a29d58d695a",
                "ViewPermission": "81ac2384-3686-4fa5-b08c-7fca03a9bf25",
                "SavePermission": "f6dbbda2-b946-4b6d-ba41-28374774cf47",
                "Type": "VariationDefinitionSetup"
              }
            ],
            "Uid": "4a78d030-fca4-4f91-9d46-e0fb825549af",
            "ViewPermission": "1a969e83-d57a-4150-ae8e-debc57c7db2f",
            "SavePermission": "0b4a0452-498b-4b59-8b0d-add08f1449fb",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Weight & Size information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "6e358e40-91c0-436f-8f9e-a8bf7433c44f",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "3aac001b-c8be-4cea-9dcb-65bc78530e46",
                "ViewPermission": "b33f1123-218d-45b4-8583-8cac078f6fb9",
                "SavePermission": "f35cffa0-65ec-4bf4-b878-45ae445e9031",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "fc17ebc0-e389-42a0-ad20-0d35ef233a4d",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "81019ea8-ad31-4afb-ada0-05267643f090",
                "ViewPermission": "2b69dcde-d743-484b-8537-a23ae5713f5e",
                "SavePermission": "80b1dd6e-f854-4705-b2e3-a3735c29b794",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "92b00f7c-6210-41b3-925d-e3af4fe0fb00",
            "ViewPermission": "036c3f53-ead0-49b4-8558-71af7313711d",
            "SavePermission": "9980e5dd-ed9b-4641-ad10-f9430cc7fb64",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "a1c5446d-82d4-4efd-a3d1-2b8a7915cb44",
        "ViewPermission": "3bf991f8-9822-4c28-8f71-2eb57170150f",
        "SavePermission": "aa8b4119-3e16-4462-9a98-9b1ad2d23f65",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "Manage primary image and environment images for product",
            "Properties": [
              {
                "AttributeUid": "0f4e8673-c64f-40d2-b476-6a0e82c96f95",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "cae29af7-0a41-4842-bab3-22d148a657ae",
                "ViewPermission": "e283efa7-7f65-466d-a858-09d1df40096e",
                "SavePermission": "a67f92b4-1fb9-4ad7-8a9e-0583a79f93f0",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "48f9ccde-d32e-4185-a55d-6b6db5a1a451",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "51bf03b4-2935-4afc-a656-f2780523394f",
                "ViewPermission": "4ed3da53-898a-4169-b3bc-25ac6c2d2e3a",
                "SavePermission": "d18ce7be-b390-4064-b0c7-0dd8bfb886ff",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "83c5afe1-432d-4a00-86c8-7927a5a48a8f",
            "ViewPermission": "88b6be26-dfc2-4c7f-b19e-3bea5f0c9ab9",
            "SavePermission": "bbbb2527-4792-41d8-bbd2-6ea6d65128e5",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Videos",
            "Description": null,
            "Properties": [
              {
                "AttributeUid": "b0c28f0c-18f4-4134-ab41-70ad3d07e163",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "99523794-e0a9-4a83-a9fd-2f5871f5d3b4",
                "ViewPermission": "137c8944-3510-441d-963a-889d7c1e5e1f",
                "SavePermission": "14389b1e-47e9-4516-8ead-85e6cceb8515",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "2d5ca369-121b-4285-9b16-40517dad1c10",
            "ViewPermission": "53b00271-6bf1-4ac2-9b37-ab9c0db02c06",
            "SavePermission": "b91e720b-e8be-49de-b4f9-0f9b92c1cf8f",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "0c14f0f9-b842-4942-bb7c-375dec44f902",
        "ViewPermission": "32ed12b9-9fb1-4a36-974d-c07ef8d33f31",
        "SavePermission": "46ceaac3-0f35-46b5-814e-15be0776a525",
        "Type": "DynamicTabSetup"
      },
      {
        "Uid": "e313f148-fb2d-431a-9940-85c5aaf45720",
        "ViewPermission": "51c51e5c-a9cf-47f3-9bfe-26e63fd0cde7",
        "SavePermission": "3e4ce4e1-c2e0-4e09-9f6d-d339c3ae1137",
        "Type": "ClassificationsTabSetup"
      },
      {
        "Uid": "23835cad-fb1a-4e40-adbd-99baa7793720",
        "ViewPermission": "482f3f62-a69e-41c8-a396-8e79b362d86a",
        "SavePermission": "1512d9f0-41f0-4d0f-a49c-b62770ef4ab6",
        "Type": "VariantsTabSetup"
      }
    ]
  },
  "VariantGroupConfiguration": null,
  "VariantConfiguration": {
    "ThumbnailReference": "Variant_0f4e8673-c64f-40d2-b476-6a0e82c96f95",
    "CreateWizard": {
      "Uid": "3a6196f5-251e-4e05-82a3-36893be3920f",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "1841401d-67af-446e-8579-33e97881adc5",
              "Mandatory": true,
              "Uid": "d3017284-fad3-46e8-a5d7-a279899edad9",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "ae3d168c-e277-45c1-bcd5-294cdeb9fa8f",
          "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": "c2e94718-ed9a-4149-a979-686185dc9851",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "1841401d-67af-446e-8579-33e97881adc5",
                "ViewPermission": "a5d976c1-73ac-4d09-ac60-9ace77f22bdd",
                "SavePermission": "11944664-92fc-4919-8080-ce555ad6f6e1",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "d7443abb-edbd-42b7-acd8-9a7762075633",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "8f640807-124a-4819-852f-9ba9f4ac2c0e",
                "ViewPermission": "de8d49f0-7eab-4bdd-b95c-f454abb37f22",
                "SavePermission": "ef10e1e1-9635-4f4a-a535-005ef8011d53",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "f2c27658-c389-45b1-8302-cdb4af8294cf",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "542790fc-ef83-45f8-8673-f643e22d2197",
                "ViewPermission": "52cebf8d-d15f-4a42-b1e0-db6c8ee6e963",
                "SavePermission": "ed3ab228-478b-4a67-9f62-b6f1a280c753",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "5d0d8ef9-f863-4510-a612-6843ace22c78",
            "ViewPermission": "15e93cbc-8b15-4825-ad87-c8236ec06b0b",
            "SavePermission": "ced89e19-31fb-4e5f-ba40-8fe0ede855ce",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "0e41ecf6-0cc0-4f62-bda5-d7b65946ccd2",
        "ViewPermission": "552368a8-8399-41aa-a160-23f7c043ea56",
        "SavePermission": "17b89369-ca75-4e66-8919-9da45ffdd352",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "View and override product image if necessary",
            "Properties": [
              {
                "AttributeUid": "0f4e8673-c64f-40d2-b476-6a0e82c96f95",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": true,
                "Uid": "0a4b3b2c-ef61-4336-8198-feded817a8ff",
                "ViewPermission": "d195b830-a010-4639-9375-824b4b04712a",
                "SavePermission": "0a9dfbfb-a4e9-450d-9116-97fca7ba1e0a",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "fcf33b69-4964-4f8b-8060-c5017670c357",
            "ViewPermission": "f289661f-7c50-4053-986f-5b766cf443d2",
            "SavePermission": "296ff9da-a36a-468d-9d37-c2bb5802824b",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "b9f768ef-4ace-4412-aa22-1a3e2392b23e",
        "ViewPermission": "c61ff4ea-8c3b-4978-9b58-d678cd83c4ef",
        "SavePermission": "5217654f-3c3d-46a6-877f-29507cdb35c9",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "e2b19512-81c0-4ce8-8d6a-404cfb5b5759",
      "Alias": "ColorVariants",
      "Name": "Color variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "c2e94718-ed9a-4149-a979-686185dc9851",
          "d7443abb-edbd-42b7-acd8-9a7762075633"
        ]
      },
      "DefiningAttributes": [
        "d7443abb-edbd-42b7-acd8-9a7762075633"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "5589f784-67f0-4856-8460-e9151d3df02a",
      "Alias": "SizeVariants",
      "Name": "Size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "c2e94718-ed9a-4149-a979-686185dc9851",
          "f2c27658-c389-45b1-8302-cdb4af8294cf"
        ]
      },
      "DefiningAttributes": [
        "f2c27658-c389-45b1-8302-cdb4af8294cf"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "b56da3b3-74da-4c2b-af41-f2c862dec26c",
      "Alias": "ColorAndSizeVariants",
      "Name": "Color/size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1} / {2}",
        "NameAttributes": [
          "c2e94718-ed9a-4149-a979-686185dc9851",
          "d7443abb-edbd-42b7-acd8-9a7762075633",
          "f2c27658-c389-45b1-8302-cdb4af8294cf"
        ]
      },
      "DefiningAttributes": [
        "d7443abb-edbd-42b7-acd8-9a7762075633",
        "f2c27658-c389-45b1-8302-cdb4af8294cf"
      ],
      "SortOrder": 3
    }
  ],
  "AlwaysOnDefiningAttributes": null,
  "ProductIdentifierDefinitions": [
    {
      "Uid": "0d257c9e-37e2-41a8-bebc-6b55fb887a58",
      "Alias": "ModelNoIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "6671bc33-d1ff-4f3e-8a55-314ad0325352"
      ]
    }
  ],
  "VariantGroupIdentifierDefinitions": null,
  "VariantIdentifierDefinitions": [
    {
      "Uid": "1908dec4-d197-445d-abd5-c63f8c6f213a",
      "Alias": "SKUIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "c2e94718-ed9a-4149-a979-686185dc9851"
      ]
    }
  ]
}

No content

Update a product structure

put

#Available from v.3.2.0

Authorizations

ApiKey

AuthorizationstringRequired

Body

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

Responses

200

OK

No content

400

Bad Request

application/json

put

/v1/productstructures

HTTPcURLJavaScriptPython

PUT /v1/productstructures HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10362

{
  "Uid": "5c487f3f-0a52-40dc-8ad4-148ebbc03d3b",
  "Alias": "NonFood",
  "Label": "Non-food",
  "HasVariants": true,
  "HasVariantGroups": false,
  "ProductConfiguration": {
    "ThumbnailReference": "Product_8e1755b9-4f38-4b9d-b44e-6e43baf059be",
    "NameConfiguration": {
      "NamePattern": "{0} - {1}",
      "NameAttributes": [
        "84c4b874-8636-4ad5-8185-3780d63c3781",
        "734ddef9-b6f9-4c7c-afac-921754805d4f"
      ]
    },
    "CreateWizard": {
      "Uid": "288a51c3-2856-494b-813c-044603385a34",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "dc16db9d-2fc5-4da7-a597-b33eda7242fa",
              "Mandatory": true,
              "Uid": "cf5d8c8f-cb3c-4c61-9379-d962cc6247fb",
              "Type": "AttributeWizardPropertySetup"
            },
            {
              "PropertyUid": "96a28072-3522-4997-b928-14a8d7de42ee",
              "Mandatory": false,
              "Uid": "7cd12288-7e02-4264-80f7-7e8223420071",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "ce0a9169-8d1a-4061-aa7b-36c6529c57a5",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the product",
          "Type": "DynamicWizardStepSetup"
        },
        {
          "Properties": [
            {
              "PropertyUid": "8b98d2d4-c94b-4d2f-89f9-e4d0007e0546",
              "Mandatory": true,
              "Uid": "ad933347-ebdb-46cf-b811-5de4df333e73",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "e9825ede-c919-4319-821f-4f388f4b23a5",
          "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": "734ddef9-b6f9-4c7c-afac-921754805d4f",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "dc16db9d-2fc5-4da7-a597-b33eda7242fa",
                "ViewPermission": "d4a519db-479f-4d97-a297-149985d546a7",
                "SavePermission": "09bd32b7-3015-48b3-a510-531a6210ef58",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "84c4b874-8636-4ad5-8185-3780d63c3781",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "96a28072-3522-4997-b928-14a8d7de42ee",
                "ViewPermission": "9230112d-26d6-409c-b195-0825906d3a3f",
                "SavePermission": "33e41082-19fe-4063-9ba7-1d065ce5d6a5",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "66103f6b-2b92-4cdc-8820-9553d3526e09",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "017eb7bf-b5d9-49be-a34a-9cb1046431c9",
                "ViewPermission": "1be18c59-b969-4889-afc2-040c4165cd70",
                "SavePermission": "520d71d2-a7fa-4f27-b740-5387749ed675",
                "Type": "AttributeSetup"
              },
              {
                "DisplayName": "Variant type",
                "DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
                "Uid": "983c90d0-d871-402e-aaed-372cabf910bc",
                "ViewPermission": "0a70748c-64e1-4b2c-b677-d01341bdc7ff",
                "SavePermission": "e9116395-41a9-4efa-9d88-c02c115ba24e",
                "Type": "VariationDefinitionSetup"
              }
            ],
            "Uid": "fb0332db-463f-4df7-9a96-e114da29c6b8",
            "ViewPermission": "5c6a9864-43e0-4a50-b8e8-be3cbb8a44ba",
            "SavePermission": "8788781c-cebb-4afa-bed4-27f52d6f0b4e",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Weight & Size information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "72cff808-00bb-4c9a-87c4-56d9a68a122a",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "9b592c86-e997-4bb2-bfca-7c5429dbf211",
                "ViewPermission": "08af7c42-b586-419b-be3a-890de8107c69",
                "SavePermission": "c53aa3f8-c335-4363-9a47-08fff87b6b0b",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "ee6ca3ba-65d8-4962-967e-1212f714a746",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "c7f04184-fbc1-4b27-ae06-d772a03fa7bd",
                "ViewPermission": "b1ded73b-4b28-4dc1-899f-e21603ea3dd7",
                "SavePermission": "56c978b3-ca10-442a-b50a-ea1e85904478",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "3a6421e8-0dd3-4638-a642-ec8094b9cea8",
            "ViewPermission": "42086185-b9d8-4d71-8861-5ef1b49cc476",
            "SavePermission": "05a71a2b-c9cb-4442-bcb1-374e7c455e98",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "9c78e0cd-61d5-4bc7-acbc-142e7468b36f",
        "ViewPermission": "d55ea15a-9f9a-45e2-acca-c9be819ee785",
        "SavePermission": "eaf26008-7305-4a72-9380-6a812262855a",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "Manage primary image and environment images for product",
            "Properties": [
              {
                "AttributeUid": "8e1755b9-4f38-4b9d-b44e-6e43baf059be",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "8b98d2d4-c94b-4d2f-89f9-e4d0007e0546",
                "ViewPermission": "ff6da20c-050d-4c6c-83af-b794633e5f16",
                "SavePermission": "f1bbce90-3586-433c-8cc5-260334a64733",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "b13d625f-5c2e-4d71-a781-c0ec9c6a739e",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "a138c67e-3214-4057-8808-d5506fb9548a",
                "ViewPermission": "195be6a3-18b1-49a7-af8d-34459b4899f4",
                "SavePermission": "e7e3a98f-e938-4161-bbe5-b40fd659876e",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "7f1d20fc-b8f8-46f7-bc53-4b3459deb1a1",
            "ViewPermission": "4d795f01-2716-4204-b1c5-0e0f20ca1a86",
            "SavePermission": "a55b645b-e603-4c7a-ae1d-dfdb9daa743e",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Videos",
            "Description": null,
            "Properties": [
              {
                "AttributeUid": "52571036-5df0-477a-832e-a30f9e8a9927",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "df0606b6-729b-4c10-83a6-888a3464091e",
                "ViewPermission": "297af63e-6c4d-4b4f-a718-14c63ee4a6fb",
                "SavePermission": "99791e53-2986-4698-a4f2-a68245f89301",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "56cf6c65-c439-461b-9661-d183e0b8d3a5",
            "ViewPermission": "40cf7d9f-3371-4592-bca3-40ec4688c1fb",
            "SavePermission": "97b0678f-4ed1-47f6-80cb-9bef449a0b98",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "1efdf03c-ec96-4a40-8ab7-94dea523c07c",
        "ViewPermission": "74c86f0c-4572-4739-8bf8-2400fa380822",
        "SavePermission": "a81e6d38-f234-408d-ad07-fbfb4d01c8bb",
        "Type": "DynamicTabSetup"
      },
      {
        "Uid": "abb1009f-70aa-4248-af8d-921bbd0a5304",
        "ViewPermission": "3953fe50-d7f2-4cd8-b4fa-5e88ea60b0d6",
        "SavePermission": "780df948-3ce5-4034-a875-c6927229dc56",
        "Type": "ClassificationsTabSetup"
      },
      {
        "Uid": "424f3c54-3b80-470b-b9a7-5bfce4586647",
        "ViewPermission": "2f1e6632-721d-461d-8af6-037032c2db8d",
        "SavePermission": "e25e1960-8a70-463f-bb3b-37edc30af632",
        "Type": "VariantsTabSetup"
      }
    ]
  },
  "VariantGroupConfiguration": null,
  "VariantConfiguration": {
    "ThumbnailReference": "Variant_8e1755b9-4f38-4b9d-b44e-6e43baf059be",
    "CreateWizard": {
      "Uid": "32bc6f6e-dc8e-43cf-8ae7-6535e0ddf47d",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "26546c87-1428-49a4-9d29-b897caf2d7f9",
              "Mandatory": true,
              "Uid": "9ccd5158-c0ac-4ab0-98d4-00ebcd1a2f2b",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "4cf62e3c-9c9f-41bd-9d2d-c4b1da3b6f50",
          "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": "33b0228c-02bd-40c8-9cc9-514fafec01da",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "26546c87-1428-49a4-9d29-b897caf2d7f9",
                "ViewPermission": "689edb62-7e0e-4800-a976-7450bd23dcbc",
                "SavePermission": "7a1e54d8-64fc-42cd-aa72-8403db1f090e",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "2e2a140e-ca08-4261-93bc-5d7ac7279d8c",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "bfe74592-39fd-4dae-b3da-a09f5a1a72b8",
                "ViewPermission": "43fa85ac-9cf7-43c5-b974-b212758ee9d4",
                "SavePermission": "2f232ba6-76aa-42ef-a00c-a1e59cabcaa7",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "59d6fde6-ed92-453a-b426-d2fe04e5f1d1",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "8ffde479-9736-4726-a9d5-8dec393ce03a",
                "ViewPermission": "403b30e0-9a19-49cb-9ba7-0f8c8bbe2af7",
                "SavePermission": "af9178f3-7248-46dc-95c5-ed5ac179cd9d",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "6f556e95-3f84-4856-8dc6-909bd054bdec",
            "ViewPermission": "e2f866aa-eb86-4cfc-b4f1-9a9468c02c5b",
            "SavePermission": "d28d6e5d-27af-454d-8e2c-7c2ce6ba1aff",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "bfcdb894-3e83-4ccd-96ba-2138eeb65dbb",
        "ViewPermission": "06a6f331-cb54-44e8-bf03-46ed1de044ae",
        "SavePermission": "5aa51dcf-8bb4-4210-af57-965b207471af",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "View and override product image if necessary",
            "Properties": [
              {
                "AttributeUid": "8e1755b9-4f38-4b9d-b44e-6e43baf059be",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": true,
                "Uid": "445d7ae8-6e21-4c89-87b2-840aa8872393",
                "ViewPermission": "7603324b-c4f4-414b-b404-8682d55f1d5a",
                "SavePermission": "b1dc1632-385c-4df5-af7c-3089e8737486",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "1ee768db-8884-4c47-a314-bdd03c9d9674",
            "ViewPermission": "b3561800-486f-4a8d-9bb2-5a42977f4a6b",
            "SavePermission": "3fd0f92f-42af-451c-ab23-090946f594a5",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "5a110241-c7ca-4a0b-bd0d-034d889b8bb9",
        "ViewPermission": "ebdca57a-0687-41c1-baec-008f062c7125",
        "SavePermission": "17bdeaab-4ddb-49e6-afd5-ada3d26ff571",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "238b9c48-46d0-468c-ab09-6b9541804060",
      "Alias": "ColorVariants",
      "Name": "Color variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "33b0228c-02bd-40c8-9cc9-514fafec01da",
          "2e2a140e-ca08-4261-93bc-5d7ac7279d8c"
        ]
      },
      "DefiningAttributes": [
        "2e2a140e-ca08-4261-93bc-5d7ac7279d8c"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "251b8b3b-3bc7-4a18-9569-152f0cfda9aa",
      "Alias": "SizeVariants",
      "Name": "Size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "33b0228c-02bd-40c8-9cc9-514fafec01da",
          "59d6fde6-ed92-453a-b426-d2fe04e5f1d1"
        ]
      },
      "DefiningAttributes": [
        "59d6fde6-ed92-453a-b426-d2fe04e5f1d1"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "552a7a71-c0af-44d6-80bd-1a53b476dcf6",
      "Alias": "ColorAndSizeVariants",
      "Name": "Color/size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1} / {2}",
        "NameAttributes": [
          "33b0228c-02bd-40c8-9cc9-514fafec01da",
          "2e2a140e-ca08-4261-93bc-5d7ac7279d8c",
          "59d6fde6-ed92-453a-b426-d2fe04e5f1d1"
        ]
      },
      "DefiningAttributes": [
        "2e2a140e-ca08-4261-93bc-5d7ac7279d8c",
        "59d6fde6-ed92-453a-b426-d2fe04e5f1d1"
      ],
      "SortOrder": 3
    }
  ],
  "AlwaysOnDefiningAttributes": null,
  "ProductIdentifierDefinitions": [
    {
      "Uid": "d5e8598c-ef36-4c40-8d0c-9ffe5b079b32",
      "Alias": "ModelNoIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "84c4b874-8636-4ad5-8185-3780d63c3781"
      ]
    }
  ],
  "VariantGroupIdentifierDefinitions": null,
  "VariantIdentifierDefinitions": [
    {
      "Uid": "e5e0b882-7f2f-4690-828a-d9e4c7cf6fa2",
      "Alias": "SKUIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "33b0228c-02bd-40c8-9cc9-514fafec01da"
      ]
    }
  ]
}

No content

Get a product structure

get

#Available from v.3.2.0

Authorizations

ApiKey

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}

HTTPcURLJavaScriptPython

GET /v1/productstructures/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "ae62d89f-757c-4aad-ab6d-d84fbf6f1d22",
  "Alias": "NonFood",
  "Label": "Non-food",
  "HasVariants": true,
  "HasVariantGroups": false,
  "ProductConfiguration": {
    "ThumbnailReference": "Product_c9457028-9bbc-4b8f-b4ec-1047261f7876",
    "NameConfiguration": {
      "NamePattern": "{0} - {1}",
      "NameAttributes": [
        "763e096f-f02a-418c-a5d9-bac1d10bc8dd",
        "c0a35119-0080-44ff-8c7d-c9fed3635c69"
      ]
    },
    "CreateWizard": {
      "Uid": "2eb76a5c-d5eb-4355-aecc-6a5fbb8d7406",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "94f686b0-6cdb-4d99-9940-ea03e4b59616",
              "Mandatory": true,
              "Uid": "7e6f0c32-6947-4d4b-9452-760631689dc6",
              "Type": "AttributeWizardPropertySetup"
            },
            {
              "PropertyUid": "fcc18691-b691-402b-a93a-5fa71207a90f",
              "Mandatory": false,
              "Uid": "321c5dab-3d33-427d-95b9-95141e8b1c30",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "1b31e698-339e-4989-9b60-b0e7a14faebc",
          "Headline": "Step 1 - basic information",
          "Description": "Add basic information about the product",
          "Type": "DynamicWizardStepSetup"
        },
        {
          "Properties": [
            {
              "PropertyUid": "ea18105f-03ff-4032-8bc0-2931b87bbc3a",
              "Mandatory": true,
              "Uid": "33797bf6-cb80-4d58-9112-a1c953a9a18c",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "15a65b05-4fa7-4d3f-92f9-6614759a2c01",
          "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": "c0a35119-0080-44ff-8c7d-c9fed3635c69",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "94f686b0-6cdb-4d99-9940-ea03e4b59616",
                "ViewPermission": "0b0cc2f8-30fd-4439-bcec-8d7919320d22",
                "SavePermission": "d6b3b5de-b7ff-4976-91c2-5aba7bb0c6b2",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "763e096f-f02a-418c-a5d9-bac1d10bc8dd",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "fcc18691-b691-402b-a93a-5fa71207a90f",
                "ViewPermission": "a5bdcb65-194f-4078-98ad-26c15039f6dc",
                "SavePermission": "416ef18f-b2cd-4f78-aaea-eee3d8dbbffc",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "403b911b-2952-413d-a5fb-82b9c1a27d38",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "d80f887e-8da9-400a-aad3-3179f46d6007",
                "ViewPermission": "51800fd5-3a61-4920-ab15-a00125610cf4",
                "SavePermission": "4a3042c3-f450-4cb1-82f1-7be6f3459176",
                "Type": "AttributeSetup"
              },
              {
                "DisplayName": "Variant type",
                "DisplayDescription": "Select what the variants vary by - eg. color, color & size etc.",
                "Uid": "5e88f278-2620-4bda-bf40-9ea8d8fec6a9",
                "ViewPermission": "a96eb841-7cc4-4e0c-b326-e98f9430c5c2",
                "SavePermission": "1fd32a02-792b-4d02-87da-44d1d950f760",
                "Type": "VariationDefinitionSetup"
              }
            ],
            "Uid": "e9d8be56-85bc-42d9-a7d1-7f69e469343f",
            "ViewPermission": "dce39712-165b-4bc4-b750-9b49111e657d",
            "SavePermission": "c1414ea7-fb0b-472a-819d-6595b9630c32",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Weight & Size information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "9a54cc95-8d97-4885-8015-c003777194fc",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "e3ac4d9a-60bf-427f-b290-e15dc20eab85",
                "ViewPermission": "4dbf7dce-2589-4d3d-bb51-45815af1eaec",
                "SavePermission": "612c34c5-a20c-4dbd-b3aa-11135ce536e8",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "65f56726-1836-4c01-acb2-9b3990d1c70a",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "1bbeadc3-6696-4dee-bdb4-3e5591d4dd10",
                "ViewPermission": "dd32b582-4455-49f5-96be-0bb94c059323",
                "SavePermission": "d0fd5d5c-b5e4-499b-86e7-3fbbd9bdccc7",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "0da5114b-f3b9-437e-8aef-d619a1c7762f",
            "ViewPermission": "3e44cd69-6d1e-4ae3-b0ae-ef38d64cf65e",
            "SavePermission": "16074750-24e6-4c11-9836-56eec8ff49ea",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "af382863-fe22-4de8-b367-135bf48c4b9b",
        "ViewPermission": "c4b4e81a-c031-47ce-a1ba-4d3ece509220",
        "SavePermission": "7e6611fb-9efc-4b3a-a9a2-6d6b69c2bfed",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "Manage primary image and environment images for product",
            "Properties": [
              {
                "AttributeUid": "c9457028-9bbc-4b8f-b4ec-1047261f7876",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "ea18105f-03ff-4032-8bc0-2931b87bbc3a",
                "ViewPermission": "c9561f63-34cc-4895-829d-3c2d866a43a7",
                "SavePermission": "cf067351-c85c-47d2-802f-ffed27815fd1",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "f95f586c-4928-485e-905e-79bca3470fd1",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "febd3085-40ca-4e04-a4b7-fda01a070f39",
                "ViewPermission": "44a13457-79c8-47f9-af1b-a2276ddb41db",
                "SavePermission": "38b2ed4f-85bd-49b1-bfd4-b6b536b762d3",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "fe5d9be2-7cf3-42c9-93a4-3e87e005cadb",
            "ViewPermission": "2936e20f-7382-444d-a181-004fc466fef6",
            "SavePermission": "2828f62f-5423-45b7-99d6-b2b2160a6b86",
            "Type": "DynamicSectionSetup"
          },
          {
            "Headline": "Videos",
            "Description": null,
            "Properties": [
              {
                "AttributeUid": "84fcd785-662b-4d61-9708-b60178cd670d",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "76484479-df1c-42b1-8ba0-98dc00e5f99e",
                "ViewPermission": "a0ed26e8-a9d7-4dc8-9db4-c543f71d61b5",
                "SavePermission": "86fd8f0d-3f8e-48bd-924a-24f5d12589e0",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "58c1f229-cb04-49a3-ad3c-104c8ae07c14",
            "ViewPermission": "135ff2cc-c786-4840-bff8-30b5acf07fa6",
            "SavePermission": "cc70621e-854f-40e1-b547-4e6d91e5d9de",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "5fd26a45-4451-4329-8551-91a1573f21df",
        "ViewPermission": "889d76ce-a10d-4dd4-9ea6-04ef703c3e90",
        "SavePermission": "372b1457-2ca2-49a9-8f8e-3d67b43bed68",
        "Type": "DynamicTabSetup"
      },
      {
        "Uid": "e6be0fe3-bf18-489c-8e38-2e4e953523a9",
        "ViewPermission": "8dc752bc-7f42-4139-8b80-2dde313c83ef",
        "SavePermission": "a06d5807-71d8-4252-97eb-ab7562522497",
        "Type": "ClassificationsTabSetup"
      },
      {
        "Uid": "45dec675-83c7-4100-a6d7-f4bf77fa713b",
        "ViewPermission": "4be07f75-3f3a-4dbb-9aea-c3b05d4fccc6",
        "SavePermission": "7546aaf6-b15e-4373-9047-89e64152ddf3",
        "Type": "VariantsTabSetup"
      }
    ]
  },
  "VariantGroupConfiguration": null,
  "VariantConfiguration": {
    "ThumbnailReference": "Variant_c9457028-9bbc-4b8f-b4ec-1047261f7876",
    "CreateWizard": {
      "Uid": "67a93ba0-53a4-4475-9a24-4004bb6cd27f",
      "Steps": [
        {
          "Properties": [
            {
              "PropertyUid": "10658571-8ffd-4b5b-bb4e-a647f35e1342",
              "Mandatory": true,
              "Uid": "e18afa9b-05c9-495f-a2de-61124fc91e90",
              "Type": "AttributeWizardPropertySetup"
            }
          ],
          "Uid": "e0712c01-9c9a-4218-8028-870a04db7ebf",
          "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": "eccca6b1-4955-428c-8282-8bd21e0d9517",
                "ReadOnly": false,
                "Mandatory": true,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "10658571-8ffd-4b5b-bb4e-a647f35e1342",
                "ViewPermission": "5c20d17d-5b38-4cd0-9726-daf9485fb5d2",
                "SavePermission": "f71a5ab8-04db-4ca7-aaf6-ed6f677ff208",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "1089c399-bd5b-4960-a71e-34528820ad79",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "dec20907-9366-4867-9eef-cea7ecb88229",
                "ViewPermission": "166edf07-2617-4ee7-b96a-686ce71ac411",
                "SavePermission": "3184b03f-7175-4618-b7ae-3429f4a72cad",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "9fc1f12a-b64d-40d1-9bd7-44309897f36b",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "d9f1dcc4-6b11-4044-8452-d1d811a0bd29",
                "ViewPermission": "0e809547-1e0c-4c4b-bf7b-06ac0826ae78",
                "SavePermission": "3f88ce35-32f2-442a-8f5c-d061a110e119",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "fc3b8f8e-7db1-43f1-b0b4-b8141e19ede9",
            "ViewPermission": "43c909ee-2003-4385-8707-f9e2ca2f2e5d",
            "SavePermission": "62f14c53-0352-4742-b478-eb214bbf40e6",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "116ea8fb-912a-4df4-b5b2-ace4719d809b",
        "ViewPermission": "11538523-92ed-48d2-a75a-ab9e084078b0",
        "SavePermission": "832028fd-f0d1-4c62-8672-9b17d920bd51",
        "Type": "DynamicTabSetup"
      },
      {
        "Label": "Media",
        "Sections": [
          {
            "Headline": "Images",
            "Description": "View and override product image if necessary",
            "Properties": [
              {
                "AttributeUid": "c9457028-9bbc-4b8f-b4ec-1047261f7876",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": true,
                "Uid": "d0482837-97b1-4c06-b770-d26f352540b7",
                "ViewPermission": "b5bcf49d-f698-407a-b257-6717b397361d",
                "SavePermission": "77f821f9-3b38-404b-803b-6b5e84f5fb2b",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "6ccade3c-876c-476d-adf8-edc491d4fbe8",
            "ViewPermission": "24781fca-1acb-4419-8ad1-1e77fba1fdb3",
            "SavePermission": "b23ddd9c-713f-4640-ad64-fc43de15fc52",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "2fda1bd1-a9d9-4c94-9dbb-969a0952c592",
        "ViewPermission": "4bfd8bac-e67b-4ee1-9dea-ecf5fea2466e",
        "SavePermission": "5d2e65e7-3af1-4544-b1d3-fff07527b7cf",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "3269962a-3052-4fe2-bd3b-aec777b70db6",
      "Alias": "ColorVariants",
      "Name": "Color variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "eccca6b1-4955-428c-8282-8bd21e0d9517",
          "1089c399-bd5b-4960-a71e-34528820ad79"
        ]
      },
      "DefiningAttributes": [
        "1089c399-bd5b-4960-a71e-34528820ad79"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "cbce12d8-0b12-4772-9de5-8cf52bb65e17",
      "Alias": "SizeVariants",
      "Name": "Size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1}",
        "NameAttributes": [
          "eccca6b1-4955-428c-8282-8bd21e0d9517",
          "9fc1f12a-b64d-40d1-9bd7-44309897f36b"
        ]
      },
      "DefiningAttributes": [
        "9fc1f12a-b64d-40d1-9bd7-44309897f36b"
      ],
      "SortOrder": 1
    },
    {
      "Uid": "51a954b3-f0b4-42ea-aa19-d6885f9231d3",
      "Alias": "ColorAndSizeVariants",
      "Name": "Color/size variants",
      "NameConfiguration": {
        "NamePattern": "{0} - {1} / {2}",
        "NameAttributes": [
          "eccca6b1-4955-428c-8282-8bd21e0d9517",
          "1089c399-bd5b-4960-a71e-34528820ad79",
          "9fc1f12a-b64d-40d1-9bd7-44309897f36b"
        ]
      },
      "DefiningAttributes": [
        "1089c399-bd5b-4960-a71e-34528820ad79",
        "9fc1f12a-b64d-40d1-9bd7-44309897f36b"
      ],
      "SortOrder": 3
    }
  ],
  "AlwaysOnDefiningAttributes": null,
  "ProductIdentifierDefinitions": [
    {
      "Uid": "3ae371c9-6813-413c-8985-4386b9a2b1ee",
      "Alias": "ModelNoIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "763e096f-f02a-418c-a5d9-bac1d10bc8dd"
      ]
    }
  ],
  "VariantGroupIdentifierDefinitions": null,
  "VariantIdentifierDefinitions": [
    {
      "Uid": "116ea94e-ecfd-437a-989b-16768660bf4e",
      "Alias": "SKUIdentifier",
      "IdentifierPattern": "{0}",
      "IdentifierAttributes": [
        "eccca6b1-4955-428c-8282-8bd21e0d9517"
      ]
    }
  ]
}

Delete a product structure

delete

#Available from v.3.2.0

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of product structure to delete

Responses

200

OK

No content

delete

/v1/productstructures/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/productstructures/{uid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content