Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 2.31 KB

SetDiscountPerItemEffectProps.md

File metadata and controls

22 lines (18 loc) · 2.31 KB

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 str 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 float The total monetary value of the discount.
position float The index of the item in the cart items list on which this discount should be applied.
sub_position float For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. [optional]
desired_value float The original value of the discount. [optional]
scope str 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]
total_discount float The total discount given if this effect is a result of a prorated discount. [optional]
desired_total_discount float The original total discount to give if this effect is a result of a prorated discount. [optional]
bundle_index int The position of the bundle in a list of item bundles created from the same bundle definition. [optional]
bundle_name str The name of the bundle definition. [optional]
targeted_item_position float The index of the targeted bundle item on which the applied discount is based. [optional]
targeted_item_sub_position float The sub-position of the targeted bundle item on which the applied discount is based. [optional]

[Back to Model list] [Back to API list] [Back to README]