What’s New
In June 2018, Skava released version 7.5 of its Commerce platform. The Promotion microservice was impacted in the following ways with the 7.5 release:
- Campaign identifier has been replaced as Store identifier for all Promotion Application Programming Interfaces (APIs).
- Store identifier has been made a mandatory field in the regular APIs (all service calls),
- The Stores List page will no longer be the landing page for the Promotion Admin; accessing Promotion Admin through a Store has been discontinued. From now on, Promotion service can be accessed thorough Skava Commerce.
- A List tab and privileges for managing and configuring lists have been newly created.
- A Promotion offer on specific criteria can be set at the cart level.
- Only defined roles can access the Promotion microservice.
See below for the current Admin User Guide for Promotion updated for the 7.5 Skava Commerce release.
For details about the technical implementation of the Promotion microservice, please see Promotion Microservice under the Skava Commerce 7.5 section of this portal. |
Introduction
Skava’s Promotion microservice enables an administrator to manage promotions within a promotion that are homogenous in nature, setup and schedule various promotional offers for a period of time, use business rules and actions around each promotion, create custom promotional codes, generate random promotional codes or upload pre-defined promotional codes in .csv/.txt format files, and preview the promotion group or promotion before it is set to LIVE.
This guide also describes how to create various promotion rules. For more information, see Promotion Use Case.
Intended Audience
This document is intended for the Customer Service Representatives (CSRs) with appropriate privileges who manage Skava Promotion through Skava Commerce.
About Promotions
Using Skava Promotion, you can provide various types of offers by:
- offering percentage-based discount, currency-based discount, or fixed price discount on category, products, SKU, or Cart
- scheduling promotions in advance with set of business rules and actions to execute
- creating custom or random system generated promotional codes
You can create multiple promotions groups under which multiple promotions can be created. Each promotion can contain one or more actions.
How Promotion Works
When the end user avails an offer, the promotions engine first checks the active promotion group(s) that falls in the required date range, and then checks for the conditions in it, based on the priority. Once it passes through, it checks for the active promotion(s) that falls in the required date range, and then checks for the conditions in it based on the priority and executes the actions, if the condition matches.
Key Terms
Term | Definition |
Action | This specifies the steps to be performed when a promotion and/or promotion group’s condition is met. |
BOGO | This is the acronym for ‘Buy One, Get One Free.’ |
Business | This refers to a customer who has signed up with Skava to launch their commerce store or a digital experience. |
Cart | This refers to a virtual shopping basket or a bag. When an end-user browses on the site, s/he needs a way to collect the items in one (1) place, which s/he can buy later. The cart module facilitates this feature by allowing end-users to add to and manage items in their cart, popularly known as a shopping bag. |
Checkout | This is the payment portal. When an end-user browses the site, s/he needs a way to place the order. The checkout module facilitates this feature by allowing end-users to make payments and to place orders for items added to the shopping bag. |
Condition | This refers to the business rules that must be met in order to avail promotional offers. |
Customer | This refers to a business using a Skava Commerce backed storefront or site (e.g. FDC, Toyota, etc.). |
End-user | This refers to a consumer (end-user) of a business’ products or services or site. |
GWP | This is the acronym for a ‘Gift with Purchase.’ |
Instance | This refers to a full deployment of that Skava Commerce platform that can be used to host one or more businesses. |
Locale | This refers to a set of parameters that defines the user’s language, region, currency, and date format. For example, en_US refers to English language, USA region, USD currency, and MM/DD/YYYY format. |
Payment | This is the act of settlement (payment) for the products added to cart in order to place the order. |
Privileges | This refers to permission or right given to a user to perform an action in the admin console. |
Product | This refers to an item that is manufactured and available for sale. Since a Product can have multiple variants, Skava Commerce also has an SKU (Stock Keeping Unit), which refers to a particular variant of the Product which is transacted upon by the consumer. For example, the ‘Product’ can be ‘Oxford Classic Casual Shoe’ and the particular variant with Black color and size 9 is an SKU. |
Promotion | This is an individual promotion that encapsulates the rules, conditions, actions, and other properties such as the effective date that may be evaluated individually, or collectively when defined as a rule set. |
Promotion Group | Multiple promotions that are similar in nature can be grouped together in a single Promotion Group. For example, holiday promotions for Black Friday, Mother’s Day, etc. The properties used to be common to all promotions within a group; for example, start and end date and time. |
SKU | This is the acronym for a Stock Keeping Unit, which is a variant of the product that is transacted upon in Skava Commerce. |
Stop Further Processing | This breaks the execution flow of a promotion group and/or an individual promotion based on stop conditions. |
Versioning | This denotes the history of the promotion group or promotion. |
Accessing a Promotion Service
To access a Promotion instance through Skava Commerce,
1. Log into Skava Commerce using the URL https://<domain>/mcadmin/v2/login.jsp
with valid credentials.
2. In the business landing page, click the required business instance; for example:
All the microservice instances associated to the required business appears.
3. In the Microservices section, under the promotion card, click to launch the required promotion service.
The Promotion Group page appears in the next tab of your browser.
Promotion Group Page
In the Promotion Group page, you can:
- create a new Promotion Group
- view the existing Promotion Groups
- search by promotion group name, priority or status
- sort promotion group name, priority, or status by ascending/descending order
- delete a particular inactive Promotion Group
- maintain and track multiple [versions](doc:promotion-admin-guide#section-viewing-the-previous-versions) of a promotion group
Creating a New Promotion Group
A Promotion Group enables you to organize multiple similar promotions. Once you create a new promotion group, you can create a new promotion, manage the existing promotions, and/or clone the existing promotion.
To create a new promotion group,
1. In the Promotions home page, click .
2. In the General tab, enter/select the required information:
Field | Description |
Group Name | Enter a name that describes the promotion group. |
Date | Select the start date and time, and end date and time for the promotion group. Note:
|
Recurrence | Set recurrence to trigger the promotion group periodically. For more information, see Setting Up Recurrence for a Promotion Group and/or Promotion. |
Status | When the promotion group is within its time bounds and the status is made inactive, the promotion group will not be picked up by the promotion engine to execute. Select:
|
Condition | Allows you to set business rules by selecting various conditions using SKU properties such as Category ID, Product ID, SKU ID, Quantity, Unit Price, Size, Color, Brand, or custom defined properties in the promotion group. After setting conditions to the promotion group, you can click on Generate Conditions to check your business rule. This is optional.For more information on creating and generating conditions, see Creating Conditions to the Promotion Group/Promotion. |
Stop Further Processing | Allows you to stop further processing of the succeeding promotion groups based on the following:
Note: When you configure the promotion with promo codes, the rule engine stops further processing the condition after matching the promo code in the condition.
Note: For details, see Creating Conditions to the Promotion Group/Promotion. |
Priority | Enter the priority number between 0 and 9 where 9 being the highest and 0 being the lowest in the priority order. The promotion engine reads the active promotion groups and active promotions in it as per the priority order |
3. Click to save the newly created promotion group. Once saved, the Summary page appears with all the general details of promotion group. You can create new promotions within the group.
Creating a New Promotion
You can create one (1) or more Promotions with a different set of conditions, actions, and priorities for each promotion. The promotion engine executes the promotion group based on the priority, active status, and conditions. If the condition matches, the promotion engine reads each active promotion within the group and executes the promotion offer based on the priority order, conditions, and actions set for each promotion.
While creating a promotion, you can add multiple locales where the description can be added according to the selected locale.
Note: To view the multiple versions of a promotion, go to the required promotion group and click .
To create a new promotion,
1. In the Promotion’s home page, click of a particular promotion group.
The summary of the created promotion group opens:
2. Click .
3. In the General tab, enter/select the required information:
Field | Description |
Name | Enter a name that describes the promotion. |
Message | Describe promotion details here. This field is optional. The message entered here appears to the consumer on a product or while checking out on the e-commerce site. Note:
|
Description (Optional) | Enter any additional information required to describe the promotion offer. This field is optional. The additional information entered here appears to the consumer on a product or while checking out on the e-commerce site. Note: You can also enter a description at the action level. In that case, it overrides the information set at the promotion level. For more information, see Setting Description at the Action Level. |
Category (Optional) | A promotion is categorized based on the pre-defined rule types. In addition to this, a new Category (Optional) dropdown list can be added which appears after Description in the Create Promotion page. You need to define values for Category dropdown list in the ZooKeeper property as per your business needs. Note: The Category dropdown list is shown only when you configure the required property in ZooKeeper. |
Date | Select the start date and time, and end date and time for the promotion. The promotion offer is applicable only on the selected date and time, otherwise, the promotion expires. You will be able to select the date for a promotion that falls within the promotion group duration. Note:
|
Recurrence | Set recurrence to trigger the promotion periodically. For more information, see Setting Recurrence for a Promotion Group and/or Promotion. |
Status | When the promotion is within its time bounds and the status is made inactive, the promotion will not be picked up by the promotion engine to execute. Select:
|
Rule Type | Select the rule type as:
|
Action Type | Select an action type:
Note: You can also set the actual discount value between the maximum and minimum range on the Actions page.
|
Priority | Enter the priority number between 0 and 9 where 9 being the highest and 0 being the lowest in the priority order. The promotion engine reads the active promotion groups and active promotions in it as per the priority order. |
4. Click to save the promotion to the promotion group. After saving, a unique ID is created. If required, you can edit the promotion.
Adding Multiple Locales for a Promotion’s Message
You can add multiple locales to a promotion where a message can be added according to the selected locale. The initial message is set to default to the locale that you have defined under Default Locale in the campaign settings. All locales configured in the campaign settings will be displayed in the dropdown list.
For configuring default locale, refer to the “Configuring Common Settings (Language and Currency)” section of the Product Information Management Admin User Guide.
To add a locale with a message in that language,
1. While creating a promotion, click .
2. Select the required locale and enter the promotional message in that language manually.
Note:
- To remove a particular locale and its message, click .
- Once you add a locale and message, you will NOT be able to select the same locale again.
Setting Up Recurrence for a Promotion Group and/or Promotion
Overview
Promotion allows you to set recurrence to a promotion group and/or promotion. You can use Recurrence to trigger the promotion group and/or promotion periodically. You need to ensure that the recurrence set is within bounds of the start date/time and end date/time.
Note: You cannot edit Recurrence once the promotion group/promotion has started.
For example, while creating a promotion group:
Options in Recurrence
Click on the Recurrence and set the following:
- Time Zone: Shows the default time zone that you have set in the Campaign Settings; however, you may change the time zone as required.
- Time: Runs the promotion group/promotion only between the specified duration. Select Time and set the time duration by incrementing or decrementing the hour and/or minute. This is optional.
- Day of the Week: Triggers the promotion group/promotion only on the selected day(s). Select this option and select the required day(s). This is optional.
- Day of the Month: Runs the promotion group/promotion only on the specified dates. Select this option and enter dates and/or date ranges separated by commas; for example, 1-7, 10, 14-17.
- Month: Runs the promotion group/promotion only on the selected month(s). This is optional.
Summary Page
In the Summary page, the Recurrence detail appears as follows:
If required, you can edit the recurrence details by clicking either in the General section or clicking the General tab in the left pane.
Scenario
To run a promotion for the US, Chicago region on every weekend between April 1 and 30 during the time 9:00 AM to 9:00 PM, then configure the recurrence as follows:
Generating Promo Codes to the Promotion
Promotion codes are unique for a campaign. You can choose to add promo codes to your promotions in the Promocodes tab. Adding promo codes to your promotions is optional. You can add, generate, or upload unique promo codes to a promotion. Once saved, the promocodes can be downloaded in the .csv file format.
The promo code associated with a promotion applies a discount when a set of conditions is met. The customer avails discounts by applying the code against their order on the shopping cart page of the Commerce site. The codes expire as per the dates selected in the promotion.
1. Click Promocodes in the left pane.
2. Select any one of the following promo code types:
Promo Code Type | Description |
Single User Single Use | This means one (1) single user can use the promo code one (1) time, after which the promo code will expire. |
Single User N Times Use | This means one (1) single user can use the promo code. The promotion code will expire after the end-user uses for the defined number of times specified in the Promocode Usage Count. |
Multi User Multi Use | This means multiple users can use the promo code multiple times. Note: You can reuse the expired promo codes in a new promotion. |
Multi User Multi Use – M Times Limited Offer | This means multiple users can use the promo code multiple times; however, as per the overall usage count specified in the Promocode Usage Count. Note: You can reuse the expired promo codes in a new promotion. |
Multi User N Times Use Per User | This means multiple users can use the promo code; however, the promotion code will expire after a defined number of times per user as specified in the Promocode Usage Count For User. Note: You can reuse the expired promo codes in a new promotion. |
Single User N Times Use Per X Days | This means one (1) single user can use the code for a defined number of times as specified in Promocode Usage Count For User for defined days as specified in Days Count For Use. |
3. Click any one of the following tabs to:
- Add Promo Codes: Enables you to add custom promo codes; for more information, see Add Promo Codes.
- Generate Promo Codes: Generates multiple unique promo codes; for more information, see Generate Promo Codes.
- Upload Promo Codes: Allows you to upload the
.csv
or.txt
file containing a list of promo codes; for more information, see Upload Promo Codes.
4. Click to save the added promo codes.
Add Promo Codes
To add promo codes to the promotion,
1. Click the Add Promo Codes tab.
2. Enter the promo code and click .
The promo code will be added as shown below:
You can view, edit, or delete the added promo code. However, saved promo codes cannot be edited or deleted.
Generate Promo Codes
A maximum of only 100,000 promo codes can be generated at a time. However, you can save it, and then continue generating a maximum of 1 million promo codes for a promotion. For example, to create 1 million promo codes for a promotion, generate 100 thousand promo codes at a time, and then repeat the same step 10 times to create 1 million promo codes.
While generating promo codes you can,
- add prefix and/or suffix to the system-generated promo codes
- specify the number of characters of the promo code the system has to generate
- specify the number of codes the system has to generate
- specify if the promo codes generated can have alphabet, numbers, or alphanumeric characters
To generate multiple promo codes automatically,
1. Click the Generate Promo Codes tab.
2. Select Prefix and add a term in the prefix. This is optional.
3. Select Suffix and add a term in the suffix. This is optional.
4. Enter the number of codes you want to generate.
5. Enter the number of characters you want to have for the promo code.
6. Select any one of the following:
- Only Digits – To generate only digits
- Only Alphabets – To generate only alphabets
- Both – To generate a combination of both digits and alphabets
7. Click which generates the code automatically.
Upload Promo Codes
You can upload the promo codes in a .csv
or .txt
format file from your local machine to a promotion. Each promo code should be separated by a comma.
To upload the promo codes,
1. Click the Upload Promo Codes tab.
2. Click and select the .csv
or .txt
file from your local machine.
The promo codes will be displayed as shown below:
Creating Conditions to the Promotion Group/Promotion
You can add one or more rules or group of rules to a promotion group and/or a promotion. You can create a maximum of three levels of rules for each promotion group or promotion. By default, a row will be shown to add a rule. After setting the conditions to the promotion group or promotion, you may choose to click on Generate Condition to check if your condition is appropriate to your use case.
The following table describes options to create rules or group of rules to the promotion group or promotion:
Options in Condition | Description |
Enables you to set logical operators such as NOT, AND, and OR. These operators apply the rules that are a direct descendant of the condition builder. Examples:
|
|
Enables you to add multiple rules to the promotion group. For example, to create a rule where you need products from the category with Category ID as T-Shirt, you can set the following rule. |
|
Enables you to add a collection of rules within the group. For example, if you need to provide an offer on all products either from the category Boys or the category men with brand as Polo, you can create the following condition with groups: |
|
Enables you to change the order or hierarchy of the rules. Drag and place a particular rule where required. | |
Operand, Operators, and Values | Enables you to select the operands and operators for the condition. You can create different conditions by changing the combination of operands and operators. You can enter the required value in numeric for the selected item. A sample rule is shown below: *Selecting the Required Operands:* Select any one of the following filters for setting rules for a promotion: SKU:
Personalization:
Cart:
User:
*List of Operators*
Note: You can select a pre-defined list or manually enter values for specific operands. For more information, see Selecting a List or Manually Entering Values.
Selecting a List or Manually Entering Values for Specific Operands and Operators ‘in’ and ‘not in’: For specific operands and operators ‘in‘ and ‘not in‘, you can choose to manually enter the list separated by a comma when you select the None option or select a list you created that is associated to a particular operand.
|
Allows you to delete a rule or a rule group of conditions | |
Enables you to generate conditions and validate against your appropriate use case, after creating conditions using the condition builders. Click this button to view the generated conditions. For example, |
Creating Actions to a Promotion
Overview
After creating a new promotion and creating conditions to it, you need to specify what needs to be done when the condition matches. This is set using the actions. You can also create multiple different actions based on the action condition and assign different offer values to each action. The actions will vary according to the Rule Type and the Action Type selected in the General tab of the promotions.
Creating an Action
To create an action,
1. Click Actions in the left pane.
2. Enter an action name, which describes the action.
Based on the selected Rule Type, Action Type, and Offer Type a list of parameters will be displayed.
3. Enter the values for these parameters.
4. Enter the message and/or description. Both are optional fields. The information mentioned here overrides the information that is set at the promotion level. If these fields are blank, then the message and additional information available at the promotion level is considered.
5. Specify conditions for your actions. This is optional.
Action Rule Type | See |
---|---|
To provide a promotion offer for a specific user segment |
Promotion Offer for a Specific User Segment |
To provide a promotion offer for guest users or registered users |
Setting Promotion Offer for Guest or Registered Users |
To provide promotion offer on the bundled products |
Setting Promotion Offer to a Bundled Products |
A discount can be offered to target a specific gender |
Promotion Offer Targeting a Specific Gender |
To provide a promotion offer on a particular product type |
Setting Promotion Offer on a Product Type |
To provide a promotion offer on a particular product name |
Setting Promotion Offer on the Product Name |
Enables a CSR to provide a discount offer on the customer’s <br>cart by creating promo codes | Applying Promocodes by a CSR |
To provide promotion offer based on the type Buy X Get Y, Buy X And Y, or GWP |
Offer Type for BOGO Rules |
To create Cart level discounts on a specific criteria | Creating Cart Level Discounts on a Specific Criteria |
6. Click Create Action to create an action.
Note: Multiple actions can be created and distinguished based on the condition.
For example, if you are planning for 50% offer for Platinum users and 30% for Gold users, then you need to create two actions with different offer values and conditions as shown below:
Minimum and Maximum Discount Amounts on Percentage Offer
In Promotion, you can set minimum and maximum discount amounts on the offer type ‘% Offer‘. While creating a promotion, you need to set the action type to ‘% Offer’. In the Promotions’ Actions page, enter the minimum and maximum discounted amounts in the respective fields. This is to ensure that the actual discount value is between the maximum and minimum range. These fields are optional.
Scenario: If a retailer wants to offer 10% waiver on the total ordered amount to a customer who spends $500 or more but at the same time wants to restrict the maximum discounted amount to $30 and/or provide at least minimum discounted amount to $20.
Trade-In Promotion Offer
A retailer can offer discounts such as % Offer or Currency Discount on customer’s payment method. Customers can avail Trade-In offer when they go for multiple payments like partial payment and partial loan. The loan provider can offer a discount ‘% Offer’ or ‘Currency Offer’ on the loan amount. The Trade-In promotion offer is applicable only for the rule type ‘Cart Price Rules’. You need to select the offer type ‘Trade in Offer’ and set the necessary conditions in the Actions page.
Scenario: The retailer wants to offer 5% Trade-In offer if the provider is HDFC, card type is Visa, and installment period is 12 months.
Setting Formula for Calculating Offers
In Promotion, you can set formula for calculating promotion offers. You need to select “Formula” in the Action Type while creating a promotion:
Once selected, in Actions, you need to enter a formula; for example, calculating offer on the product price. In Formula, based on the rule type, suggestions will show for the data types such as integer, long, and/or double. You can select the required data type and enter required numeric values for calculating offers.
Note: In the Rule Type, if you have selected:
- Item Price Rules, BOGO Rules, Item Shipping Rules, then SKU data type will appear in the formula
- Cart Price Rules and Cart Shipping Rules, then cart data type will appear in the formula
Setting Personalized Gift or Product
You can use Promotion to provide discounts on gift-wrapping and personalization for a specific set of products. This feature is applicable only for the rule type ‘Item Price Rules’. In the Actions page, select the offer type Product Personalization and set offer value and conditions accordingly. Refer to the scenarios below for Gift Wrapping and Product Personalization.
Scenario for Gift Wrapping: A retailer wants to offer a discount on a Headset product, which is eligible for gift-wrapping. A cost $10 is associated with the gift-wrapping service. In promotion, reduce the cost by offering 50% discount.
In Promotion, set the following condition:
Note: The phrase (for example, ‘Gift Wrapping’ as shown in the above screenshot) will be specified by the CSR.
In the Actions page, select the offer type “Product Personalization” and set the offer value as 50% discount:
Scenario for Personalization: A retailer wants to offer a discount for placing a picture and engraving a name of customer’s choice on a Coffee Mug. The personalized service cost is $3 instead of usual cost $10.
In Promotion, set the following condition:
Note: The phrase (for example, ‘Photo on Coffee Mug’ as shown in the above screenshot) will be specified by the CSR.
In Actions page, select the offer type “Product Personalization” and set the offer value as $3 discount:
Setting Promotion Offer for Guest or Registered Users
Promotions allow you to provide promotion offer to guest and registered users.
To enable offer for guest users,
1. Go to the Actions page.
2. In Conditions, select Guest available under the User category and set it equivalent to:
True
– to provide an offer to Guest usersFalse
– to provide an offer to Registered users
Note:
- For Registered users, either set the Guest to False or set it not equal to True.
- When no such condition is specified, then the promotion will be applied to both guest and registered users.
Setting Promotion Offer to a Bundled Products
You can use promotions to grant a discount to the customers on bundled products. A bundle is a collection of related products. In a bundle, there will be the main product, mandatory products, and optional products. For example, a washing machine can be bundled with its stand and cover where the washing machine is the main product, the stand is the mandatory product, and the cover is the optional product. The promotion offer will be applicable if the customer opts for the bundled products. In the above example, at least the washing machine and its stand can be bundled.
Refer to the section below for:
Selecting Products for Bundle in the PIM microservice Admin Guide
To use promotion at the bundle level, set the rule type to ‘Item Price Rules’ and action type to ‘%Offer’.
1. In Promotion conditions, in the rule, select the Bundle and set it equivalent to True. In the subsequent rules, select Main Product Id and Optional Product Id, and enter the required identifiers.
Note: You can enter multiple mandatory/optional products if the products are part of the bundle. However, for all bundle products, specify only “Bundle equal True” in Conditions, select Bundled Product Offer in the offer type and set the offer value.
2. In the Actions page, select Bundled Product Offer in the offer type and set the offer value.
Promotion Offer for a Specific User Segment
A discount can be offered to target specific customers. For example, customers with a Gold plan can be offered 5% discount and customers with a Platinum plan can be offered 10% discount.
In the Actions page, select the Segments rule and enter the appropriate value; for example, Platinum.
Promotion Offer Targeting a Specific Gender
A discount can be offered to target a specific gender. In the Actions page, in Conditions, select Gender and enter the appropriate value; for example, Male or Female.
Scenario: A retailer wants to create a promotion offer for women with 10% discount on apparels made on woman’s day.
Setting Promotion Offer on a Product Type
You can create a promotion offer on a particular product type; for example, Footwear, Sunglass, and so on. While creating a rule in a promotion, select Product Type under the SKU category. Enter the product type as it appears in PIM:
Scenario: The retailer wants to offer 50% discount only on the footwear purchase.
In this scenario, the retailer can create a rule for a promotion, using the Product Type property as shown in the following image:
Setting Promotion Offer on the Product Name
You can create a promotion offer on a particular product name; for example, Adidas Shoes, Kilgore Sunglasses, Fastrack Watches and so on. While creating a rule in a promotion, select Product Name under the SKU option to create a promotion for a particular product.
Scenario: The retailer wants to offer 10% discount only on Adidas Shoes. You need to set the Promotions’ condition as shown below:
Applying Promocodes by a CSR
A customer care representative can create promo codes and apply a discount on the customer’s cart. The discount is applied only when a CSR applies the promo codes. An invalid promo code message is displayed in the cart when the customer tries to apply the same promo code.
Scenario: A customer calls up the customer care center and complains about a problem they are facing while trying to make a purchase. The customer care representative wants to appease an aggrieved customer by giving a discount on the customer’s purchase. The CSR creates and adds an agent promo code to the customer’s purchase, which will be applied to the cart.
To apply promocodes by a CSR,
1. Go to the Actions page of the required promotion.
2. In Conditions, select Is Customer Representative which is available under the User category and set it equivalent to:
- *
True
– to provide an offer by a CSR on behalf of the customer - *
False
– the CSR’s promocode will not be applied
3. Go to User Management and search the required customer.
4. Click Act on behalf of to access the customer’s cart as shown below:
5. Click the customer’s cart:
6. Add and apply the promo code to the customer’s cart.
The CSR’s discount offer is applied to the customer’s cart.
Offer Type for BOGO Rules
While creating a promotion, for the rule type BOGO Rules, select the action type Currency Offer or % Offer. In the Actions page, select any one of the following offer types:
- Buy X Get Y – a customer gets a percentage offer or currency offer on buying X number of items
- Enter the buy item type, identifier, and the number of quantities.
- Enter the get item type, identifier, and the number of quantities.
- Enter all the other required details.
- Enter the % offer value or currency offer value based on the action type you have selected while creating the promotion.
- Buy X And Y – a customer gets a percentage offer or currency offer on buying two different specific items
- Enter the buy item type, identifier, and a number of quantities for the items X and Y respectively.
- Enter all the other required details.
- Enter the % offer value or currency offer value based on the action type you have selected while creating the promotion.
- GWP – a customer gets a predefined gift along with the purchase of a predefined product. The customer cannot purchase the gift item separately.The GWP promotion feature is applicable only for the rule type ‘BOGO Rules’. In the Actions page, select the offer type ‘GWP’ and set the purchase and gift items. The purchase item can be set at a category, product or SKU level by specifying identifier and quantity of the purchase item. For offering gift items, you need to specify product and SKU identifier.In the storefront, when a customer purchases item(s), a gift automatically gets added to the cart. When a customer increases the quantity of the BUY product, the quantity of the gift in the Cart will also be increased.
For example,
A sample scenario:
When the customer adds one BLACK SUEDE YOUTH DESERT WEDGES, the person gets one BUBBLEGUM PINK CANVAS YOUTH CLASSICS.
In Promotions’ Actions page, select the offer type ‘GWP’ and enter the required product details as shown below:
On the Storefront,
Creating Cart Level Discounts on a Specific Criteria
You can create a cart level promotion offer targeting a set of products that match the specific criteria in the cart page. For example, the list of products to be excluded may be based on the criteria, like:
- Products in a category
- Products in a product type
- Products on sale or not on sale
- Specific list of product IDs
The percentage discount or currency offer is applied when the summed up total value on the matched products conforms to the value of the condition.
While creating a promotion, select the rule type ‘Item Price Rules’ and the action type ‘% Offer’ or ‘Currency Offer’. In the Actions page, select the offer type ‘Summed Up Product Price Offer’, set condition based on the summed up value, and set the offer value.
Note: Configuring condition based on the summed up value is optional.
The following table provides different cart level discount scenarios and how much the customer pays:
Viewing an Action
The created actions will be displayed as an accordion below the Create Action button.
To view a particular action, click on the action name or offer type. For example,
Editing an Action
To edit an action,
1. Click on the action name or offer type.
2. Click .
The values of the action parameters will be populated.
3. Make necessary changes in the action name, action parameters, and/or action conditions.
4. Click to update the changes.
Note: To discard the changes, click .
Deleting an Action
To delete an action,
1. Click on the action name or offer type.
2. Click .
For more details on rule types, refer to the Promotions Use Case section.
Managing the Existing Promotions
In a particular promotion group, you can:
- create a new promotion
- view the summary of an existing promotion or edit an existing promotion
- create additional promo codes for a promotion that has been started and in-progress
- download the existing promo codes
- delete a promotion
Viewing or Editing a Promotion
To view/edit a promotion,
1. In the Promotion’s home page, click of a particular promotion group. The summary of the created promotion group with a list of promotions will be displayed.
2. Click of a particular promotion. The summary of the created promotion opens:
3. Click in appropriate section to edit that section of the promotion:
Summary of a Promotion | Description |
General | Allows you to view or edit the following general information on a promotion:
|
Conditions | Enables you to view or edit the conditions and stop further processing details of a promotion. |
Promocodes | Enables you to:
To download the promo codes into your local machine, click the Download Promocodes button. The |
Actions | Provides option to view or edit the actions. Displays a message if there are no actions created to the promotion. |
Note: The options in the left panel allow you to generate promo codes, create conditions, and set actions.
Creating Additional Promo Codes for an ‘In-Progress’ Promotion
You can create additional promo codes even after the promotion has been started irrespective of whether the existing promocodes have been redeemed or not. You can add the promo codes only to the same promocode type that you had opted for the existing promo codes.
For promo code type, see Generating Promo Codes to the Promotion.
Restrictions in Editing a Promotion
There are certain limitations while editing a promotion. The limitations are as follows:
- When the start date and time of the promotion have not yet reached, the promotion is considered to be in ‘Not Started’ state and you will be allowed to edit the promotion details other than the Rule Type, Action Type, and Promotion Type.
- When the start date and time of the promotion has reached, the promotion is considered to be in ‘In-Progress’ state and you will be allowed to edit only the End Date and time, Description, Additional Information, and Status. Also, you can create additional promo codes.
- When the end date and time of the promotion have reached, the promotion is considered to be in ‘Expired’ state and you will not be allowed to edit any of its details.
Deleting a Promotion
You can delete a particular promotion; however, its status must be ‘Inactive’.
To delete a promotion,
1. Go to the Promotion Groups’ home page.
2. Click of a particular promotion.
Note: Ensure that the status is ‘Inactive’.
3. Click OK to confirm deletion.
Note: The process of deleting a promotion is irreversible.
Cloning a Promotion
Overview
You can clone a promotion belonging to a promotion group or promotion schedule that has not started, in-progress, or has expired. A promotion can be cloned within another promotion group that has not started or is in progress. Promotions cannot be cloned within a promotion group that has expired.
While cloning, you can associate a promotion to any promotion group. This avoids recreating a promotion completely, thus saving time. Once cloned, you can make necessary changes except to ‘Rule Type’ and ‘Action Type’ where the existing values will be retained. In the General page, you can edit the conditions and generate promo codes if required.
For steps on cloning the existing promotion, see the section How to Clone a Promotion.
Note:
- If the status of the promotion that you are going to clone is ‘Active’, the status will be automatically changed to ‘Inactive’ in the cloned promotion. You can change the status to ‘Active’ if required.
- The promo codes in the source promotion will NOT be cloned.
The following table describes when cloning is allowed:
How to Clone a Promotion
To clone a promotion,
1. In the Promotion’s summary page, click :
2. Select the promotion group where you want the cloned promotion to be available.
Note:
- Only the ‘Not Started’ and ‘Started’ promotion groups will be listed in the ‘Promotion Group’ dropdown list.
- In the Promotion Store, the value will be Master Catalog by default.
3. Make necessary changes to the cloned promotion.
Note: You cannot edit rule type and action type.
4. Click .
5. In the Summary page, click Edit to generate new promo codes, modify the existing conditions and actions if required.
Managing the Existing Promotion Groups
You can manage the existing promotion groups. In the Promotion’s home page, you can:
- create a new promotion group
- backdate a particular promotion group’s start and end dates when it is not yet started
- clone a promotion when a promotion group has been started and in-progress
- view summary of an existing promotion group or edit an existing promotion group
- delete a promotion group
Viewing or Editing a Promotion Group – Summary Tab
To view/edit a promotion group,
1. In the Promotions Home page, click of a particular promotion group. The Summary page of the promotion group will be displayed as shown below:
Note: If there are no promotions created in the group, the message There are no promotions created yet. will be displayed.
2. In the Summary page, you can:
- view the existing promotions
- create a new promotion
- delete a promotion
- view the details of the promotion
3. Click General in the left pane.
4. Edit the required details as shown in the screen below:
Note: For pre-poning a date in a particular existing promotion group when it is not yet started, see Backdating an Existing Promotion Group’s Start/End Dates.
5. Click to save the changes.
Backdating an Existing Promotion Group’s Start/End Dates
You can backdate a created promotion group when the promotion group has not yet started. Also, you can backdate a promotion within the boundary of the promotion group.
Scenario: For example, the current date is 30th May 2017 and the promotion group has a future start date as 3rd June 2017 and end date as 5th June 2017. Since the promotion group has not yet started, you can pre-pone the start date/time and/or end date/time until the current date/time.
Restrictions in Editing a Promotion Group
There are certain limitations while editing a promotion group. The limitations are as follows:
- When the start date and time of the promotion group have not reached, the promotion group is considered to be in ‘Not Started’ state and you will be allowed to edit all details of the Promotion Group.
- When the start date and time of the promotion group have reached, the promotion group is considered to be in ‘In Progress’ state and you will be allowed to edit only the End Date and time, and Status. Also, you can create a new promotion or clone the existing promotions.
- When the end date and time of the promotion group have reached, the promotion group is considered to be in ‘Expired’ state and you will not be allowed to edit any of its details.
Deleting a Promotion Group
You can delete a particular promotion group; however, its status must be ‘Inactive’ and all the promotions in the promotion group must also be in ‘Inactive’ state.
To delete a promotion group,
1. Go to the Promotion’s home page.
2. Click on a particular promotion group.
Note: Ensure that the status is ‘Inactive’ and all promotions in the promotion group must also be in ‘Inactive’ state.
3. Click OK to confirm the deletion.
Note: The process of deleting a promotion group is irreversible.
Managing Lists
In the List tab, you can upload multiple values to a list that is associated to specific operands. After creating a list, you can add the required list(s) in promotion group, promotion, and/or action’s conditions. For more information, see Adding List to a Condition. While setting a rule, you can select the list for the specific operands and operators ‘in‘ and ‘not in‘. To add necessary privileges to manage lists, see Promotion Privileges.
In the Lists page, you can create a new list, view/edit the existing list, and/or delete a particular list.
Note: This list can be edited even when a promotion has started.
To create a new list,
1. Click the List tab which appears next to the Promotion tab.
This opens the List page:
2. In the List page, click .
The following Create List page opens:
3. Enter a unique name for the list.
4. In Field, associate the list with a particular operand.
5. Assign the status of the list as Active or Inactive.
Note: Only the list(s) with Active status appears in the conditions.
6. Click to upload the list of items containing value operands via .txt
or .csv
format file.
This uploads the items containing operand values to the list.
7. Click .
The saved list appears on the List page.
Note:
- To view a particular list, click .
- To clear the existing items, click a particular and click .
- To upload the list again, click a particular and click .
- To download an existing list to your local computer, click a particular and click .
- To delete a particular list, click .
- Viewing the Previous Versions
The promotion version denotes the history of the promotion group or promotion. When you edit the existing promotion group or promotion, the old version is saved and a new version is created. To use Promotions’ Version, you need to add the /loadversions
privilege to the role.
On clicking the Versions button, you can view the previous versions:
Defined Roles for Accessing Promotions
This section provides defined roles and the associated privileges to access the Promotion service:
- Defined roles for viewer
- Defined roles for manager
Defined Role for Viewer
Privilege | Description |
/viewpromotiontab |
To view the Promotion tab in the left-navigation panel. On clicking on this tab, enables the user to navigate to the Promotion home page. |
/loadpromotiongroup |
To view all the promotion groups. |
/loadpromotiongroupbyid |
To view all the promotion groups based on the identifier. |
/loadpromotion |
To view all the promotions. |
/loadpromotionbyid |
To view all the promotions based on the identifier. |
/loadpromotionslists |
To view all the lists |
/loadpromotionslistsbyid |
To view all the lists based on the identifier |
/getruleenginemodel |
It is used to retrieve the common filter configuration and promotion configuration (like Rule Type, Action Type, etc.) from ZooKeeper properties. |
/loadversions |
To use promotions’ version, which denotes the history of promotion group or promotion. |
/downloadpromotioncode |
To download the CSV format file containing all the promotion codes into your local computer. |
Defined Role for Manager
Privilege | Description |
/viewpromotiontab |
To view the Promotion tab in the left-navigation panel. On clicking on this tab, enables the user to navigate to the Promotion home page. |
/loadpromotiongroup |
To view all the promotion groups. |
/loadpromotiongroupbyid |
To view all the promotion groups based on the identifier. |
/loadpromotion |
To view all the promotions. |
/loadpromotionbyid |
To view all the promotions based on the identifier. |
/loadpromotionslists |
To view all the lists |
/loadpromotionslistsbyid |
To view all the lists based on the identifier |
/getruleenginemodel |
It is used to retrieve the common filter configuration and promotion configuration (like Rule Type, Action Type, etc.) from ZooKeeper properties. |
/loadversions |
To use promotions’ version, which denotes the history of promotion group or promotion. |
/downloadpromotioncode |
To download the CSV format file containing all the promotion codes into your local computer. |
/generatepromotioncode |
To generate multiple unique promo codes |
/validatepromotioncode |
To check the availability of promotion code |
/createpromotionslists |
To create a new list |
/updatepromotionslists |
To update the existing list |
/deletepromotionslists |
To delete a list |
/downloadpromotionslists |
To download a list containing items to your local computer |
/directcreatepromotiongroup |
To create promotion groups directly without going through the workflow for approval. Any changes made will become live content. |
/directupdatepromotiongroup |
To update promotion groups directly without going through the workflow for approval. Any changes made will become live content. |
/directcreatepromotion |
To create promotions directly without going through the workflow for approval. Any changes made will become live content. |
/directupdatepromotion |
To update promotions directly without going through the workflow for approval. Any changes made will become live content. |
/deletepromotiongroup |
To delete a particular promotion group |
/deletepromotion |
To delete a particular promotion |
Promotion Use Case
Introduction
Overview
This section describes how to create various promotion rules. The following promotion rules are explained here:
- Setting an offer on item’s price
- Setting a Buy X Get Y offer
- Setting a gift with purchase offer
- Setting an offer on item’s shipping
- Setting an offer on cart’s price
- Setting an offer on cart’s shipping
Promotion Rules
The following sections explain how to set up different types of promotions.
Setting an Offer on Item’s Price
You can set up an offer for an item on its price, by selecting the Rule Type as Item Price Rules. You can also select if the offer should be a fixed offer, a currency offer or a percentage offer in Action Type. Here the item can be a product, a category or an SKU.
For example, consider a product X that has a price of 10 $ and you need to provide an offer on its price. If the action type is:
- Fixed Offer and the offer value is set as 7 $, then the product will be available for 7 $.
Note: The offer value set will be the sale price of the item. - Currency Offer and the offer value is set as 2$, then the product will be available for 8 $.
Note: The offer value set will be a discount on the original price. - % Offer and the offer value is set as 25, then the product will be available for 7.5 $.
Note: The offer value set will be a percentage discount on the original price.
To setup an offer on item’s price, follow the steps below:
1. Create a promotion by entering the required information such as name, description, additional description, start and end dates.
2. In Rule Type dropdown select the Item Price Rule.
3. In Action Type, select the required action type (Fixed Offer/ Currency Offer/ % Offer).
4. Click Save to add the promotion to the promotion group.
5. Click Conditions to add conditions.
Note: Ensure that you create a condition that selects the appropriate product for which the offer has to be applied to.
Examples:
If you want to apply offer on a product with product ID as 761482, set up a condition as follows:
![Creating Conditions with Product](https://duseqpxtuo98y.cloudfront.net/guide-promotion/usecase-promotion/image_0.png)
If you want to apply offer on all products under a category with category ID as 3D2255956, set up a condition as follows:
Note: You can configure your conditions as required with product, category or SKU.
6. Click Promocodes to add promo codes, when this promotion needs to be applied only when a promo code is applied. For more details on creating promocodes, refer to Adding Promocodes to the Promotion section.
7. Click Actions to create actions. Multiple actions can be created. For more details on action creation, refer to Creating Actions to a Promotion section.
Note:
- While creating actions, ensure that Offer Type is selected as Product Price and provide the offer value in the offer value field.
- If multiple actions are to be created, make sure you give the conditions appropriately. For example, if you are planning for 50% offer on item price for Platinum users and 30% for Gold users, then you need to create two actions with different offer values and conditions as shown below:
Setting a Buy X Get Y Offer
You can set up Buy X Get Y offer, by selecting the Rule Type as BOGO. You can also select if the offer should be a fixed offer, a currency offer or a percentage offer in Action Type. Here the item can be a product, a category or a SKU.
For example, consider a product X that has a price of 10 $ and a product Y with price as 5 $ and we need to setup an offer where you buy the Product X and get an offer on the Product Y. If the action type is:
- Fixed Offer and the offer value is set as 3 $, then the product Y will be available for 3 $.
Note: The offer value set will be the price of the item Y. - Currency Offer and the offer value is set as 1 $, then the product Y will be available for 4 $.
Note: The offer value set will be a discount on the original price of item Y. - % Offer and the offer value is set as 100, then the product Y will be available for free.
Note: The offer value set will be a percentage discount on the original price of item Y.
To setup a Buy X Get Y offer, follow the steps below:
1. Create a promotion by entering the required information such as name, description, additional description, start and end dates.
2. In Rule Type dropdown select the BOGO Rule.
3. In Action Type, select the required action type (Fixed Offer/ Currency Offer/ % Offer).
4. Click Save to add the promotion to the promotion group.
5. Click Conditions to add conditions.
Note: Ensure that you create a condition that selects the appropriate product for which the offer has to be applied to.
Examples:
- If you want to apply offer on a product with product ID as 761482, set up a condition as follows:
- If you want to apply offer on all products under a category with category ID as 3D2255956, set up a condition as follows:
Note: You can configure your conditions as required with a product, category or SKU.
6. Click Promocodes to add promo codes, when this promotion needs to be applied only when a promo code is applied. For more details on creating promocodes, refer to Adding Promocodes to the Promotion in the Promotions_User_Guide_v1.0.
7. Click Actions to create actions. Multiple actions can be created. For more details on action creation, refer to Creating Actions to a Promotion section in the Promotions_User_Guide_v1.0.
Note: While creating actions, ensure that Offer Type is selected as Buy X Get Y.
- You must select the Buy Item Type (Category/ Product/ SKU) and provide its ID in Buy Item ID and quantity in Buy Item Quantity.
Note: Make sure the condition also has the condition that matches the provided Buy Item Type and Buy Item ID - You must select the Get Item Type (Category/ Product/ SKU) and provide its ID in Get Item ID and quantity in Get Item Quantity.
- If multiple actions are to be created, make sure you give the conditions appropriately. For example, if you are planning for giving item Y for 5 $ for Platinum users and 8 $ for Silver users, then you need to create two actions with different offer values and conditions as shown below:
Setting a Gift with Purchase Offer
Gift with Purchase is a variation of BOGO and the only difference is, you get the Get Item for Free. You can set up a Gift with Purchase offer, by selecting the Rule Type as BOGO and select the offer type as GWP.
Setting an Offer on Item’s Shipping
You can set up offer for an item on its shipping price, by selecting the Rule Type as Item Shipping Rules. You can also select if the offer should be a fixed offer, a currency offer or a percentage offer in Action Type. Here the item can be a product, a category or a SKU.
For example, consider a product X that has a shipping price of 10 $ and you need to provide an offer on its shipping price. If the action type is:
- Fixed Offerand the offer value is set as 5 $, then the product’s shipping price will be 5 $.
Note: The offer value set will be the shipping price of the item. - Currency Offer and the offer value is set as 3 $, then the product’s shipping price will be 7 $.
Note: The offer value set will be a discount on the original shipping price. - % Offer and the offer value is set as 25, the product will be shipped for 7.5 $.
Note: The offer value set will be a percentage discount on the original shipping price.
To set up an offer on item’s price, follow the steps below:
1. Create a promotion by entering the required information such as name, description, additional description, start and end dates.
2. In Rule Type dropdown select the Item Shipping Rules.
3. In Action Type, select the required action type (Fixed Offer/ Currency Offer/ % Offer).
4. Click Save to add the promotion to the promotion group.
5. Click Conditions to add conditions.
Note: Ensure that you create a condition that selects the appropriate product for which the offer has to be applied to.
Examples:
- If you want to apply offer on a product with product ID as 761482, set up a condition as follows:
- If you want to apply offer on all products under a category with category ID as 3D2255956, set up a condition as follows:
Note: You can configure your conditions as required with a product, category or SKU.
6. Click Promocodes to add promo codes, when this promotion needs to be applied only when a promo code is applied. For more details on creating promocodes, refer to Adding Promocodes to the Promotion in the Promotions_User_Guide_v1.0.
7. Click Actions to create actions. Multiple actions can be created. For more details on action creation, refer to Creating Actions to a Promotion section in the Promotions_User_Guide_v1.0.
Note:
- While creating actions, ensure that Offer Type is selected as Product Shipping Offer and provide the offer value in the offer value field.
- If multiple actions are to be created, make sure you give the conditions appropriately. For example, if you are planning for an offer on item shipping price at 5 $ for item shipped to Arizona and 10 $ for item shipped to Georgia, then you need to create two actions with different offer values and conditions as shown below:
Setting an Offer on Cart’s Price
You can set up offer for an order on its cart’s price, by selecting the Rule Type as Cart Price Rules. You can also select if the offer should be a fixed offer, a currency offer or a percentage offer in Action Type. Here the item can be a product, a category or an SKU.
For example, consider an order that has a total cart price of 100 $ and you need to provide an offer on its price. If the action type is:
- Fixed Offer and the offer value is set as 90 $, then the order will be available for $90.
Note: The offer value set will be the sale price of the order (cart). - Currency Offer and the offer value is set as 15$, then the order will be available for $85.
Note: The offer value set will be a discount on the original cart price. - % Offer and the offer value is set as 5, then the order will be available for $95.
Note: The offer value set will be a percentage discount on the original cart price.
To setup an offer on the cart’s price, follow the steps below:
1. Create a promotion by entering the required information such as name, description, additional description, start and end dates.
2. In Rule Type dropdown select the Cart Price Rules.
3. In Action Type, select the required action type (Fixed Offer/ Currency Offer/ % Offer).
4. Click Save to add the promotion to the promotion group.
5. Click Conditions to add conditions.
Note: Ensure that you create a condition that selects the appropriate product for which the offer has to be applied to.
Examples:
- If you want to apply offer on the cart with cart value between 100 $ and 110 $, set up a condition as follows:
6. Click Promocodes to add promo codes, when this promotion needs to be applied only when a promo code is applied. For more details on creating promocodes, refer to Adding Promocodes to the Promotion in the Promotions_User_Guide_v1.0.
7. Click Actions to create actions. Multiple actions can be created. For more details on action creation, refer to Creating Actions to a Promotion section in the Promotions_User_Guide_v1.0.
Note:
- While creating actions, ensure that Offer Type is selected as Cart Price Offer and provide the offer value in the offer value field.
- If multiple actions are to be created, make sure you give the conditions appropriately. For example, when the cart price is between 100 $ and 110 $, if you want to provide an offer for cart price at 90 $ for Platinum users and 93 $ for Gold users, then you need to create two actions with different offer values and conditions as shown below:
Setting an Offer on Cart’s Shipping
You can set up an offer for an order on its cart’s shipping price, by selecting the Rule Type as Cart Shipping Rules. You can also select if the offer should be a fixed offer, a currency offer or a percentage offer in Action Type. Here the item can be a product, a category or an SKU.
For example, consider an order that has its cart shipping price of 10 $ and you need to provide an offer on its shipping price. If the action type is:
- Fixed Offer and the offer value is set as $7, the order will be shipped for $7.
Note: The offer value set will be the shipping price of the item. - Currency Offer and the offer value is set as $4, the order will be shipped for $6.
Note: The offer value set will be a discount on the original shipping price. - % Offer and the offer value is set as 25, the order will be shipped for $7.5.
Note: The offer value set will be a percentage discount on the original shipping price.
To set up an offer on the cart’s price, follow the steps below:
1. Create a promotion by entering the required information such as name, description, additional description, start and end dates.
2. In Rule Type dropdown select the Cart Shipping Rules.
3. In Action Type, select the required action type (Fixed Offer/ Currency Offer/ % Offer).
4. Click Save to add the promotion to the promotion group.
5. Click Conditions to add conditions.
Note: Ensure that you create a condition that selects the appropriate product for which the offer has to be applied to.
Examples:
- If you want to apply offer on the cart when the cart value is greater than 200 $, set up a condition as follows:
6. Click Promocodes to add promo codes, when this promotion needs to be applied only when a promo code is applied. For more details on creating promocodes, refer to Adding Promocodes to the Promotion in the Promotions User Guide.
7. Click Actions to create actions. Multiple actions can be created. For more details on action creation, refer to Creating Actions to a Promotion section in the Promotions User Guide.
Note:
- While creating actions, ensure that Offer Type is selected as Cart Shipping Offer and provide the offer value in the offer value field.
- If multiple actions are to be created, make sure you give the conditions appropriately. For example, to provide an offer on cart shipping price when the cart value is greater than 200; to ship at $5 to Arizona and $10 to Georgia, then you need to create two actions with different offer values and conditions as shown below:
Revision History
2020-03-30 | AM – Minor copyedit.
2019-06-24 | PLK – Content uploaded.
2019-06-15 | PLK – Page created.