Add Shipping Info

Fire whenever a user submits their shipping information. This event will fire AFTER the user has successfully completed the "Add Shipping Info" step and has done the following:

1. Shipping info has populated all required shipping fields.
2. The user has selected to move on to the next step (e.g. payment info, order review, etc.).
3. The system has successfully verified the shipping info and moves the user from the shipping step to the following step.

Pairs with the following events: - Begin Checkout - Add Payment Info

Javascript Code

// When:
// User user submits shipping information

// Code:
window.dataLayer = window.dataLayer || [];
dataLayer.push({ event_data: null, ecommerce: null });  // Clear the previous ecommerce object.
dataLayer.push({
  event: "add_shipping_info",
  event_data: {
    identifier: "<identifier>", // REQUIRED | string | ex. uniquely_created_id, skin360_pwa_ntg_atc
    name: '<name>' // REQUIRED | string | ex. pdp_add_to_cart, skin360_pwa_ntg add_to_cart
},
  ecommerce: {
    coupon: "<coupon>", // contextual | string | ex. SUMMER_FUN
    currency: "<currency>", // REQUIRED | string | ex. USD | pattern: ^[A-Z]{3}$ | min. 3, max. 3
    items: "<items>", // REQUIRED | array | ex. [{item_id: "test"}] 
    shipping_tier: "<shipping_tier>", // contextual | string | ex. ground | pattern: ^[a-z_]+$
    value: "<value>" // REQUIRED | number | ex. 7.77 | pattern: ^\d\.\d\d$ | min. 0.00
  }
});

Variable Definitions

Field	Type	Required	Description	Example	Pattern	Minimum Length	Maximum Length	Minimum
identifier	string	required	The wtb-event machine-readable name. This should be a unique value specific to this piece of content, if one exists. If one does not exist, this can also be populated with the same value as the .	contact, lead_generation			100
name	string	required	The wtb-event human-readable name. This should be something that an analyst without a deep knowledge of the technical implementation of the site can easily identify the event with. It should be lowercase snake_case.	contact, lead_generation			100
coupon	string	contextual	The coupon name/code associated with the event. Event-level and item-level coupon parameters are independent.	SUMMER_FUN			100
currency	string	required	Currency of the items associated with the event, in 3-letter ISO 4217 format.	USD	^[A-Z]{3}$	3	3
items	array of items	required	Populate with item objects that represent the product(s) currently in the cart during the checkout process.	[{item_id: "test"}]
shipping_tier	string	contextual	The shipping method selected for delivery of the purchased item(s).	ground			100
value	number	required	The monetary value of the event. Does not include currency sign.	7.77	^\d\.\d\d$		100	0.00