Skip to main content

Introduction

note

The ecommerce section is still in beta , missing the final touches for official publication.

In the ecommerce section of Vantevo you can monitor specific actions affecting your ecommerce website and the sources of traffic that lead to sales. This can help you optimize your website and marketing campaigns to increase your profitability.

How to add ecommerce monitoring script​

The code for the Vantevo Analytics ecommerce monitoring script will look as follows, in order for the script to work you must also have entered the standard monitoring code.

<script defer id="vantevo-analytics-ecommerce" src="https://vantevo.io/js/vantevo-ecommerce.js"></script>
<script>
window.vantevo_ecommerce = window.vantevo_ecommerce || function() {(window.vantevo_ecommerce.data = window.vantevo_ecommerce.data || [])};
</script>

Parameters for advanced measurements​

The advanced parameters available are:

  • data-param-dev
  • data-param-domain
  • data-param-api

Learn more about parameters-for-advanced-measurements.

Events List​

These are the events to use to monitor your ecommerce.

EventDescription
add_to_wishlista user adds a product to the favorites list
view_itema user views a product
remove_item_carta user removes a product from the cart
add_item_carta user adds product to the cart
start_checkouta user has started the checkout process
checkout_infoa user submits personal data
checkout_shipa user submits shipments data
checkout_paymenta user initiated the payment process
purchasea user has completed a purchase

add_to_wishlist​

This event indicates that a user has added a product to the wishlist

*Parameters

