Checkout Started

Description

This client-side event fires when a customer starts the checkout process (ie, when they land on the /checkout page — not when they click the “checkout” link on the cart page).

Instrumentation

This event is implemented with our javascript analytics library. The tracking code is managed in the storefront theme.

💡

Note: Standard Shopify stores do not allow us to inject javascript on the checkout page. However, for Shopify stores built on Shopify Plus, we have access to the checkout page’s theme and can quickly implement this event there. Otherwise, we have to implement this event whenever someone clicks “Check out” on Shopify’s cart page.

Event Properties

Property	Type	Description
checkout_id	String	Checkout ID
affiliation	String	Store or affiliation from which this transaction occurred (e.g. Google Store)
value	Number	Revenue ($) with discounts and coupons added in. For better flexibility and total control over tracking, we let you decide how to calculate how coupons and discounts are applied
revenue	Number	Revenue ($) associated with the transaction (excluding shipping and tax)
currency	String	Currency code associated with the transaction
products	Array	Products in the order
products.$.product_id	String	Database id of the product being viewed
products.$.sku	String	Sku of the product being viewed
products.$.name	String	Name of the product being viewed
products.$.brand	String	Brand associated with the product
products.$.variant	String	Variant of the product (e.g. Black)
products.$.price	Number	Price ($) of the product being viewed
products.$.quantity	Number	Quantity of a product
products.$.coupon	String	Coupon code associated with a product (e.g MAY_DEALS_3)
products.$.position	Number	Position in the product list (ex. 3)
products.$.url	String	URL of the product page
products.$.image_url	String	Image url of the product

Example:

analytics.track('Checkout Started', {
  order_id: '20614a8e9bff000150000000',
  affiliation: 'Google Store',
  value: 30,
  revenue: 25.00,
  shipping: 3,
  tax: 2,
  discount: 2.5
  currency: 'USD',
  products: [
    {
      product_id: '503f1f77bcf86cd799439022',
      sku: '42740-32',
      name: 'Monopoly: 3rd Edition',
      price: 19,
      quantity: 1,
      url: 'https://www.example.com/product/path',
      image_url: 'https://www.example.com/product/path.jpg'
    },
    {
      product_id: '505bd76783ebk509cf183783',
      sku: '46443-35',
      name: 'Uno Card Game',
      price: 3,
      quantity: 2
    }
  ]
});