To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Adapts a platform-wide shopping cart event, such as an item added to cart, checkout completed or payment pending, into the funnels engine's event model so it can be matched against ShoppingCartGoal nodes in a journey. Wraps the underlying ShoppingCartEvent and is dispatched by FunnelManager when the shopping cart app is active for the event's organisation. toProps exposes the cart action and urns for the website and cart involved so journeys and downstream processing, such as agents, can act on the event.
Group: Journeys
Implements: FunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| action | ShoppingCartAction | The point in the shopping cart lifecycle that fired this event, for example ADDED_TO_CART, CHECKOUT_COMPLETE or PAYMENT_PENDING. |
| attributes | Map<String,Object> | The underlying shopping cart event's raw attribute map, as populated by the shopping cart and checkout process. |
| cart | Cart | The cart that generated this event. |
| emailAttachments | List<EmailAttachmentBean> | Attachments to include on any email sent for this event. Only populated for a CHECKOUT_COMPLETE action, from the ordered products' order attachments; empty for every other action. |
| leadProfile | Profile | The profile who owns the cart, as supplied when the underlying shopping cart event was raised. |
| relatedLead | Lead | Always null: a shopping cart event is not directly tied to an existing lead when it is raised. |
| triggeredGoal | Class<? extends Goal> | Restricts matching to ShoppingCartGoal nodes, as an optimisation so funnel processing skips any funnel that does not use that goal type. |
| website | Website | The website on which the shopping cart action occurred. |
Methods
toProps() · getLeadProfile() · getCart() · getAction() · getWebsite() · getRelatedLead() · getEmailAttachments() · getAttributes() · getTriggeredGoal()
toProps()
Returns: Map<String,Serializable>
Builds the map of serialisable event properties exposed to journeys and downstream processing, including the cart action and urns for the website and cart involved.
getLeadProfile()
Returns: Profile
The profile who owns the cart, as supplied when the underlying shopping cart event was raised.
getCart()
Returns: Cart
The cart that generated this event.
getAction()
Returns: ShoppingCartAction
The point in the shopping cart lifecycle that fired this event, for example ADDED_TO_CART, CHECKOUT_COMPLETE or PAYMENT_PENDING.
getWebsite()
Returns: Website
The website on which the shopping cart action occurred.
getRelatedLead()
Returns: Lead
Always null: a shopping cart event is not directly tied to an existing lead when it is raised.
getEmailAttachments()
Returns: List<EmailAttachmentBean>
Attachments to include on any email sent for this event. Only populated for a CHECKOUT_COMPLETE action, from the ordered products' order attachments; empty for every other action.
getAttributes()
Returns: Map<String,Object>
The underlying shopping cart event's raw attribute map, as populated by the shopping cart and checkout process.
getTriggeredGoal()
Returns: Class<? extends Goal>
Restricts matching to ShoppingCartGoal nodes, as an optimisation so funnel processing skips any funnel that does not use that goal type.
© 2025 Kademi Ltd