How to set up a variant model

Setting up a variant model

To set up a variant, you need add it to an existing product structure. For this example we will be using the product structure "Demo Structure" from the tutorial:How to set up and edit a product model.

When configuring the product model, toggle the "Has variants" option to enable the variant model in the product structure. As shown below, a new variant model option appears under the product model configurations.

Click on the variant model title to expand and view the various setup options. Now navigate to "Model setup".

Model setup

From here you can configure the data model for variants using this product structure. The process is identical to setting up the data model for products and you can read here how that works in detail.

Below you can see an example of what a data model for variants could look like.

In the setup we have added a dynamic tab "General" and a dynamic section "Basic information", that contains three properties of type 'attribute'. Each variant in this example will have their own SKU, Color and CostPrice.

Once done click on the option "Wizard setup" to continue to the next step in the variant model setup.

Wizard setup

Just like when setting up a product model, the wizard setup is optional. However, it can be beneficial to others using the PIM when needing to add or copy new entities. In the case with variant model, you only have the option to set up a "Model creation flow" to guide users when creating a new variant.

Configuring a wizard setup in a variant model, is done the same way as in product model. Click here to see the wizard setup in the product model.

In the example above a flow is created and the three attributes from the variant data model are added as mandatory.

From here proceed to display settings.

Display settings

Here you can configure the thumbnails for variant using this product structure. In this example we will not be giving each variant a thumbnail.

Once done configuring display setting continue to the next step, identifiers.

Identifiers

When done configuring the identifiers, move on to the final step, variation definitions.

Variation definitions

When configuring a variation definition, you can add a variation definition by clicking the "Add Variation Definition" button. While it is optional, we advise setting up variant definitions, as variants created without a definition can make it hard to differentiate between them as they will be rendered without a name.

When clicking the "Add variation definition"-button you will be presented with a collapsed and empty variation definition. Click on it to expand it and see the fields to configure.

To configure a variation definition you must choose the defining attributes for the variations following this product structure. In the example below variants are set to be defined by their color.

An alias is also given as a unique identifer for the definition. You can also give it a name to make it easier for other PIM users to differentiate between the definitions. In the example the defintion was named "Product w. color variations".

When defining variation, select the attributes for the variant data model that will be used to render each variants name. In the example above, variant names are created using their SKU and color. Ensure the name pattern aligns with the number of attributes in the "Name attributes" field.

You can choose to define attributes that are always shown. This is helpful if you have multiple variation definitions set up but want a defining attribute to be always available, regardless of the variation definition.

Once you're satisfied with the setup, click the "Save" button in the bottom right corner to store your newly created variant model.