Configuration
The SCAYLE Panel allows you to efficiently set up and manage promotions. With correct configuration, all promotion-related components—such as promotion cards, banners, discounts, badges, and ribbons—will display as expected across the storefront.
To ensure full support for all promotion features implemented in the Storefront application, follow these three essential steps:
- Set up a promotion
- Configure
customData
- Link the promotion to products
Setting Up a Promotion
- Navigate to Shops → Promotions and choose your promotion type.
- Click on + New Promotion.
- Select your promotion type and conditions.
- Refer to the SCAYLE Promotion Guide for setup details and step-by-step tutorials.
Configuring customData
To enhance the default UI of promotion components, you can add customData
to your promotions. This allows you to customize colors, labels, links, and include additional UX elements like headlines, sublines, or minimum order value logic.
How to Add customData
:
- Open the promotion in the SCAYLE Panel.
- Click on Edit → Three dots → Edit Additional Data.\
Accessing the customData Configuration
- Paste your
customData
into the modal using the following schema (replace the values with ones that suit your needs):
{
"headline": "Final Winter Sale",
"subline": "Up to -60% off on selected items",
"link": "/c/c-50342?filters[color]=32",
"hideCountdown": true;
"color": {
background: "#f4c2c2",
text: "#000000"
},
"product": {
"attributeId": 2639,
"badgeLabel": "Final Winter Sale"
},
"minimumOrderValue": 10000,
"conditions": "The promotion applies to winter season products. If you buy 1 or more products, you will get up to 60% discount on these products. The promotion lasts till the end of March 1st, 2025."
}
customData
Fields & Their Usage
Field | Example | Used For | Fallback |
---|---|---|---|
headline | "Final Winter Sale" | Ribbon, banner, overview card, basket price summary | Promotion name |
subline | "Up to -60% off on selected items" | Ribbon, banner, overview card | Don’t show if not set |
link |
⚠️ only relative links are supported | Clickable ribbon, banner, overview card | Not clickable if missing |
hideCountdown | true | Ribbon, banner, overview card | Displayed by default |
color | { background: "#f4c2c2", text: "#000000" } | All elements | Default promotion theme |
product.attributeId | 123 | Badge, banner | Don’t display badge, banner, and gift collection on the PDP |
product.badgeLabel | "Winter Sale" | Badge label | "DEAL" |
minimumOrderValue | 10000 | MOV (Minimum Order Value) banner | Don’t show if not set |
conditions | "Applies to winter products" | Overview card | Don’t show if not set |
Linking a Promotion to Products
To ensure correct display of promotion-related components, the promotion must be linked to the relevant products.
Step-by-step:
- After creating the promotion, go to Settings → Product Structure → Attributes.
- Create a new attribute group called
Promotion
.\ - Within this group, go to the Attributes tab and add a new attribute representing your promotion.\
- Click Save. An ID will be generated—this is your
attributeId
.\ - Add this ID to your
customData
underproduct.attributeId
.
Now, link the attribute to your products:
- Go to Products in the SCAYLE Panel.
- Use filters to select a product category, or select products manually.
- Click Update.
- In the modal:
- Type: Attribute Group
- Attribute Group: Promotion
- Action: Replace
- Target Values: [Your promotion name]\
- Click Proceed.
Congrats! You've successfully completed your promotion setup and unlocked full support for all Storefront promotion features!