OptionTypeDescription
itemsarray (Required)The product information

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("add_to_wishlist", {
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

view_item​

This event indicates that a user has viewed a product

*Parameters

OptionTypeDescription
itemsarray (Required)The product information

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("view_item", {
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

remove_item_cart​

This event indicates that a user has removed a product from the shopping cart

*Parameters

OptionTypeDescription
itemsarray (Required)The product information

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("remove_item_cart", {
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

add_item_cart​

This event indicates that a user has added a product to the shopping cart

*Parameters

OptionTypeDescription
itemsarray (Required)The product information

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("add_item_cart", {
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

start_checkout​

This event indicates that a user has initiated the checkout process

*Parameters

OptionTypeDescription
itemsarray (Required)The product information
totalnumber (Optional)The total amount of the order Example: 1255.00
couponstring (Optional)The name of the coupon used. Example: newsletter
coupon_valuenumber (Optional)The value of the coupon used. Example: 45.00
payment_typestring (Optional)The mode of payment. Example: Payal o Carta di credito.

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("start_checkout", {
"total": 199.99,
"coupon": "",
"coupon_value": 0,
"payment_type": "Credit Card",
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

checkout_info​

This event indicates that a user submits the data of personal

*Parameters

OptionTypeDescription
itemsarray (Required)The product information
totalnumber (Optional)The total amount of the order Example: 1255.00
couponstring (Optional)The name of the coupon used. Example: newsletter
coupon_valuenumber (Optional)The value of the coupon used. Example: 45.00
payment_typestring (Optional)The mode of payment. Example: Payal o Carta di credito.

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("checkout_info", {
"total": 199.99,
"coupon": "",
"coupon_value": 0,
"payment_type": "Credit Card",
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

checkout_ship​

This event indicates that a user submits shipment data

*Parameters

OptionTypeDescription
itemsarray (Required)The product information
totalnumber (Optional)The total amount of the order Example: 1255.00
couponstring (Optional)The name of the coupon used. Example: newsletter
coupon_valuenumber (Optional)The value of the coupon used. Example: 45.00
payment_typestring (Optional)The mode of payment. Example: Payal o Carta di credito.

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("checkout_ship", {
"total": 199.99,
"coupon": "",
"coupon_value": 0,
"payment_type": "Credit Card",
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

checkout_payment​

This event indicates that a user has initiated the payment process

*Parameters

OptionTypeDescription
itemsarray (Required)The product information
totalnumber (Optional)The total amount of the order Example: 1255.00
couponstring (Optional)The name of the coupon used. Example: newsletter
coupon_valuenumber (Optional)The value of the coupon used. Example: 45.00
payment_typestring (Optional)The mode of payment. Example: Payal o Carta di credito.

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("checkout_payment", {
"total": 199.99,
"coupon": "",
"coupon_value": 0,
"payment_type": "Credit Card",
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

purchase​

This event indicates that a user has completed a purchase

*Parameters

OptionTypeDescription
itemsarray (Required)The product information
totalnumber (Optional)The total amount of the order Example: 1255.00
couponstring (Optional)Il nome del coupon utilizzato. Esempio: newsletter
coupon_valuenumber (Optional)Il valore del coupon utilizzato. Esempio: 45.00
payment_typestring (Optional)La modalità di pagamento. Esempio : Payal o Carta di credito.

Product parameters

OptionTypeExampleDescription
item_idstring (Required)SKU_1234Product ID (SKU)
item_namestring (Required)Samsung GalaxyProduct name / title
currencystring (Optional)USDIndicates the currency used. The format to use is: ISO 4217. If no currency is entered Vantevo will use the default currency selected in the domain settings. Check the list of available currencies.
quantitynumber (Optional)1Product quantity. Default 1.
pricenumber (Optional)199.90Product price. Default 0.
discountnumber (Optional)20.20The value of the discount associated with the product. Default 0.
positionnumber (Optional)1The position of the product in a list. Default 1.
brandstring (Optional)SamsungThe brand of the product.
category_1string (Optional)SmartphoneCategory 1 of the product.
category_2string (Optional)SamsungCategory 2 of the product.
category_3string (Optional)GalaxyCategory 3 of the product.
category_4string (Optional)SmartCategory 4 of the product.
category_5string (Optional)LargeCategory 5 of the product.
variant_1string (Optional)blackVariant 2 of the product.
variant_2string (Optional)5.5 inchVariant 3 of the product.
variant_3string (Optional)100 gVariant 4 of the product.

Esempio

<script>
window.vantevo_ecommerce("purchase", {
"total": 199.99,
"coupon": "",
"coupon_value": 0,
"payment_type": "Credit Card",
"items": [
{
'item_id': "SKU_123",
'item_name': "Samsung Galaxy",
'currency': "EUR",
'quantity': 1,
'price': 199.99,
'discount': 0,
'position': 1,
'brand': "Samsung",
'category_1': "Smartphone",
'category_2': "Samsung",
'category_3': "Galaxy",
'category_4': "",
'category_5': "",
'variant_1': "Black",
'variant_2': "5.5 inch",
'variant_3': ""
}
]
});
</script>

Currencies list​

Vantevo Analytics supports the following codes and currencies:

CodiceCodiceNome
AEDد.إ"United Arab Emirates Dirham
ALLLekAlbanian Lek
ARS$Argentine Peso
AUD$Australian Dollar
BGNлвBulgarian Lev
BOB$bBolivian Boliviano
BRLR$Brazilian Real
CHFCHFSwiss Franc
CLP$Chilean Peso
CNY¥Chinese Yuan
COP$Colombian Peso
CUP₱Cuban Peso
CZKKčCzech Republic Koruna
DKKkrDanish Krone
EGP£Egyptian Pound
EUR€Euro
GBP£British Pound Sterling
HKD$Hong Kong Dollar
HRKknCroatian Kuna
HUFFtHungarian Forint
IDRRpIndonesian Rupiah
ILS₪Israeli New Sheqel
INR₹Indian Rupee
JPY¥Japanese Yen
KRW₩South Korean Won
LTLLtLithuanian Litas
MADDHMoroccan Dirham
MDLLeiMoldovan Leu
MXN$Mexican Peso
MYRRMMalaysian Ringgit
NGN₦Nigerian Naira
NOKkrNorwegian Krone
NZD$New Zealand Dollar
PENS/Peruvian Nuevo Sol
PHP₱Philippine Peso
PKR₨Pakistani Rupee
PLNzłPolish Zloty
PYGGsParaguayan Guarani
RONLeiRomanian Leu
RSDДин.Serbian Dinar
RUB₽Russian Ruble
SAR﷼Saudi Riyal
SEKkrSwedish Krona
SGD$Singapore Dollar
THB฿Thai Baht
TNDد.تTunisian Dinar
TRY₺Turkish Lira
TWDNT$New Taiwan Dollar
UAH₴Ukrainian Hryvnia
USD$United States Dollar
VND₫Vietnamese Dong
ZARRSouth African Rand