Journey goal that advances a lead when a shopping cart or auction event occurs: an item is added to cart, checkout completes, payment goes pending, or, when configured for auctions, an auction closes with a winner. Matched against ShoppingCartFunnelEvent and AuctionClosedEvent, and can be restricted to a specific store and/or product categories. On entering, also attaches any pending quotes found on the lead's cart to the lead. Registered under the type name shoppingCartGoal.
Group: Journeys
Extends: Goal
Properties
| Property | Returns | Description |
|---|---|---|
| auction | Boolean | Whether this goal reacts to auction-closed events rather than ordinary shopping cart events. When null, both supportsAuction and supportsStore report true, matching this goal's original store-only behaviour. |
| categories | String | Comma-separated list of product category names, only checked in store mode. When set, at least one product in the cart must belong to one of these categories for the event to match. |
| description | String | Fixed display label for this goal in the journey editor: always "Shopping Cart". |
| nodeIdAddedToCart | String | Identifier of the journey node to advance to when the lead adds an item to their cart. Null if this goal does not handle the ADDED_TO_CART action. |
| nodeIdCheckoutComplete | String | Identifier of the journey node to advance to when the lead's checkout completes, or when a matching auction closes with a winner if this goal is configured for auctions. Null if not configured. |
| nodeIdPaymentPending | String | Identifier of the journey node to advance to when the lead's cart moves to a payment-pending state. Null if this goal does not handle the PAYMENT_PENDING action. |
| store | String | Name of the store this goal is restricted to matching cart events from. Only checked in store mode; if the cart's store name does not equal this value, the event does not match. |
Methods
getDescription()
Returns: String
Fixed display label for this goal in the journey editor: always "Shopping Cart".
getNodeIdAddedToCart()
Returns: String
Identifier of the journey node to advance to when the lead adds an item to their cart. Null if this goal does not handle the ADDED_TO_CART action.
getNodeIdCheckoutComplete()
Returns: String
Identifier of the journey node to advance to when the lead's checkout completes, or when a matching auction closes with a winner if this goal is configured for auctions. Null if not configured.
getNodeIdPaymentPending()
Returns: String
Identifier of the journey node to advance to when the lead's cart moves to a payment-pending state. Null if this goal does not handle the PAYMENT_PENDING action.
getAuction()
Returns: Boolean
Whether this goal reacts to auction-closed events rather than ordinary shopping cart events. When null, both supportsAuction and supportsStore report true, matching this goal's original store-only behaviour.
getStore()
Returns: String
Name of the store this goal is restricted to matching cart events from. Only checked in store mode; if the cart's store name does not equal this value, the event does not match.
getCategories()
Returns: String
Comma-separated list of product category names, only checked in store mode. When set, at least one product in the cart must belong to one of these categories for the event to match.