The following table describes the collection properties for the Promotions microservice.

S. No.AttributeDefault ValueDescription
1applicablelocalesen_USIndicates the list of locales applicable to the collection. It contains a list of comma separated locales. For the possible locales, refer to the Java standard locale format.
2blockExpireTime300000Indicates the time till which a promo code is blocked in milliseconds.
3customConditionAttributesIndicates the custom condition model attributes.
4defaultlocaleen_USIndicates the default locale of the collection.
5enablePreviewfalseIndicates the promotions are enabled for preview or not. The possible value are true or false.
6executionOrder{\"item\":{\"actionsOrder\":[{\"name\":\"itemPrice\",\"value\":1},{\"name\":\"bogo\",\"value\":2},{\"name\":\"itemShipping\",\"value\":3}]},\"cart\":{\"actionsOrder\":[{\"name\":\"cartPrice\",\"value\":4},{\"name\":\"cartShipping\",\"value\":5}]}}Indicates the the order of execution of various order types.
7overAllRoundOffType0Indicates the round off type for promotion calculations.
8promoActionProcessorClasscom.skava.promotion.ecomm.rule.process.EcommPromotionActionProcessorIndicates the class for implementation of promotion action processor.
9promoRuleProcessorClasscom.skava.promotion.ecomm.rule.process.EcommPromotionRuleProcessorIndicates the class for implementation of promotion rule processor.
10promotionPropertynullIndicates the additional properties to be defined based on the business need. For example, couponIdentifier.
11ruleengine.settings{\"groupRuleTypes\":[{\"displayName\":\"Default\",\"name\":\"default\",\"value\":1,\"stopConditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"}],\"ruleTypes\":[{\"displayName\":\"Item Price Rules\",\"description\":\"Promotion applied on Item Price.\",\"name\":\"itemPrice\",\"value\":1,\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionCoupon,com.skava.promotion.ecomm.model.PromotionCart\",\"stopConditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\",\"actionTypes\":[{\"displayName\":\"Fixed Offer\",\"description\":\"Item provided at Fixed Amount\",\"value\":1,\"actions\":[{\"name\":\"Product Price Offer\",\"description\":\"Promotion applied on Product Price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductPriceOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"purchaseType\",\"displayName\":\"Purchase Type\",\"type\":\"select\",\"options\":[{\"name\":\"batchPurchase\",\"displayName\":\"Batch Purchase Quantity\",\"description\":\"Offer applied to batches of specified quantity of the product added to the cart. Ex: Get 10$ offer when you buy 4 pairs of socks. When 4 Pairs of Socks is added to cart then 10$ discount is applied. When 9 Pairs of socks is added to cart then 20$ discount is applied and remaining 1 pair of socks is provided without discount.\"},{\"name\":\"minPurchase\",\"displayName\":\"Minimum Purchase Quantity\",\"description\":\"Offer applied to the product only when the minimum quantity specified is added to the cart. Ex: Get 10% offer when you buy a minimum of 4 pairs of Socks. When 3 pairs of socks is added to cart then no discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 or more Pairs of socks is added to cart then 10% discount will be applied for 5 or all pairs of socks.\"},{\"name\":\"maxPurchase\",\"displayName\":\"Maximum Purchase Quantity\",\"description\":\"Offer applied only to the maximum specified quantity of the product which is added to the cart. Ex: Get 10% offer for maximum 4 pairs of socks per order. When 3 pairs of socks is added to cart then 10% discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 Pairs of socks is added to cart then 10% discount is applied and remaining 1 pair of socks is provided without discount.\"}]},{\"name\":\"purchaseQty\",\"displayName\":\"Purchase Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"offerValue\",\"displayName\":\"@ Amount\"}]},{\"name\":\"Product Personalization\",\"description\":\"Promotion applied on Product Personalization Price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductPersonalizationOffer\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"personalizationType\",\"displayName\":\"Personalization Type\"},{\"name\":\"offerValue\",\"displayName\":\"@ Amount\"}]}]},{\"displayName\":\"Amount Offer\",\"description\":\"Item provided at Discounted Amount\",\"value\":2,\"actions\":[{\"name\":\"Product Price Offer\",\"description\":\"Promotion applied on Product Price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductPriceOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"purchaseType\",\"displayName\":\"Purchase Type\",\"type\":\"select\",\"options\":[{\"name\":\"batchPurchase\",\"displayName\":\"Batch Purchase Quantity\",\"description\":\"Offer applied to batches of specified quantity of the product added to the cart. Ex: Get 10$ offer when you buy 4 pairs of socks. When 4 Pairs of Socks is added to cart then 10$ discount is applied. When 9 Pairs of socks is added to cart then 20$ discount is applied and remaining 1 pair of socks is provided without discount.\"},{\"name\":\"minPurchase\",\"displayName\":\"Minimum Purchase Quantity\",\"description\":\"Offer applied to the product only when the minimum quantity specified is added to the cart. Ex: Get 10% offer when you buy a minimum of 4 pairs of Socks. When 3 pairs of socks is added to cart then no discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 or more Pairs of socks is added to cart then 10% discount will be applied for 5 or all pairs of socks.\"},{\"name\":\"maxPurchase\",\"displayName\":\"Maximum Purchase Quantity\",\"description\":\"Offer applied only to the maximum specified quantity of the product which is added to the cart. Ex: Get 10% offer for maximum 4 pairs of socks per order. When 3 pairs of socks is added to cart then 10% discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 Pairs of socks is added to cart then 10% discount is applied and remaining 1 pair of socks is provided without discount.\"}]},{\"name\":\"purchaseQty\",\"displayName\":\"Purchase Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"offerValue\",\"displayName\":\"Offer Amount\"}]},{\"name\":\"Product Personalization\",\"description\":\"Promotion applied on Product Personalization Price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductPersonalizationOffer\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"personalizationType\",\"displayName\":\"Personalization Type\"},{\"name\":\"offerValue\",\"displayName\":\"Offer Amount\"}]}]},{\"displayName\":\"% Offer\",\"description\":\"Item provided at Percentage Discounted Amount\",\"value\":3,\"actions\":[{\"name\":\"Product Price Offer\",\"description\":\"Promotion applied on Product Price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductPriceOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"purchaseType\",\"displayName\":\"Purchase Type\",\"type\":\"select\",\"options\":[{\"name\":\"batchPurchase\",\"displayName\":\"Batch Purchase Quantity\",\"description\":\"Offer applied to batches of specified quantity of the product added to the cart. Ex: Get 10$ offer when you buy 4 pairs of socks. When 4 Pairs of Socks is added to cart then 10$ discount is applied. When 9 Pairs of socks is added to cart then 20$ discount is applied and remaining 1 pair of socks is provided without discount.\"},{\"name\":\"minPurchase\",\"displayName\":\"Minimum Purchase Quantity\",\"description\":\"Offer applied to the product only when the minimum quantity specified is added to the cart. Ex: Get 10% offer when you buy a minimum of 4 pairs of Socks. When 3 pairs of socks is added to cart then no discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 or more Pairs of socks is added to cart then 10% discount will be applied for 5 or all pairs of socks.\"},{\"name\":\"maxPurchase\",\"displayName\":\"Maximum Purchase Quantity\",\"description\":\"Offer applied only to the maximum specified quantity of the product which is added to the cart. Ex: Get 10% offer for maximum 4 pairs of socks per order. When 3 pairs of socks is added to cart then 10% discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 Pairs of socks is added to cart then 10% discount is applied and remaining 1 pair of socks is provided without discount.\"}]},{\"name\":\"purchaseQty\",\"displayName\":\"Purchase Quantity\"},{\"name\":\"offerValue\",\"displayName\":\"% Offer\"}]},{\"name\":\"Product Personalization\",\"description\":\"Promotion applied on Product Personalization Price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductPersonalizationOffer\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"personalizationType\",\"displayName\":\"Personalization Type\"},{\"name\":\"offerValue\",\"displayName\":\"% Offer\"}]}]},{\"displayName\":\"Formula\",\"description\":\"Item provided at Formula Based Discounted Amount\",\"value\":4,\"actions\":[{\"name\":\"Product Price Offer\",\"description\":\"Promotion applied on Product Price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductPriceOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"formulaClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\",\"params\":[{\"name\":\"purchaseType\",\"displayName\":\"Purchase Type\",\"type\":\"select\",\"options\":[{\"name\":\"batchPurchase\",\"displayName\":\"Batch Purchase Quantity\",\"description\":\"Offer applied to batches of specified quantity of the product added to the cart. Ex: Get 10$ offer when you buy 4 pairs of socks. When 4 Pairs of Socks is added to cart then 10$ discount is applied. When 9 Pairs of socks is added to cart then 20$ discount is applied and remaining 1 pair of socks is provided without discount.\"},{\"name\":\"minPurchase\",\"displayName\":\"Minimum Purchase Quantity\",\"description\":\"Offer applied to the product only when the minimum quantity specified is added to the cart. Ex: Get 10% offer when you buy a minimum of 4 pairs of Socks. When 3 pairs of socks is added to cart then no discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 or more Pairs of socks is added to cart then 10% discount will be applied for 5 or all pairs of socks.\"},{\"name\":\"maxPurchase\",\"displayName\":\"Maximum Purchase Quantity\",\"description\":\"Offer applied only to the maximum specified quantity of the product which is added to the cart. Ex: Get 10% offer for maximum 4 pairs of socks per order. When 3 pairs of socks is added to cart then 10% discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 Pairs of socks is added to cart then 10% discount is applied and remaining 1 pair of socks is provided without discount.\"}]},{\"name\":\"purchaseQty\",\"displayName\":\"Purchase Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"formula\",\"displayName\":\"Formula\"}]},{\"name\":\"Product Personalization\",\"description\":\"Promotion applied on Product Personalization Price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductPersonalizationOffer\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"formulaClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\",\"params\":[{\"name\":\"personalizationType\",\"displayName\":\"Personalization Type\"},{\"name\":\"formula\",\"displayName\":\"Formula\"}]}]}]},{\"displayName\":\"BOGO Rules\",\"description\":\"Promotion applied on Get Item Price on a BOGO.\",\"name\":\"bogo\",\"value\":2,\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionCoupon,com.skava.promotion.ecomm.model.PromotionCart\",\"stopConditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\",\"actionTypes\":[{\"displayName\":\"Fixed Offer\",\"description\":\"Item provided at Fixed Amount\",\"value\":1,\"actions\":[{\"name\":\"Buy X Get Y\",\"description\":\"BOGO Promotions. Promotion applied on Get Item Price.\",\"className\":\"com.skava.promotion.ecomm.action.BuyXGetY\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"buyItemCondition\",\"displayName\":\"Buy Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"buyItemQty\",\"displayName\":\"Buy Item Quantity\"},{\"name\":\"getItemCondition\",\"displayName\":\"Get Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"getItemQty\",\"displayName\":\"Get Item Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"offerValue\",\"displayName\":\"@ Amount\"}]},{\"name\":\"GWP\",\"description\":\"Gift With Purchase.\",\"className\":\"com.skava.promotion.ecomm.action.GiftWithPurchase\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"buyItemCondition\",\"displayName\":\"Buy Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"buyItemQty\",\"displayName\":\"Buy Item Quantity\"},{\"name\":\"giftProductId\",\"displayName\":\"Gift Product Id\"},{\"name\":\"giftSkuId\",\"displayName\":\"Gift Sku Id\"}]},{\"name\":\"Buy X and Y\",\"description\":\"BOGO Promotions. Buy X and Y together and get Offer on X and Y.\",\"className\":\"com.skava.promotion.ecomm.action.BuyXandY\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"xItemBuyCondition\",\"displayName\":\"Buy X Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"xItemBuyQty\",\"displayName\":\"Buy X Item Quantity\"},{\"name\":\"yItemBuyCondition\",\"displayName\":\"Buy Y Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"yItemBuyQty\",\"displayName\":\"Buy Y Item Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"offerValue\",\"displayName\":\"@ Amount\"}]}]},{\"displayName\":\"Amount Offer\",\"description\":\"Item provided at Discounted Amount\",\"value\":2,\"actions\":[{\"name\":\"Buy X Get Y\",\"description\":\"BOGO Promotions. Promotion applied on Get Item Price.\",\"className\":\"com.skava.promotion.ecomm.action.BuyXGetY\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"buyItemCondition\",\"displayName\":\"Buy Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"buyItemQty\",\"displayName\":\"Buy Item Quantity\"},{\"name\":\"getItemCondition\",\"displayName\":\"Get Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"getItemQty\",\"displayName\":\"Get Item Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"offerValue\",\"displayName\":\"Offer Amount\"}]},{\"name\":\"GWP\",\"description\":\"Gift With Purchase.\",\"className\":\"com.skava.promotion.ecomm.action.GiftWithPurchase\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"buyItemCondition\",\"displayName\":\"Buy Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"buyItemQty\",\"displayName\":\"Buy Item Quantity\"},{\"name\":\"getItemCondition\",\"displayName\":\"condition\"},{\"name\":\"getItemQty\",\"displayName\":\"Get Item Quantity\"}]},{\"name\":\"Buy X and Y\",\"description\":\"BOGO Promotions. Buy X and Y together and get Offer on X and Y.\",\"className\":\"com.skava.promotion.ecomm.action.BuyXandY\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"xItemBuyCondition\",\"displayName\":\"Buy X Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"xItemBuyQty\",\"displayName\":\"Buy X Item Quantity\"},{\"name\":\"yItemBuyCondition\",\"displayName\":\"Buy Y Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"yItemBuyQty\",\"displayName\":\"Buy Y Item Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"offerValue\",\"displayName\":\"Offer Amount\"}]}]},{\"displayName\":\"% Offer\",\"description\":\"Item provided at Percentage Discounted Amount\",\"value\":3,\"actions\":[{\"name\":\"Buy X Get Y\",\"description\":\"BOGO Promotions. Promotion applied on Get Item Price.\",\"className\":\"com.skava.promotion.ecomm.action.BuyXGetY\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"buyItemCondition\",\"displayName\":\"Buy Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"buyItemQty\",\"displayName\":\"Buy Item Quantity\"},{\"name\":\"getItemCondition\",\"displayName\":\"Get Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"getItemQty\",\"displayName\":\"Get Item Quantity\"},{\"name\":\"offerValue\",\"displayName\":\"% Offer\"}]},{\"name\":\"GWP\",\"description\":\"Gift With Purchase.\",\"className\":\"com.skava.promotion.ecomm.action.GiftWithPurchase\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"buyItemCondition\",\"displayName\":\"Buy Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"buyItemQty\",\"displayName\":\"Buy Item Quantity\"},{\"name\":\"giftProductId\",\"displayName\":\"Gift Product Id\"},{\"name\":\"giftSkuId\",\"displayName\":\"Gift Sku Id\"}]},{\"name\":\"Buy X and Y\",\"description\":\"BOGO Promotions. Buy X and Y together and get Offer on X and Y.\",\"className\":\"com.skava.promotion.ecomm.action.BuyXandY\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"xItemBuyCondition\",\"displayName\":\"Buy X Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"xItemBuyQty\",\"displayName\":\"Buy X Item Quantity\"},{\"name\":\"yItemBuyCondition\",\"displayName\":\"Buy Y Item Condition\",\"type\":\"condition\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\"},{\"name\":\"yItemBuyQty\",\"displayName\":\"Buy Y Item Quantity\"},{\"name\":\"offerValue\",\"displayName\":\"% Offer\"}]}]}]},{\"displayName\":\"Item Shipping Rules\",\"description\":\"Promotion applied on Item Shipping Price.\",\"name\":\"itemShipping\",\"value\":3,\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionCoupon,com.skava.promotion.ecomm.model.PromotionCart\",\"stopConditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\",\"actionTypes\":[{\"displayName\":\"Fixed Offer\",\"description\":\"Item provided at Fixed Shipping Amount\",\"value\":1,\"actions\":[{\"name\":\"Product Shipping Offer\",\"description\":\"Promotion applied on the product shipping price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductShippingOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"purchaseType\",\"displayName\":\"Purchase Type\",\"type\":\"select\",\"options\":[{\"name\":\"batchPurchase\",\"displayName\":\"Batch Purchase Quantity\",\"description\":\"Offer applied to batches of specified quantity of the product added to the cart. Ex: Get 10$ offer when you buy 4 pairs of socks. When 4 Pairs of Socks is added to cart then 10$ discount is applied. When 9 Pairs of socks is added to cart then 20$ discount is applied and remaining 1 pair of socks is provided without discount.\"},{\"name\":\"minPurchase\",\"displayName\":\"Minimum Purchase Quantity\",\"description\":\"Offer applied to the product only when the minimum quantity specified is added to the cart. Ex: Get 10% offer when you buy a minimum of 4 pairs of Socks. When 3 pairs of socks is added to cart then no discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 or more Pairs of socks is added to cart then 10% discount will be applied for 5 or all pairs of socks.\"},{\"name\":\"maxPurchase\",\"displayName\":\"Maximum Purchase Quantity\",\"description\":\"Offer applied only to the maximum specified quantity of the product which is added to the cart. Ex: Get 10% offer for maximum 4 pairs of socks per order. When 3 pairs of socks is added to cart then 10% discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 Pairs of socks is added to cart then 10% discount is applied and remaining 1 pair of socks is provided without discount.\"}]},{\"name\":\"purchaseQty\",\"displayName\":\"Purchase Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"offerValue\",\"displayName\":\"@ Amount\"}]}]},{\"displayName\":\"Amount Offer\",\"description\":\"Item provided at Discounted Shipping Amount\",\"value\":2,\"actions\":[{\"name\":\"Product Shipping Offer\",\"description\":\"Promotion applied on the product shipping price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductShippingOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"purchaseType\",\"displayName\":\"Purchase Type\",\"type\":\"select\",\"options\":[{\"name\":\"batchPurchase\",\"displayName\":\"Batch Purchase Quantity\",\"description\":\"Offer applied to batches of specified quantity of the product added to the cart. Ex: Get 10$ offer when you buy 4 pairs of socks. When 4 Pairs of Socks is added to cart then 10$ discount is applied. When 9 Pairs of socks is added to cart then 20$ discount is applied and remaining 1 pair of socks is provided without discount.\"},{\"name\":\"minPurchase\",\"displayName\":\"Minimum Purchase Quantity\",\"description\":\"Offer applied to the product only when the minimum quantity specified is added to the cart. Ex: Get 10% offer when you buy a minimum of 4 pairs of Socks. When 3 pairs of socks is added to cart then no discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 or more Pairs of socks is added to cart then 10% discount will be applied for 5 or all pairs of socks.\"},{\"name\":\"maxPurchase\",\"displayName\":\"Maximum Purchase Quantity\",\"description\":\"Offer applied only to the maximum specified quantity of the product which is added to the cart. Ex: Get 10% offer for maximum 4 pairs of socks per order. When 3 pairs of socks is added to cart then 10% discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 Pairs of socks is added to cart then 10% discount is applied and remaining 1 pair of socks is provided without discount.\"}]},{\"name\":\"purchaseQty\",\"displayName\":\"Purchase Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"offerValue\",\"displayName\":\"Offer Amount\"}]}]},{\"displayName\":\"% Offer\",\"description\":\"Item provided at Percentage Discounted Shipping Amount\",\"value\":3,\"actions\":[{\"name\":\"Product Shipping Offer\",\"description\":\"Promotion applied on the product shipping price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductShippingOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"purchaseType\",\"displayName\":\"Purchase Type\",\"type\":\"select\",\"options\":[{\"name\":\"batchPurchase\",\"displayName\":\"Batch Purchase Quantity\",\"description\":\"Offer applied to batches of specified quantity of the product added to the cart. Ex: Get 10$ offer when you buy 4 pairs of socks. When 4 Pairs of Socks is added to cart then 10$ discount is applied. When 9 Pairs of socks is added to cart then 20$ discount is applied and remaining 1 pair of socks is provided without discount.\"},{\"name\":\"minPurchase\",\"displayName\":\"Minimum Purchase Quantity\",\"description\":\"Offer applied to the product only when the minimum quantity specified is added to the cart. Ex: Get 10% offer when you buy a minimum of 4 pairs of Socks. When 3 pairs of socks is added to cart then no discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 or more Pairs of socks is added to cart then 10% discount will be applied for 5 or all pairs of socks.\"},{\"name\":\"maxPurchase\",\"displayName\":\"Maximum Purchase Quantity\",\"description\":\"Offer applied only to the maximum specified quantity of the product which is added to the cart. Ex: Get 10% offer for maximum 4 pairs of socks per order. When 3 pairs of socks is added to cart then 10% discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 Pairs of socks is added to cart then 10% discount is applied and remaining 1 pair of socks is provided without discount.\"}]},{\"name\":\"purchaseQty\",\"displayName\":\"Purchase Quantity\"},{\"name\":\"offerValue\",\"displayName\":\"% Offer\"}]}]},{\"displayName\":\"Formula\",\"description\":\"Item provided at Formula Based Discounted Shipping Amount\",\"value\":4,\"actions\":[{\"name\":\"Product Shipping Offer\",\"description\":\"Promotion applied on the product shipping price.\",\"className\":\"com.skava.promotion.ecomm.action.ProductShippingOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionSku,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"formulaClasses\":\"com.skava.promotion.ecomm.model.PromotionSku\",\"params\":[{\"name\":\"purchaseType\",\"displayName\":\"Purchase Type\",\"type\":\"select\",\"options\":[{\"name\":\"batchPurchase\",\"displayName\":\"Batch Purchase Quantity\",\"description\":\"Offer applied to batches of specified quantity of the product added to the cart. Ex: Get 10$ offer when you buy 4 pairs of socks. When 4 Pairs of Socks is added to cart then 10$ discount is applied. When 9 Pairs of socks is added to cart then 20$ discount is applied and remaining 1 pair of socks is provided without discount.\"},{\"name\":\"minPurchase\",\"displayName\":\"Minimum Purchase Quantity\",\"description\":\"Offer applied to the product only when the minimum quantity specified is added to the cart. Ex: Get 10% offer when you buy a minimum of 4 pairs of Socks. When 3 pairs of socks is added to cart then no discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 or more Pairs of socks is added to cart then 10% discount will be applied for 5 or all pairs of socks.\"},{\"name\":\"maxPurchase\",\"displayName\":\"Maximum Purchase Quantity\",\"description\":\"Offer applied only to the maximum specified quantity of the product which is added to the cart. Ex: Get 10% offer for maximum 4 pairs of socks per order. When 3 pairs of socks is added to cart then 10% discount is applied. When 4 Pairs of Socks is added to cart then 10% discount is applied. When 5 Pairs of socks is added to cart then 10% discount is applied and remaining 1 pair of socks is provided without discount.\"}]},{\"name\":\"purchaseQty\",\"displayName\":\"Purchase Quantity\"},{\"name\":\"discountType\",\"displayName\":\"Discount Type\",\"type\":\"select\",\"options\":[{\"name\":\"each\",\"displayName\":\"Each Discount\"},{\"name\":\"flat\",\"displayName\":\"Flat Discount\"}]},{\"name\":\"formula\",\"displayName\":\"Formula\"}]}]}]},{\"displayName\":\"Cart Price Rules\",\"description\":\"Promotion applied on Cart Price.\",\"name\":\"cartPrice\",\"value\":4,\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionCoupon\",\"stopConditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart\",\"actionTypes\":[{\"displayName\":\"Fixed Offer\",\"description\":\"Cart provided at Fixed Amount\",\"value\":1,\"actions\":[{\"name\":\"Cart Price Offer\",\"description\":\"Promotion applied on the Cart Price.\",\"className\":\"com.skava.promotion.ecomm.action.CartPriceOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"offerValue\",\"displayName\":\"@ Amount\"}]}]},{\"displayName\":\"Amount Offer\",\"description\":\"Cart provided at Discounted Amount\",\"value\":2,\"actions\":[{\"name\":\"Cart Price Offer\",\"description\":\"Promotion applied on the Cart Price.\",\"className\":\"com.skava.promotion.ecomm.action.CartPriceOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"offerValue\",\"displayName\":\"Offer Amount\"}]},{\"name\":\"Trade In Offer\",\"description\":\"Promotion applied on the Cart Trade In Value.\",\"className\":\"com.skava.promotion.ecomm.action.TradeInOffer\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"offerValue\",\"displayName\":\"Offer Amount\"}]}]},{\"displayName\":\"% Offer\",\"description\":\"Cart provided at Percentage Discounted Amount\",\"value\":3,\"actions\":[{\"name\":\"Cart Price Offer\",\"description\":\"Promotion applied on the Cart Price.\",\"className\":\"com.skava.promotion.ecomm.action.CartPriceOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"offerValue\",\"displayName\":\"% Offer\"}]},{\"name\":\"Trade In Offer\",\"description\":\"Promotion applied on the Cart Trade In Value.\",\"className\":\"com.skava.promotion.ecomm.action.TradeInOffer\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"offerValue\",\"displayName\":\"% Offer\"}]}]},{\"displayName\":\"Formula\",\"description\":\"Cart provided at Formula Based Discounted Amount\",\"value\":4,\"actions\":[{\"name\":\"Cart Price Offer\",\"description\":\"Promotion applied on the Cart Price.\",\"className\":\"com.skava.promotion.ecomm.action.CartPriceOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"formulaClasses\":\"com.skava.promotion.ecomm.model.PromotionCart\",\"params\":[{\"name\":\"formula\",\"displayName\":\"Formula\"}]}]}]},{\"displayName\":\"Cart Shipping Rules\",\"description\":\"Promotion applied on Cart Shipping Price.\",\"name\":\"cartShipping\",\"value\":5,\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionCoupon\",\"stopConditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart\",\"actionTypes\":[{\"displayName\":\"Fixed Offer\",\"description\":\"Cart provided at Fixed Shipping Amount\",\"value\":1,\"actions\":[{\"name\":\"Cart Shipping Offer\",\"description\":\"Promotion applied on the Cart Shipping Price.\",\"className\":\"com.skava.promotion.ecomm.action.CartShippingOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"offerValue\",\"displayName\":\"@ Amount\"}]}]},{\"displayName\":\"Amount Offer\",\"description\":\"Cart provided at Discounted Shipping Amount\",\"value\":2,\"actions\":[{\"name\":\"Cart Shipping Offer\",\"description\":\"Promotion applied on the Cart Shipping Price.\",\"className\":\"com.skava.promotion.ecomm.action.CartShippingOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"offerValue\",\"displayName\":\"Offer Amount\"}]}]},{\"displayName\":\"% Offer\",\"description\":\"Cart provided at Percentage Discounted Shipping Amount\",\"value\":3,\"actions\":[{\"name\":\"Cart Shipping Offer\",\"description\":\"Promotion applied on the Cart Shipping Price.\",\"className\":\"com.skava.promotion.ecomm.action.CartShippingOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"params\":[{\"name\":\"offerValue\",\"displayName\":\"% Offer\"}]}]},{\"displayName\":\"Formula\",\"description\":\"Cart provided at Formula Based Discounted Shipping Amount\",\"value\":4,\"actions\":[{\"name\":\"Cart Shipping Offer\",\"description\":\"Promotion applied on the Cart Shipping Price.\",\"className\":\"com.skava.promotion.ecomm.action.CartShippingOff\",\"conditionClasses\":\"com.skava.promotion.ecomm.model.PromotionCart,com.skava.promotion.ecomm.model.PromotionUser,com.skava.promotion.ecomm.model.PromotionPayment,com.skava.promotion.ecomm.model.PromotionCookie,com.skava.promotion.ecomm.model.PromotionAccounts\",\"formulaClasses\":\"com.skava.promotion.ecomm.model.PromotionCart\",\"params\":[{\"name\":\"formula\",\"displayName\":\"Formula\"}]}]}]}],\"actionTypes\":[{\"displayName\":\"Fixed Offer\",\"value\":1},{\"displayName\":\"Amount Offer\",\"value\":2},{\"displayName\":\"% Offer\",\"value\":3},{\"displayName\":\"Formula\",\"value\":4}]}Indicates the configuration of rule engine settings.
12ruleTypeProcessListenernullIndicates the class name to implement the rule type processor listener. The promotion processor delegates the messages on every rule type executions to the rule type processor listener.
13sendOfferedItemsOnlyfalseRestricts the product details in the offer response when promotion is not applicable. The possible values are as follows:
  • true - restricts the product details in the offer response when promotion is not applicable.

  • false - does not restricts the product details in the offer response when promotion is not applicable.
14timeZoneGMTIndicates the timezone of the collection. For example, EST, IST, PST, etc.
15defaultprojectaccessFALSESkips the project approval workflow when this property is set to true (that is, when the property is enabled). You can:
  • enable the toggle to skip the project approval workflow. The catalog details are updated directly without the project approval workflow process.
  • disable the toggle to enable the project approval workflow. The catalog details are updated after it is approved by the approver via the project approval workflow process. By default, this property is disabled.
Note: A user must have the privilege catalog/defaultproject/promotions to skip the project approval workflow.
16disable_project_workflowtrueIndicates whether the project approval flow is disabled completely or used when needed. This property is used only when the collection property defaultprojectaccess is set to true.
  • The value true indicates the project approval flow is skipped completely.
  • The value false indicates the project approval flow is used when needed.




Revision History
2021-12-24 | AN – Updated collection properties for 8.11 release.
2019-07-09 | JP – Updated collection properties for the July 2019 release.
2019-04-17 | MA – Content update for April 2019 release.
2019-01-23 | PLK – Page added and content uploaded.