E-commerce events
add_payment_info
This event signifies a user has submitted their payment information
Parameters (required and recommended)
Name | Type | Required | Example Value | Description |
---|---|---|---|---|
|
| Yes | card | The chosen method of payment (see list of possible values below) |
| Yes |
|
You should also add all user's properties in this user object, especially reconciliation key (id, email). | |
|
| No | CHRISTMAS | Coupon code used for a purchase. |
|
| No | 16.00 | Revenue (shipping price and taxes excluded) after discount.
() () |
|
| No | EUR | Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format. (*) If you supply the |
| No | The items for the event. |
Example
add_shipping_info
This event signifies a user has submitted their shipping information.
Parameters
Name | Type | Required | Example value | Description |
---|---|---|---|---|
|
| Yes | EUR | Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format. (*) If you supply the |
|
| Yes | 22.53 | The monetary value of the event (shipping price and taxes included) after discount |
| Yes |
|
You should also add all user's properties in this user object, especially reconciliation key (id, email). | |
|
| No | CHRISTMAS | Coupon code used for a purchase. |
|
| No | Ground | The shipping tier (e.g. |
| Yes | The items for the event. |
Example
add_to_cart
This event signifies that an item was added to a cart for purchase.
Parameters (required and recommended)
Name | Type | Required | Example Value | Description |
---|---|---|---|---|
|
| Yes* | 8.00 | The monetary value of the event.
() () |
|
| Yes* | EUR | Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format. (*) If you supply the |
| Yes |
|
You should also add all user's properties in this user object, especially reconciliation key (id, email). | |
| Yes | The items for the event. |
Example
add_to_wishlist
The event signifies that an item was added to a wishlist. Use this event to identify popular gift items in your app.
Parameters (required and recommended)
Name | Type | Required | Example Value | Description |
---|---|---|---|---|
|
| No | 8.00 | The monetary value of the event.
() () |
|
| No | EUR | Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format. (*) If you supply the |
| Yes |
|
You should also add all user's properties in this user object, especially reconciliation key (id, email). | |
| Yes | The items for the event. |
Example
begin_checkout
This event signifies that a user has begun a checkout.
Parameters (required and recommended)
Name | Type | Required | Example Value | Description |
---|---|---|---|---|
|
| Yes | 16.00 | The monetary value of the event (shipping price and taxes excluded) after discount |
|
| Yes | 22.53 | The monetary value of the event (shipping price and taxes included) after discount |
|
| Yes | EUR | Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format. (*) If you supply the |
|
| No | CHRISTMAS | Coupon code used for a purchase. |
|
| No | 0_12345 | Transaction id. Used as key for updates |
| Yes |
|
You should also add all user's properties in this user object, especially reconciliation key (id, email). | |
| Yes | The items of the event. |
Example