Nuvemshop dataLayer
Below you can see the list of dataLayer events and their payload that the Nuvemshop app generates. The dataLayer events are part of the Nuvemshop app configuration - see the detailed guide on how to set up the app.
View collection
event: "view_collection_stape",
ecomm_pagetype: "category", // home, products, or category
ecommerce: {
collection_id: "camisetas",
item_list_id: "camisetas",
item_list_name: "Products",
currency: "BRL",
items: [
{
item_id: "123456",
item_name: "Example Product",
price: 99.90,
index: 1,
imageURL: "https://cdn.example/product.jpg",
item_sku: "SKU-001",
item_brand: "Example Brand",
item_category: "T-Shirts",
item_variant: "456789",
variant_name: "Yellow, Small, Silk"
}
]
},
user_data: {
// Common user_data fields when enabled and available
customer_id: "272420309", // When known
email: "customer@example.com",
first_name: "Maria",
last_name: "Silva",
phone: "+5511999999999",
city: "São Paulo",
region: "São Paulo",
country: "Brasil",
street: "Rua Exemplo, 123",
zip: "01000-000"
}
View item
event: "view_item_stape",
ecomm_pagetype: "product",
ecommerce: {
currency: "BRL",
value: 99.90,
items: [
{
imageURL: "https://cdn.example/product.jpg",
item_id: "123456",
item_name: "Example Product",
item_brand: "Example Brand",
item_category: "T-Shirts",
item_sku: "SKU-001",
item_variant: "456789",
variant_name: "Yellow, Small, Silk",
price: 99.90,
quantity: 1
}
]
},
user_data: {
// Common user_data fields when enabled and available
customer_id: "272420309", // When known
email: "customer@example.com",
first_name: "Maria",
last_name: "Silva",
phone: "+5511999999999",
city: "São Paulo",
region: "São Paulo",
country: "Brasil",
street: "Rua Exemplo, 123",
zip: "01000-000"
}
Add to cart / remove from cart
event: "add_to_cart_stape", // Or "remove_from_cart_stape"
ecomm_pagetype: "product",
ecommerce: {
currency: "BRL",
value: 99.90,
items: [
{
item_id: "123456",
item_name: "Example Product",
item_brand: "Example Brand",
item_category: "T-Shirts",
item_sku: "SKU-001",
item_variant: "456789",
variant_name: "Yellow, Small, Silk",
imageURL: "https://cdn.example/product.jpg",
price: 99.90,
quantity: 1
}
]
},
cart_state: {
// Common cart_state structure
cart_id: "987654",
cart_quantity: 2,
cart_value: 199.80,
currency: "BRL",
lines: [
{
item_variant: "456789",
item_id: "123456",
item_sku: "SKU-001",
item_name: "Example Product",
quantity: 2,
line_total_price: 199.80,
price: 99.90
}
]
},
user_data: {
// Common user_data fields when enabled and available
customer_id: "272420309", // When known
email: "customer@example.com",
first_name: "Maria",
last_name: "Silva",
phone: "+5511999999999",
city: "São Paulo",
region: "São Paulo",
country: "Brasil",
street: "Rua Exemplo, 123",
zip: "01000-000"
}
View cart
event: "view_cart_stape",
ecommerce: {
cart_total: 199.80,
currency: "BRL",
cart_quantity: 2,
value: 199.80,
items: [
{
item_id: "123456",
item_name: "Example Product",
item_brand: "Example Brand",
item_category: "T-Shirts",
item_sku: "SKU-001",
item_variant: "456789",
variant_name: "Yellow, Small, Silk",
imageURL: "https://cdn.example/product.jpg",
price: 99.90,
quantity: 2
}
]
},
cart_state: {
// Common cart_state structure
cart_id: "987654",
cart_quantity: 2,
cart_value: 199.80,
currency: "BRL",
lines: [
{
item_variant: "456789",
item_id: "123456",
item_sku: "SKU-001",
item_name: "Example Product",
quantity: 2,
line_total_price: 199.80,
price: 99.90
}
]
} ,
user_data: {
// Common user_data fields when enabled and available
customer_id: "272420309", // When known
email: "customer@example.com",
first_name: "Maria",
last_name: "Silva",
phone: "+5511999999999",
city: "São Paulo",
region: "São Paulo",
country: "Brasil",
street: "Rua Exemplo, 123",
zip: "01000-000"
}
Begin checkout
event: "begin_checkout_stape",
ecomm_pagetype: "product",
ecommerce: {
cart_total: 199.80,
value: 199.80,
currency: "BRL",
cart_quantity: 2,
items: [
{
item_id: "123456",
item_name: "Example Product",
item_brand: "Example Brand",
item_category: "T-Shirts",
item_sku: "SKU-001",
item_variant: "456789",
variant_name: "Yellow, Small, Silk",
imageURL: "https://cdn.example/product.jpg",
price: 99.90,
quantity: 2
}
]
},
user_data: {
// Common user_data fields when enabled and available
customer_id: "272420309", // When known
email: "customer@example.com",
first_name: "Maria",
last_name: "Silva",
phone: "+5511999999999",
city: "São Paulo",
region: "São Paulo",
country: "Brasil",
street: "Rua Exemplo, 123",
zip: "01000-000"
},
is_guest_checkout: true,
delivery: {
// Common delivery structure
address_province_code: "São Paulo",
address_zip: "01000-000",
currency: "BRL",
delivery_method_type: "shipping", // "shipping" or "pickup"
shipping_amount: 15.00,
shipping_discount_amount: 0,
shipping_tier: "Standard"
},
cart_state: {
// Common cart_state structure
cart_id: "987654",
cart_quantity: 2,
cart_value: 199.80,
currency: "BRL",
lines: [
{
item_variant: "456789",
item_id: "123456",
item_sku: "SKU-001",
item_name: "Example Product",
quantity: 2,
line_total_price: 199.80,
price: 99.90
}
]
}
Add shipping info
event: "add_shipping_info_stape",
ecomm_pagetype: "basket",
ecommerce: {
cart_total: 199.80,
value: 199.80,
currency: "BRL",
cart_quantity: 2,
items: [
{
item_id: "123456",
item_name: "Example Product",
item_brand: "Example Brand",
item_category: "T-Shirts",
item_sku: "SKU-001",
item_variant: "456789",
variant_name: "Yellow, Small, Silk",
imageURL: "https://cdn.example/product.jpg",
price: 99.90,
quantity: 2
}
]
},
user_data: {
// Common user_data fields when enabled and available
customer_id: "272420309", // When known
email: "customer@example.com",
first_name: "Maria",
last_name: "Silva",
phone: "+5511999999999",
city: "São Paulo",
region: "São Paulo",
country: "Brasil",
street: "Rua Exemplo, 123",
zip: "01000-000"
},
delivery: {
// Common delivery structure
address_province_code: "São Paulo",
address_zip: "01000-000",
currency: "BRL",
delivery_method_type: "shipping", // "shipping" or "pickup"
shipping_amount: 15.00,
shipping_discount_amount: 0,
shipping_tier: "Standard"
},
cart_state: {
// Common cart_state structure
cart_id: "987654",
cart_quantity: 2,
cart_value: 199.80,
currency: "BRL",
lines: [
{
item_variant: "456789",
item_id: "123456",
item_sku: "SKU-001",
item_name: "Example Product",
quantity: 2,
line_total_price: 199.80,
price: 99.90
}
]
}
Add payment info
event: "add_payment_info_stape",
ecomm_pagetype: "basket",
ecommerce: {
cart_total: 199.80,
value: 199.80,
currency: "BRL",
cart_quantity: 2,
payment_type: "credit_card",
items: [
{
item_id: "123456",
item_name: "Example Product",
item_brand: "Example Brand",
item_category: "T-Shirts",
item_sku: "SKU-001",
item_variant: "456789",
variant_name: "Yellow, Small, Silk",
imageURL: "https://cdn.example/product.jpg",
price: 99.90,
quantity: 2
}
]
},
user_data: {
// Common user_data fields when enabled and available
customer_id: "272420309", // When known
email: "customer@example.com",
first_name: "Maria",
last_name: "Silva",
phone: "+5511999999999",
city: "São Paulo",
region: "São Paulo",
country: "Brasil",
street: "Rua Exemplo, 123",
zip: "01000-000"
},
delivery: {
// Common delivery structure
address_province_code: "São Paulo",
address_zip: "01000-000",
currency: "BRL",
delivery_method_type: "shipping", // "shipping" or "pickup"
shipping_amount: 15.00,
shipping_discount_amount: 0,
shipping_tier: "Standard"
},
cart_state: {
// Common cart_state structure
cart_id: "987654",
cart_quantity: 2,
cart_value: 199.80,
currency: "BRL",
lines: [
{
item_variant: "456789",
item_id: "123456",
item_sku: "SKU-001",
item_name: "Example Product",
quantity: 2,
line_total_price: 199.80,
price: 99.90
}
]
}
Purchase
event: "purchase_stape",
ecomm_pagetype: "purchase",
ecommerce: {
cart_quantity: 2,
cart_total: 214.80,
coupon: "WELCOME10",
currency: "BRL",
discount: "WELCOME10",
discount_amount: 10.00,
discount_percentage: 0,
payment_type: "credit_card",
shipping: 15.00,
sub_total: 209.80,
tax: 0,
transaction_id: "10001234",
value: 214.80,
items: [
{
item_id: "123456",
item_name: "Example Product",
item_brand: "Example Brand",
item_category: "T-Shirts",
item_sku: "SKU-001",
item_variant: "456789",
variant_name: "Yellow, Small, Silk",
imageURL: "https://cdn.example/product.jpg",
price: 99.90,
quantity: 2
}
]
},
user_data: {
customer_id: "272420309",
email: "customer@example.com",
first_name: "Maria",
last_name: "Silva",
phone: "+5511999999999",
city: "São Paulo",
region: "São Paulo",
country: "Brasil",
street: "Rua Exemplo, 123",
zip: "01000-000",
new_customer: true
},
delivery: {
// Common delivery structure
address_province_code: "São Paulo",
address_zip: "01000-000",
currency: "BRL",
delivery_method_type: "shipping", // "shipping" or "pickup"
shipping_amount: 15.00,
shipping_discount_amount: 0,
shipping_tier: "Standard"
},
cart_state: {
// Common cart_state structure
cart_id: "987654",
cart_quantity: 2,
cart_value: 199.80,
currency: "BRL",
lines: [
{
item_variant: "456789",
item_id: "123456",
item_sku: "SKU-001",
item_name: "Example Product",
quantity: 2,
line_total_price: 199.80,
price: 99.90
}
]
}
Was this article helpful?
🍽 Table of content:
Subscribe to product updates:
Can’t find what you are looking for?
Comments