You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
subPosition
float
For cart items with `quantity` > 1, the sub position indicates which item the discount applies to.
[optional]
desiredValue
float
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
float
The total discount given if this effect is a result of a prorated discount.
[optional]
desiredTotalDiscount
float
The original total discount to give if this effect is a result of a prorated discount.
[optional]
bundleIndex
int
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]
targetedItemPosition
float
The index of the targeted bundle item on which the applied discount is based.
[optional]
targetedItemSubPosition
float
The sub-position of the targeted bundle item on which the applied discount is based.