Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 983 Bytes

CustomEffectProps.md

File metadata and controls

19 lines (12 loc) · 983 Bytes

CustomEffectProps

Effect containing custom payload.

Properties

Name Type Description Notes
effectId Integer The ID of the custom effect that was triggered.
name String The type of the custom effect.
cartItemPosition BigDecimal The index of the item in the cart item list to which the custom effect is applied. [optional]
cartItemSubPosition BigDecimal When cart item flattening is enabled, the sub position indicates to which item unit the custom effect is applied, for cart items with quantity > 1. [optional]
bundleIndex Integer 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]
payload Object The JSON payload of the custom effect.