ADD event for ancillary product
You can use the ADD event to capture ancillary products that the user adds to their cart, such as insurance. This event is optional, but employing it can positively affect the amount of available data. Using this event is the only way to capture ancillary products that the user adds to their cart. This event also helps ensure accuracy of the cart contents and order values when a user returns to their abandoned cart.
To send an ADD event for an ancillary product, use the following required attributes:
|
Attribute |
Type |
Description |
Example |
|---|---|---|---|
|
|
string (uppercase) |
The touchpoint where the user interacts with your brand. |
|
|
|
string (uppercase) |
The type of the event that takes place when the user interacts with your brand. |
|
|
|
string (uppercase ISO 639-1) |
The language the user is using your app in. |
|
|
|
string (uppercase ISO 4217) |
The alphabetic currency code of the currency the user is using in your app. |
|
|
|
string |
The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice. |
|
|
|
string |
The name of the point of sale where the interaction with your brand takes place. |
|
|
|
string |
The browser ID. |
|
|
|
object |
The product entity data. |
N/A |
The product object:
|
Attribute |
Type |
Description |
Example |
Required/optional |
|---|---|---|---|---|
|
|
string (uppercase) |
The type of product added to cart. |
Deprecated:
|
Required |
|
|
string |
The item ID of the product added to cart. Used in Extract, Transform, Load (ETL) data integration to create the order. |
|
Required |
|
|
string (title case recommended) |
The name of the product added to the cart. |
|
Required |
|
|
string (uppercase ISO 4217) |
The currency of the product added to the cart. |
|
Required |
|
|
number (currency) |
The unit price of the product. Total price of the product is calculated by unit price multiplied by quantity. |
|
Required |
|
|
string |
The product ID of the product added. Used in analytics for reporting. |
|
Required |
|
|
number |
The number of unit added. Total price of the product is calculated by unit price multiplied by quantity. |
|
Required |
{
"channel": "MOBILE_APP",
"type": "ADD",
"language": "EN",
"currency": "EUR",
"page": "passengers page",
"pos": "spinair.com/france",
"browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
"product": {
"type": "BAG",
"item_id": "BAG_1",
"name": "20kg Bag",
"currency": "EUR",
"price": 10,
"product_id": "Bag20",
"quantity": 1
}
}