Product Variant scenarios
Contents
- 1 Contents
- 2 Information
- 3 Sample data
- 4 Scenario 1: display all products separately on the PLP (no Product Variant)
- 5 Scenario 2: bundle all products of a Product Variant to show one tile on the PLP
- 5.1 URL
- 5.2 Request sample
- 6 Scenario 3: bundle products of a Product Variant based on the attribute to display one tile per selected attribute
- 6.1 URL
- 6.2 Request sample
Information
How to link product to
Sample data
Option | Example products | Example attributes | Input validation in Cloudsuite client |
|---|---|---|---|
1 | Blue shirt size Small | color = blue |
|
2 | Blue shirt size Medium | color = blue |
|
3 | Red shirt size Small | color = red |
|
4 | Red shirt size Medium | color = red |
|
Scenario 1: display all products separately on the PLP (no Product Variant)
This scenario shows how the products are displayed on the PLP before creating a Product Variant
Scenario 2: bundle all products of a Product Variant to show one tile on the PLP
This scenario bundles all products of the variant in one product tile where only the first product of the variant is displayed on the PLP.
This scenario is reached by choosing "group_by_variant" in the "group_by"field.
Attributes in the Product Variant do not affect the way products are displayed on the PLP, but at least one attribute is required enable filtering on the PDP.
URL
PUT /api/origin/{origin_code}/productvariant/{key}/
POST /api/origin/{origin_code}/productvariant/{key}/Request sample
{
...
"name": "CloudSuite shirt",
"overrule_product_name": true,
"group_by": "group_by_variant",
"products": [
"shirt_blue_small",
"shirt_blue_medium",
"shirt_red_small",
"shirt_red_medium"
],
"attributes": [
{
"key": "color",
"sequence": 0,
"unique_search": false
},
{
"key": "size",
"sequence": 1,
"unique_search": false
}
...
}Scenario 3: bundle products of a Product Variant based on the attribute to display one tile per selected attribute
This scenario bundles products in the variant that have the same attribute (color in this scenario) so only one size of each color is displayed on the PLP.
URL
PUT /api/origin/{origin_code}/productvariant/{key}/
POST /api/origin/{origin_code}/productvariant/{key}/Request sample
{
...
"name": "CloudSuite shirt",
"overrule_product_name": true,
"group_by": "group_by_attribute",
"products": [
"shirt_blue_small",
"shirt_blue_medium",
"shirt_red_small",
"shirt_red_medium"
],
"attributes": [
{
"key": "color",
"sequence": 0,
"unique_search": false
},
{
"key": "size",
"sequence": 1,
"unique_search": true
}
...
}This scenario is reached by choosing "group_by_attribute" in the "group_by"field.
The attribute that is bundled (size in this scenario) is decided by "unique_search": true in the attributes array
Documentation: API access - CloudSuite
Related content
© 2024 CloudSuite BV, All rights reserved