This effect indicates that a discount should be set on the total shopping cart value of the current order with the given label and amount. The discount should overwrite any existing discount with the same name. The most recent integration state update always returns the latest values for all effects, effectively overwriting any previous effects. Enabling partial discounts allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the desiredValue property to identify the original value of the discount.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name or description of this discount. | |
| value | BigDecimal | The monetary value of the effective discount. | |
| scope | String | What the discount applies to. Possible values: - `cartItems`: Discount on the price of the items. - `additionalCosts`: Discount on the additional costs of the items. - `sessionTotal`: Discount on the total value of the customer session. Note: Cascading discounts must be enabled for this property to be returned. | [optional] |
| desiredValue | BigDecimal | (Partial discounts enabled only) The monetary value of the discount to be applied without considering budget limitations. | [optional] |