...
e. Checkout Steps & OptionsAnchor ecomcheckout ecomcheckout
| Property | Value | Notes |
|---|---|---|
| event | 'checkout' | |
| event_type | 'checkout' | |
| step | The checkout step number:
| 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). |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"event": "checkout",
"event_type": "checkout",
"ecommerce": {
"checkout": {
"actionField": {
"step": 1
},
"products": [
{
"name": "Product Description",
"id": "ProductCode",
"category": "/first level/second level/third level",
"brand": "brand name",
"price": "99.99"
}
]
}
}
} |
checkout options
...
Checkout Options
Checkout Option data is pushed whenever the Checkout Step value is 3 or 4.
| Property | Value | Notes |
|---|---|---|
| event | 'checkoutOption' | |
| event_type | 'checkout' | |
| step | 3 or 4 | Value determined by the step number in 'Checkout Steps' data above. |
| option | The option selected |
...
| at this step |
...
| For example - 'pickup' at Step 3 or 'BPAY' at Step 4. |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"event": "checkoutOption",
"event_type": "checkout",
"ecommerce": {
"checkout_option": {
"actionField": {
"step": 14,
"option": "CartBPAY"
}
}
}
} |
Transactionsf. TransactionsAnchor ecomtrans ecomtrans
Product Transaction data is pushed on successful submission of an order.
| Property | Value | Notes | ||
|---|---|---|---|---|
| event | 'enhancedEcomm' | |||
| event type'payment' | TBC - always 'payment'? | purchase / actionField | TBC | |
| name | The product description | Repeated for each product in the transaction. | ||
| id | The product code | Repeated for each product in the transaction. | ||
| category | The product's primary category | Repeated for each product in the transaction. | ||
| price | The product price (nett price for 1) | Repeated for each product in the transaction. |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"event": "enhancedEcomm",
"event_type": "payment",
"ecommerce": {
"purchase": {
"actionField": {
"id": 100000000,
"revenue": 99.99,
"tax": 9.99,
"shipping": 10.00
}
},
"products": [
{
"name": "Product Description",
"id": "ProductCode",
"category": "/first level/second level/third level",
"price": "99.99"
}
]
}
} |
Login g. Login SuccessAnchor ecomlogin ecomlogin
Login Success data is pushed on any successful login.
...
Logout h. Logout SuccessAnchor ecomlogout ecomlogout
Logout Success data is pushed on any successful logout.
...
Add i. Add to CartAnchor ecomaddtocart ecomaddtocart
pushed on successful add to cart
...
Remove j. Remove from CartAnchor ecomremovefromcart ecomremovefromcart
pushed when a product is removed from the cart
...
Cart k. Cart UpdatedAnchor ecomcartupdate ecomcartupdate
pushed when cart quantities are changed.
...
View l. View OrderAnchor ecomvieworder ecomvieworder
Pushed when an order is viewed on the order tracking page
...
View m. View TemplateAnchor ecomviewtemplate ecomviewtemplate
Pushed when a template is viewed on the order templates page
| Code Block | ||
|---|---|---|
| ||
{
"virtualURL": "/OrderTemplates/Template Name"
} |
Anchor extend extend
| extend | |
| extend |
...
3. Extending or Overriding pushed data
If you want to push different data you can include this data by adding fields to the JSON field groups
...