RollbackDiscountEffectProps.md

RollbackDiscountEffectProps

This effect indicates that a discounted session, cart item, or additional cost has been cancelled or partially returned. This effect can only happen when you set the status of a session to cancel or the status changes to partially_returned. If the session contains some cart items with quantity > 1, use the cartItemSubPosition property to identify the specific item unit in its line item. See the example below.

Properties

Name	Type	Description	Notes
name	String	The name of the discount effect that was rolled back.
value	BigDecimal	The monetary value of the discount that was rolled back.
cartItemPosition	BigDecimal	The index of the item in the `cartItem` object whose discount was rolled back, or the unit containing the additional cost whose discount was rolled back.	[optional]
cartItemSubPosition	BigDecimal	The index of the item unit in its line item for which the discount was rolled back.	[optional]
additionalCostId	Long	Only when rolling back setDiscountPerAdditionalCost and setDiscountPerAdditionalCostPerItem The ID of the additional cost to be discounted.	[optional]
additionalCost	String	The API name of the additional cost whose discount was rolled back.	[optional]
scope	String	The scope of the rolled back discount. - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal`	[optional]