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 | Number | The total monetary value of the discount. | |
position | Number | The index of the item in the cart items list on which this discount should be applied. | |
subPosition | Number | For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. | [optional] |
desiredValue | Number | 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 | Number | The total discount given if this effect is a result of a prorated discount. | [optional] |
desiredTotalDiscount | Number | The original total discount to give if this effect is a result of a prorated discount. | [optional] |
bundleIndex | Number | 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 | Number | The index of the targeted bundle item on which the applied discount is based. | [optional] |
targetedItemSubPosition | Number | The sub-position of the targeted bundle item on which the applied discount is based. | [optional] |