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

S. No.AttributeDefault ValueDescription
1additionalPromotionFields[
{
"type": "select",
"label": "Frequency",
"values": [
{
"name": "Weekly",
"type": "integer",
"value": {
"displayName": "Week(s)",
"maxLength": 52
}
},
{
"name": "Monthly",
"type": "integer",
"value": {
"displayName": "Month(s)",
"maxLength": 24
}
},
{
"name": "Onetime",
"type": "boolean"
}
]
},
{
"type": "text",
"label": "PromotionIdentifier",
"info": "Enter a unique code for the promotion.Ex:HOLIDAY2500FF"
}
]		Indicates the values used to define the additional promotion fields.
2applicablelocalesen_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.
3blockExpireTime300000Indicates the time till which a promo code is blocked in milliseconds.
4customConditionAttributesThe input field will be defined in the Action and Conditions tab for a promotion.
5defaultlocaleen_USIndicates the default locale of the collection.
6enablePreviewfalseIndicates the promotions are enabled for preview or not. The possible value are true or false.
7executionOrder{\"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 order of execution of various order types.
8isBasePriceDiscountfalseThis property is enabled or disabled only when multiple promotions are applied to a product.
Disabled - The discount amount is calculated from the updated unit price (that is, the price that comes after calculating the previous offer discounts).

Enabled - The discount amount is calculated from the product base price.

For example, for a product price of $100, Discount 1 is 10%, and Discount 2 is 20%.
When discount 1 is applied to the product price, the discounted amount is $90 which is the updated unit price. Now, instead of applying the discount 2 on the updated unit price, it is again applied to the product price of $100 which in turn reflects as $80.
9overAllRoundOffType0Indicates the round off type for promotion calculations.
10promoActionProcessorClasscom.skava.promotion.ecomm.rule.process.EcommPromotionActionProcessorIndicates the class for implementation of promotion action processor.
11promoRuleProcessorClasscom.skava.promotion.ecomm.rule.process.EcommPromotionRuleProcessorIndicates the class for implementation of promotion rule processor.
12promotionClass[
{
"displayName": "Material Bundle Discount",
"value": "Material Bundle Discount"
},
{
"displayName": "Sales Channel Discount",
"value": "Sales Channel Discount"
},
{
"displayName": "Advertise Discount",
"value": "Advertise Discount"
},
{
"displayName": "Order Drop Discount",
"value": "Order Drop Discount"
},
{
"displayName": "Program Discount",
"value": "Program Discount"
},
{
"displayName": "Customer Svc Discount",
"value": "Customer Svc Discount"
}
]		Indicates the values used to classify the promotion
13promotionPropertynullIndicates the additional properties to be defined based on the business need. For example, couponIdentifier.
14ruleengine.settingsPromotion Rule Engine SettingsIndicates the configuration of rule engine settings.
15ruleTypeProcessListenernullIndicates 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.
16sendOfferedItemsOnlyfalseRestricts 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.
17timeZoneGMTIndicates the timezone of the collection. For example, EST, IST, PST, etc.
18defaultprojectaccessFALSESkips 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.
19disable_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.
  • false indicates the project approval flow is used when needed.
20adminConditionFieldSettings[{"className":"com.skava.promotion.ecomm.model.PromotionSku","fields":[{"name":"id","value":"selector\/catalog\/sku\/filter"}]}]This property is used for defining additional configuration information for any conditional fields.
21enablebExpireTimeFALSEThis property indicates the boolean value for extending the block expiry time.
If this property flag is set to:
  • true - considers the value provided in the blockExpireTime” even when the value is greater than “3600000” (1hour).
  • false - will not extend the block expiry time.The default value is false.
22promotionDetailsProperty[{"name":"promotionClass","displayName":"Promotion Class","isMandatory":"false","options":[{"displayName":"Material Bundle Discount","value":"Material Bundle Discount"},{"displayName":"Sales Channel Discount","value":"Sales Channel Discount"},{"displayName":"Advertise Discount","value":"Advertise Discount"},{"displayName":"Order Drop Discount","value":"Order Drop Discount"},{"displayName":"Program Discount","value":"Program Discount"},{"displayName":"Customer Svc Discount","value":"Customer Svc Discount"}]},{"name":"promotionGroup","displayName":"Promotion Group","isMandatory":"false","options":[{"displayName":"Personal Offer","value":"Personal Offer"},{"displayName":"Group Offer","value":"Group Offer"}]}]Indicates the values used to classify the promotion like Material Bundle Discount, Sales Channel Discount, Advertise Discount, Order Drop Discount, Program Discount, and Customer Svc Discount.
23skipIdentifiersDuring rules configuration, this property with the value totalPrice, quantity, fulfillmentType enables proximity promotion based on Total Price, Quantity, and Fulfillment Type.

The proximity promotion capability is enabled by configuring the collection properties skipIdentifiers and ruleengine.setting. For more configuration details, see the Promotion Rule Engine Settings file.
allowedPromoCodeStacking{
"collectionLevel": false,
"groupLevel": {
"enabled": false,
"equivalentGroups": []
}
}
During rules configuration, this property with the value totalPrice, quantity, fulfillmentType enables proximity promotion based on Total Price, Quantity, and Fulfillment Type.

Revision History
2026-03-09 | JP – Updated collection properties.
2024-03-05 | SD – Updated collection properties.
2022-12-20 | SW – Updated collection properties for 8.13 release.
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.