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

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text",
    "Label": "text",
    "HasVariants": true,
    "HasVariantGroups": true,
    "ProductConfiguration": {
      "ThumbnailReference": "text",
      "NameConfiguration": {
        "NamePattern": "text",
        "NameAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      },
      "CreateWizard": {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Steps": [
          {
            "Uid": "123e4567-e89b-12d3-a456-426614174000",
            "Headline": "text",
            "Description": "text",
            "Type": "text"
          }
        ]
      },
      "CopyWizard": {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Steps": [
          {
            "Uid": "123e4567-e89b-12d3-a456-426614174000",
            "Headline": "text",
            "Description": "text",
            "Type": "text"
          }
        ]
      },
      "Tabs": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
          "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
          "Type": "text"
        }
      ]
    },
    "VariantGroupConfiguration": {
      "GroupingAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "ThumbnailReference": "text",
      "NameConfiguration": {
        "NamePattern": "text",
        "NameAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      },
      "CreateWizard": {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Steps": [
          {
            "Uid": "123e4567-e89b-12d3-a456-426614174000",
            "Headline": "text",
            "Description": "text",
            "Type": "text"
          }
        ]
      },
      "CopyWizard": {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Steps": [
          {
            "Uid": "123e4567-e89b-12d3-a456-426614174000",
            "Headline": "text",
            "Description": "text",
            "Type": "text"
          }
        ]
      },
      "Tabs": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
          "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
          "Type": "text"
        }
      ]
    },
    "VariantConfiguration": {
      "ThumbnailReference": "text",
      "CreateWizard": {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Steps": [
          {
            "Uid": "123e4567-e89b-12d3-a456-426614174000",
            "Headline": "text",
            "Description": "text",
            "Type": "text"
          }
        ]
      },
      "Tabs": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
          "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
          "Type": "text"
        }
      ]
    },
    "VariationDefinitions": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Alias": "text",
        "Name": "text",
        "NameConfiguration": {
          "NamePattern": "text",
          "NameAttributes": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "DefiningAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "SortOrder": 1
      }
    ],
    "AlwaysOnDefiningAttributes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ProductIdentifierDefinitions": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Alias": "text",
        "IdentifierPattern": "text",
        "IdentifierAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "VariantGroupIdentifierDefinitions": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Alias": "text",
        "IdentifierPattern": "text",
        "IdentifierAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "VariantIdentifierDefinitions": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Alias": "text",
        "IdentifierPattern": "text",
        "IdentifierAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ]
  }
]

Create new product structure

post

#Available from v.3.2.0

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+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

400

Bad Request

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /v1/productstructures HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 2748

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "HasVariants": true,
  "HasVariantGroups": true,
  "ProductConfiguration": {
    "ThumbnailReference": "text",
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "CopyWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "VariantGroupConfiguration": {
    "GroupingAttributes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ThumbnailReference": "text",
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "CopyWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "VariantConfiguration": {
    "ThumbnailReference": "text",
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "Name": "text",
      "NameConfiguration": {
        "NamePattern": "text",
        "NameAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      },
      "DefiningAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "SortOrder": 1
    }
  ],
  "AlwaysOnDefiningAttributes": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ProductIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "VariantGroupIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "VariantIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

Update a product structure

put

#Available from v.3.2.0

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+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

400

Bad Request

text/plainapplication/jsontext/json

put

HTTPcURLJavaScriptPython

PUT /v1/productstructures HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 2748

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "HasVariants": true,
  "HasVariantGroups": true,
  "ProductConfiguration": {
    "ThumbnailReference": "text",
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "CopyWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "VariantGroupConfiguration": {
    "GroupingAttributes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ThumbnailReference": "text",
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "CopyWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "VariantConfiguration": {
    "ThumbnailReference": "text",
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "Name": "text",
      "NameConfiguration": {
        "NamePattern": "text",
        "NameAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      },
      "DefiningAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "SortOrder": 1
    }
  ],
  "AlwaysOnDefiningAttributes": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ProductIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "VariantGroupIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "VariantIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

Get a product structure

get

#Available from v.3.2.0

Authorizations

Path parameters

uidstring · uuidRequired

Unique id of product structure

Responses

200

OK

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

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

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "HasVariants": true,
  "HasVariantGroups": true,
  "ProductConfiguration": {
    "ThumbnailReference": "text",
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text",
          "Type": "text"
        }
      ]
    },
    "CopyWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text",
          "Type": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
        "Type": "text"
      }
    ]
  },
  "VariantGroupConfiguration": {
    "GroupingAttributes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ThumbnailReference": "text",
    "NameConfiguration": {
      "NamePattern": "text",
      "NameAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text",
          "Type": "text"
        }
      ]
    },
    "CopyWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text",
          "Type": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
        "Type": "text"
      }
    ]
  },
  "VariantConfiguration": {
    "ThumbnailReference": "text",
    "CreateWizard": {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Steps": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "Headline": "text",
          "Description": "text",
          "Type": "text"
        }
      ]
    },
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
        "Type": "text"
      }
    ]
  },
  "VariationDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "Name": "text",
      "NameConfiguration": {
        "NamePattern": "text",
        "NameAttributes": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      },
      "DefiningAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "SortOrder": 1
    }
  ],
  "AlwaysOnDefiningAttributes": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ProductIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "VariantGroupIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "VariantIdentifierDefinitions": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Alias": "text",
      "IdentifierPattern": "text",
      "IdentifierAttributes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Delete a product structure

delete

#Available from v.3.2.0

Authorizations

Path parameters

uidstring · uuidRequired

Unique id of product structure to delete

Responses

200

OK

delete

HTTPcURLJavaScriptPython

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

200

OK

No content