Add-to-Cart represents the selection of a product, itinerary, account, or similar offering for purchase or application.

Retail: Typically an add-to-cart
Travel: Typically the selection of an itinerary, room, etc. for booking
Banking: Typically the selection of an account to open
Insurance: Typically the selection of a policy to apply for

Configuration

Required fields

Field	Values	Definition
`category`	String. Valid value - `Behavior`	The category of the signal. For behavioral signals the category should always be “Behavior”.
`name`	String	The name assigned to the signal. Can contain specific information about the signal that differentiates it from other signals.
`signalType`	String. For add-to-cart signals, use `addToCart`.	The type of signal being sent. Must be from the set of supported signals.
`productId`	String	Identifier of the product
`productName`	String	Name of the product
`quantity`	Number or string	Quantity of the product added to cart. Can also be negative in the case that something was removed from cart.
`price`	Number or string	Current price of the product including discounts
`currency`	String	Currency in which the price of the product is being represented

Optional fields

Field	Values	Definition
`effect`	String. Valid values: - `negative` - `positive`	Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring.
`pageCategory`	String	Reflects the type of page e.g. home, listing, details, search, etc.
`signalCustomAttributes`	String	Allows for custom attributes that are not predefined by the product
`discount`	Number or string	Discounts from the original price in currency. Adding the discount to the unitPrice would total the original price.
`productCategory`	String	Category the product falls in based on the product catalog
`productUrl`	String	URL of the product
`productImageUrl`	String	URL of the image of the product
`shoppingCartUrl`	String	URL of the shopping cart that the add to carts are contributing to
`virtualCategory`	String	Promotional category such as "recently added".

Sample payload

{
    "signalType": "addToCart",
    "category": "Behavior",
    "name": "addToCart from product page",
    "productId": "10",
    "productName": "T-shirt",
    "quantity": 10,
    "shoppingCartUrl": "",
    "promotionId": "2",
    "effect": "positive"
}

All data in the SDK payload must be collected manually, there is no automatic binding to the payload fields.