If you want to return data as an effect but no effect matches your use case, you can create a custom effect. Custom effects can be used as both rule effects and failure effects. The structure of a custom effect depends on your specifications but is always named customEffect.
| Name | Type | Description | Notes |
|---|---|---|---|
| effectId | Long | 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 | For cart items with quantity > 1, the sub position indicates to which item unit the custom effect is applied. | [optional] |
| bundleIndex | Long | 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. |