This document describes the av.cart dataLayer object.
av.cart describes attributes of the current state of the incomplete order (the shopping cart) as seen by the user. av.cart is created when a product is added to the order and is undefined up until that point. av.cart is destroyed once an order is created.
av.cart consists of:
1.Attributes of the incomplete order.
2.Objects that describe the products on the order.
3.Dictionary objects that provide additional descriptions for the products on the order.
4.Utility functions that allow the user to query the order for the existence, value and count of specific products on the order.
5.Dictionary lookup functions that allow the user to look up a GUID from a product on the order in the associated dictionary object.
Information In all of the tables below the currency type means a structure that has two elements: 1.Amount: For the actual amount (number) 2.Currency: For the actual currency (string). |
The usage is simple: XXX.amount or XXX.currency where the XXX is the proper dataLayer reference.
For all objects of type array the index means the array index.
Attribute |
Description |
Type |
Full dataLayer Reference |
total_tax |
An object that describes the total tax on the incomplete order |
currency |
av.cart.total_tax |
payment_method |
The payment method - always null - only populated in av.order |
string |
av.cart.payment_method |
order_number |
The order number - always null - only populated in av.order |
string |
av.cart.order_number |
grand_total |
An object that describes the current order grand total |
currency |
av.cart.grand_total |
delivery_method |
The current selected delivery method for the incomplete order |
string |
av.cart.delivery_method |
delivery_charges |
An object that describes the current delivery method charges for the incomplete order |
currency |
av.cart.delivery_charges |
customer_zip |
The order customer address zip - always null - only populated in av.order |
string |
av.cart.customer_zip |
customer_state |
The order customer address state - always null - only populated in av.order |
string |
av.cart.customer_state |
customer_number |
The order customer number - always null - only populated in av.order |
string |
av.cart.customer_number |
customer_country |
The order customer address country - always null - only populated in av.order |
string |
av.cart.customer_country |
customer_city |
The order customer address city - always null - only populated in av.order |
string |
av.cart.customer_city |
affiliation |
The Google Analytics affiliation configured in the registry or as a site attribute |
string |
av.cart.affiliation |