Page History

...

Property	Value	Notes
event	'remarketing'
ecomm_pagetype	One of the following: other home category product cart purchase	Value determined by the page the user is on.
ecomm_prodid	One of the following: Product code (product pages) Array of product codes (category, cart, purchase pages)	Optional. Value determined by the page the user is on, and does not apply to page types 'home' or 'other'.
ecomm_totalvalue	The total value of all products and charges (if any)	Optional. Only applies to page types 'product', 'cart, and 'purchase'.
google_conversion_value	The total value of all products and charges	Optional. Only applies to page type 'purchase'.

...

Property	Value	Notes
event	'enhancedEcomm'	Due to infinite scrolling, some pages may load additional data after the inital page load. For this reason, impressions are pushed via an event. Infinite scrolling creates a new event, and therefore a new data push. This also ensures that data is pushed in blocks, so as not to exceed the object data limit.
event_type	'impression'
currencyCode	The currency code for the current account
name	The product description
id	The product code
category	The product's primary category
list	One of the following: Product List Search Results Items Recently Viewed Campaign - (sent as the Campaign Description, not the Campaign Code) CrossSell UpSell User Favourites Prior Purchases Product Details - (This value is only applies where the user has navigated directly to a product via link or similar. Otherwise, the list from which the product was accessed will be used for product detail impressions.)	Value determined by the list in which the product is located.
brand	The product's brand
position	The product's position / sequence in its list
price	The product price (nett price for 1)	If 'hide pricing' is enabled at Role level, this data is not pushed.

...

Product Click data is pushed on any click of a product link. For example, a product on a page of search results, or a product on a category page, or from the user's favourites list.

Property	Value	Notes
event	'productClick'
list	One of the following: Product List Search Results Items Recently Viewed Campaign - (sent as the Campaign Description, not the Campaign Code) CrossSell UpSell User Favourites Prior Purchases Cart Item	Value determined by the list in which the product is located.
name	The product description
id	The product code
category	The product's primary category
brand	The product's brand
price	The product price (nett price for 1)	If 'hide pricing' is enabled at Role level, this data is not pushed.
position	The product's position / sequence in its list

...

Property	Value	Notes
event	'checkout'
event_type	'checkout'
step	The checkout step number: Step 1 - going to cart Step 2 - attempting checkout, but login required Step 3 - selecting delivery option Step 4 - selecting payment option Step 5 - submitting the order	Steps 3 & 4 will trigger additional 'Product Option' data to be pushed, in the form of the option selected at this step. For example, the freight option selected at Step 3 or the payment method selected at Step 4 (sample provided below).
products	The products in the cart	Standard product data will be pushed for each product in the cart (e.g. name, id, category, brand, price).

...

Anchor

	ecomaddtocart
	ecomaddtocart

i. Add to Cart

pushed on successful add to cart

pageType
- The page the product was added from
  - Product List
  - Search Results
  - Product Details
list
- The list the product was added from
  - Product List
  - Search Results
  - Product Compare
  - Items Recently Viewed
  - Campaign - Campaign Description
  - CrossSell
  - UpSell
  - User Favourites
  - Prior Purchases
  - Product Details
  - Cart Fast Order
  - Quick Order Entry

...

Add To Cart data is pushed every time a user successfully adds a product to their cart.

Property	Value	Notes
event	'addToCart'
currencyCode	The currency code for the current account
products	The product(s) added to the cart	Standard product data is included here (e.g. name, id, category, quantity, brand, price)
pageType	One of the following: Product List Search Results Product Details	Value determined by the page on which the product was added.
list	One of the following: Product List Search Results Product Compare Items Recently Viewed Campaign - (sent as the Campaign Description, not the Campaign Code) CrossSell UpSell User Favourites Prior Purchases Product Details Cart Fast Order Quick Order Entry	Value determined by the list from which the product was added

Code Block

language	js
title	Sample Add To Cart data
collapse	true

{
	"event": "addToCart",
	"ecommerce": {
		"currencyCode": "AUD",
		"add": {
			"products": [
			{
				"name": "Product Description",
				"id": "ProductCode",
				"category": "/first level/second level/third level",
				"quantity": 1,
				"brand": "brand name",
				"price": "99.99"
			}
			]
		}
	},
	"pageType": "Product List",
	"list": "Product List"
}

...

 "Product List"
}

Anchor

	ecomremovefromcart
	ecomremovefromcart

j. Remove from Cart

Remove From Cart data is pushed whenever a product is successfully removed from the user's cart.

NOTE - This can be a whole line deletion, or a decrease in quantity. Both actions are sent as 'Remove From Cart' data.

Property	Value	Notes
event	'removeFromCart'
currencyCode	The currency code for the current account
products	The product(s) removed from cart	Standard product data is included here (e.g. name, id, category, quantity, price).

Code Block

language	js
title	Sample Remove From Cart data
collapse	true

 {
	"event": "removeFromCart",
	"ecommerce": {
		"currencyCode": "AUD",
		"remove": {
			"products": [
			{
				"name": "Product Description",
				"id": "ProductCode",
				"category": "/first level/second level/third level",
				"quantity": 1,
				"price": "99.99"
			}
			]
		}
	}
}

...

Space shortcuts

Page tree

Versions Compared

Old Version 27

New Version 28

Key