| exclusiveCategories |
List<String> |
Lists the IDs of exclusive categories. A redeemable from a campaign with an exclusive category is the only redeemable to be redeemed when applied with redeemables from other campaigns unless these campaigns are exclusive or joint. |
| jointCategories |
List<String> |
Lists the IDs of the joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns. |
| redeemablesLimit |
Integer |
Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. |
| applicableRedeemablesLimit |
Integer |
Defines how many redeemables can be applied in one request. The number must be less than or equal to `redeemables_limit`. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be `SKIPPED` according to the `redeemables_sorting_rule`. |
| applicableRedeemablesPerCategoryLimit |
Integer |
Defines how many redeemables with the same category can be applied in one request. The number must be less than or equal to `applicable_redeemables_limit`. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. |
| applicableExclusiveRedeemablesLimit |
Integer |
Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. |
| applicableExclusiveRedeemablesPerCategoryLimit |
Integer |
Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. The number must be less than or equal to `applicable_exclusive_redeemables_limit`. |
| discountCalculationMode |
DiscountCalculationModeEnum |
Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. |
| initialAmountModeCategories |
List<String> |
Lists the IDs of the categories that apply a discount based on the initial amount. |
| discountedAmountModeCategories |
List<String> |
Lists the IDs of the categories that apply a discount based on the discounted amount. |
| redeemablesApplicationMode |
RedeemablesApplicationModeEnum |
Defines the application mode for redeemables. `"ALL"` means that all redeemables must be validated for the redemption to be successful. `"PARTIAL"` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped. |
| redeemablesSortingRule |
RedeemablesSortingRuleEnum |
Defines redeemables sorting rule. `CATEGORY_HIERARCHY` means that redeemables are applied oaccording to the category priority. `REQUESTED_ORDER` means that redeemables are applied in the sequence provided in the request. |
| redeemablesProductsApplicationMode |
RedeemablesProductsApplicationModeEnum |
Defines redeemables products application mode. `STACK` means that multiple discounts can be applied to a product. `ONCE` means that only one discount can be applied to the same product. |
| redeemablesNoEffectRule |
RedeemablesNoEffectRuleEnum |
Defines redeemables no effect rule. `REDEEM_ANYWAY` means that the redeemable will be redeemed regardless of any restrictions or conditions in place. `SKIP` means that the redeemable will be processed only when an applicable effect is calculated. |
| noEffectSkipCategories |
List<String> |
Lists category IDs. Redeemables with a given category are skipped even if the `redeemables_no_effect_rule` is set to `REDEEM_ANYWAY`. Category IDs can't overlap with the IDs in `no_effect_redeem_anyway_categories`. |
| noEffectRedeemAnywayCategories |
List<String> |
Lists category IDs. Redeemables with a given category are redeemed anyway even if the `redeemables_no_effect_rule` is set to `SKIP`. Category IDs can't overlap with the IDs in `no_effect_skip_categories`. |
| redeemablesRollbackOrderMode |
RedeemablesRollbackOrderModeEnum |
Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values. |