Your integration may add custom parameters. The tables only list parameters that exist in Synerise and SDKs/APIs by default.
transaction.charge
A transaction was completed. This event is the summary of the transaction. Additionally, product.buy events are generated automatically for each item in the transaction.
Default retention: infinite
Recommended retention: infinite
Retention guidelines:
Lowering the retention of this event affects the quality of AI recommendation models.
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| $totalAmount | number | 300.00 |
Total value of the purchased items. Equal to the value parameter from the transaction event request. |
| $revenue | number | 400.00 |
Total value of the purchased items, with taxes and discounts. Equal to the revenue parameter of the transaction event request. |
| $paymentType | object | {"method":"CASH"} |
Transaction's payment method |
| $currency | string | USD |
Currency of the payment |
| products | array of objects | [{"$sku":"nui43ry89","$quantity":"1.0","$finalUnitPrice":"12.00","$name":"Soft drink","$currency":"PLN"}] |
An array of products in the transaction |
| $orderID | string | 13045a77-5230-481f-8f10-50d867c8d930 |
Unique ID of the transaction |
| productEventsUUIDs | array of strings | ["d83fdb62-6273-3b7f-a52d-fd079098ba4f","14b4c1bf-ecc2-464d-81b6-978e2997a79b"] |
UUIDs of product.buy events generated by this transaction. |
| Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, some parameters are added automatically. |
product.buy
This event generated for each item in a transaction. If multiple copies of the item were bought, they are summarized in a single product.buy event.
Default retention: infinite
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| sku | string | nui43ry89 |
Unique identifier of the item |
| $finalUnitPrice | string | 12.00 |
Final price of a single unit of the item, including tax and discounts |
| $orderID | string | 13045a77-5230-481f-8f10-50d867c8d930 |
Unique ID of the transaction |
| $quantity | string | 1.5 |
Quantity of the item |
| $name | string | Soft drink |
Name of the item |
| $currency | string | USD |
Currency of the payment |
| Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, some parameters are added automatically. |
transaction.cancel
A transaction was cancelled and funds need to be returned.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
product.addToCart
A customer added an item to their cart.
Default retention: infinite
Retention guidelines:
Lowering the retention of this event affects:
- Analyses of cart interactions, potential revenue from carts, reporting
- Automations based on cart interactions
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| $currency | string | USD |
Currency of the payment |
| sku | string | nui43ry89 |
Unique identifier of the item |
| $name | string | Soft drink |
Name of the item |
| $quantity | string | 1.5 |
Quantity of the item |
| $finalUnitPrice | string | 12.00 |
Final price of a single unit of the item, including tax and discounts |
| offline | integer or boolean | true |
If the event was generated by an offline point of sales, this parameter is true or 1, otherwise false or 0. |
| producer | string | Sneaky Sneakers |
Brand of the item |
| Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, some parameters are added automatically. |
product.removeFromCart
A customer removed an item from their cart.
Default retention: infinite
Retention guidelines:
Lowering the retention of this event affects:
- Analyses of cart interactions, potential revenue from carts, reporting
- Automations based on cart interactions
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| $currency | string | USD |
Currency of the payment |
| sku | string | nui43ry89 |
Unique identifier of the item |
| $name | string | Soft drink |
Name of the item |
| $finalUnitPrice | string | 12.00 |
Final price of a single unit of the item, including tax and discounts |
| offline | integer or boolean | true |
If the event was generated by an offline point of sales, this parameter is true or 1, otherwise false or 0. |
| producer | string | Sneaky Sneakers |
Brand of the item |
| Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, some parameters are added automatically. |
cart.status
A summary of the cart's current contents. This event is not generated by default. See Tracking cart status for instructions on implementing it.
Default retention: 30 days
Retention guidelines:
Lowering the retention of this event affects:
- Analyses of cart interactions, potential revenue from carts, reporting
- Automations based on cart interactions
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| sku | string | nui43ry89 |
Unique identifier of the item |
| products | array | [{"sku":"236"."quantity":1},{"sku":"436"."quantity":4}] |
A list of items in the cart |
| $totalAmount | number | 300.00 |
Total value of the purchased items. Equal to the value parameter from the transaction event request. |
| itemIds | array | ["236","436"] |
An array of item IDs that can be used in analytics and recommendations without extracting them from the products array. |
| Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, some parameters are added automatically. |
product.addToFavorite
A user added an item to favorites.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| sku | string | nui43ry89 |
Unique identifier of the item |
| Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, some parameters are added automatically. |
product.removeFromFavorite
A user removed an item from favorites. This event can be tracked as a custom event. No parameters are required.
In some integrations, the event is called 'product.removeFromFavoUrite' (favourite as spelled in British English).
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
product.addReview
This event is generated as a result of integrating Synerise with VTEX IO and Sylius. It is generated when a logged-in customer submits a product review.
If VTEX allows synchronizing reviews from anonymous customers, no events will be generated in Synerise due to the lack of customer identifiers needed to match reviews with customers.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| rating | number | 5 |
Reviewer's rating |
| nickname | string | JohnDoe |
Reviewer's name |
| productId | string | 1 |
The ID of a reviewed product |
| sku | string | 2 |
The ID of SKU |
| title | string | Great product |
Review's title |
| detail | string | I love it! |
Review's text |
| locale | string | en-US |
Reviewer's locale |
| verifiedPurchaser | boolean | true |
Indicates if the reviewer is a verified purchaser (true) or not (false). |
| approved | boolean | true |
Indicates if the review was approved (true) or not (false). |