SetDiscountPerItemEffectProps.md

SetDiscountPerItemEffectProps

The properties specific to the setDiscountPerItem effect, triggered whenever a validated rule contained a "set per item discount" effect. This is a discount that will be applied either on a specific item, on a specific item + additional cost or on all additional costs per item. This depends on the chosen scope.

Properties

Name	Type	Description	Notes
name	String	The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the `position` property.
value	BigDecimal	The total monetary value of the discount.
position	BigDecimal	The index of the item in the cart items list on which this discount should be applied.
subPosition	BigDecimal	Only used when cart item flattening is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1.	[optional]
desiredValue	BigDecimal	The original value of the discount.	[optional]
scope	String	The scope of the discount: - `additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item.	[optional]
totalDiscount	BigDecimal	The total discount given if this effect is a result of a prorated discount.	[optional]
desiredTotalDiscount	BigDecimal	The original total discount to give if this effect is a result of a prorated discount.	[optional]
bundleIndex	Integer	The position of the bundle in a list of item bundles created from the same bundle definition.	[optional]
bundleName	String	The name of the bundle definition.	[optional]