One of the core components of the Innkeepr Spec is the track call. It describes any arbitrary event that the user has triggered. For some industry verticals and applications, Innkeepr has standardized event names. For E-Commerce tracking, for example, there are specific event names and properties that we recognize semantically. This semantic meaning allows Innkeepr to specially recognize and transform key events to build audiences optimized for specific user actions.

Event lifecycles

Here is a list of supported events for our various categories within the customer journey.

ACTION	DESCRIPTION
`search_submitted`	User searched for products
`product_added_to_cart`	User added a product to their shopping cart
`payment_info_submitted`	User added payment information
`checkout_started`	User initiated the order process (a transaction is created)
`checkout_completed`	User completed the order

Search Submitted

Fire this event when a visitor searches for products. This event supports the following semantic properties:

PROPERTY	TYPE	DESCRIPTION
`query`	String	Query the user searched with

Example:

Innkeepr.track('search_submitted', {
  query: 'blue roses'
});

Product Added to Cart

Fire this event when a visitor adds a product to their shopping cart. This event supports the following semantic properties:

PROPERTY	TYPE	DESCRIPTION
`cart_id`	String	Cart ID to which the product was added to
`product_id`	String	Database id of the product being viewed
`sku`	String	SKU of the product being viewed
`category`	String	Product category being viewed
`name`	String	Name of the product being viewed
`brand`	String	Brand associated with the product
`variant`	String	Variant of the product
`price`	Number	Price ($) of the product being viewed
`currency`	String	Currency code associated with the transaction
`quantity`	Number	Quantity of a product
`coupon`	String	Coupon code associated with a product (for example, MAY_DEALS_3)
`url`	String	URL of the product page
`image_url`	String	Image url of the product

Example: Copy

Innkeepr.track('product_added_to_cart', {
  cart_id: 'skdjsidjsdkdj29j',
  product_id: '507f1f77bcf86cd799439011',
  sku: 'G-32',
  category: 'Games',
  name: 'Monopoly: 3rd Edition',
  brand: 'Hasbro',
  variant: '200 pieces',
  price: 18.99,
  currency: 'USD',
  quantity: 1,
  coupon: 'MAYDEALS',
  url: 'https://www.example.com/product/path',
  image_url: 'https://www.example.com/product/path.jpg'
});

Payment Info Submitted

Fire this event whenever payment information has been successfully entered. This event supports the following semantic properties:

PROPERTY	TYPE	DESCRIPTION
`checkout_id`	String	Checkout transaction ID
`order_id`	String	Order ID (optional)
`shipping_method`	String	String representing the shipping method chosen
`payment_method`	String	String representing the payment method chosen

Example:

Innkeepr.track('payment_info_submitted', {
  checkout_id: '507f1f77bcf86cd799439011',
  order_id: '50314b8e9bcf000000000000'
});

Checkout Started

Fire this event whenever an order/transaction was started. Fire on the page that the customer lands on after they press the checkout button. This event supports the following semantic properties:

PROPERTY	TYPE	DESCRIPTION
`order_id`	String	Order/transaction ID
`affiliation`	String	Store or affiliation from which this transaction occurred (for example, Google Store)
`total`	Number	Revenue ($) with discounts and coupons added in.
`revenue`	Number	Revenue ($) associated with the transaction (excluding shipping and tax)
`shipping`	Number	Shipping cost associated with the transaction
`tax`	Number	Total tax associated with the transaction
`discount`	Number	Total discount associated with the transaction
`coupon`	String	Transaction coupon redeemed with the transaction
`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.$.category`	String	Product category 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
`products.$.price`	Number	Price ($) of the product being viewed
`products.$.currency`	String	Currency code associated with the transaction
`products.$.quantity`	Number	Quantity of a product
`products.$.coupon`	String	Coupon code associated with a product (for example, MAY_DEALS_3)
`products.$.url`	String	URL of the product page
`products.$.image_url`	String	Image url of the product

Example:

Innkeepr.track('checkout_started', {
  order_id: '50314b8e9bcf000000000000',
  affiliation: 'Google Store',
  total: 30,
  revenue: 25.00,
  shipping: 3,
  tax: 2,
  discount: 2.5,
  coupon: 'hasbros',
  currency: 'USD',
  products: [
    {
      product_id: '507f1f77bcf86cd799439011',
      sku: '45790-32',
      name: 'Monopoly: 3rd Edition',
      price: 19,
      currency: 'USD',
      quantity: 1,
      category: 'Games',
      url: 'https://www.example.com/product/path',
      image_url: 'https://www.example.com/product/path.jpg'
    },
    {
      product_id: '505bd76785ebb509fc183733',
      sku: '46493-32',
      name: 'Uno Card Game',
      price: 3,
      currency: 'USD',
      quantity: 2,
      category: 'Games'
    }
  ]
});  

Checkout Completed

Fire this event whenever a checkout step is completed. This event supports the following semantic properties:

PROPERTY	TYPE	DESCRIPTION
`checkout_id`	String	Checkout ID
`order_id`	String	Order/transaction ID
`affiliation`	String	Store or affiliation from which this transaction occurred (for example, Google Store)
`subtotal`	Number	Order total after discounts but before taxes and shipping
`total`	Number	Revenue ($) with discounts and coupons added in.
`revenue`	Number	Revenue ($) associated with the transaction (excluding shipping and tax)
`shipping`	Number	Shipping cost associated with the transaction
`tax`	Number	Total tax associated with the transaction
`discount`	Number	Total discount associated with the transaction
`coupon`	String	Transaction coupon redeemed with the transaction
`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.$.category`	String	Product category 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
`products.$.price`	Number	Price ($) of the product being viewed
`products.$.currency`	String	Currency code associated with the transaction
`products.$.quantity`	Number	Quantity of a product
`products.$.coupon`	String	Coupon code associated with a product (for example, MAY_DEALS_3)
`products.$.url`	String	URL of the product page
`products.$.image_url`	String	Image url of the product

Example:

Innkeepr.track('checkout_completed', {
  checkout_id: 'fksdjfsdjfisjf9sdfjsd9f',
  order_id: '50314b8e9bcf000000000000',
  affiliation: 'Google Store',
  total: 27.50,
  subtotal: 22.50,
  revenue: 25.00,
  shipping: 3,
  tax: 2,
  discount: 2.5,
  coupon: 'hasbros',
  currency: 'USD',
  products: [
    {
      product_id: '507f1f77bcf86cd799439011',
      sku: '45790-32',
      name: 'Monopoly: 3rd Edition',
      price: 19,
      currency: 'USD',
      quantity: 1,
      category: 'Games',
      url: 'https://www.example.com/product/path',
      image_url: 'https://www.example.com/product/path.jpg'
    },
    {
      product_id: '505bd76785ebb509fc183733',
      sku: '46493-32',
      name: 'Uno Card Game',
      price: 3,
      currency: 'USD',
      quantity: 2,
      category: 'Games'
    }
  ]
});

Home

Getting Started

Guides

Connections

Legal

Spec: E-Commerce Events

Event lifecycles

Search Submitted

Product Added to Cart

Payment Info Submitted

Checkout Started

Checkout Completed

​Event lifecycles

​Search Submitted

​Product Added to Cart

​Payment Info Submitted

​Checkout Started

​Checkout Completed

Event lifecycles

Search Submitted

Product Added to Cart

Payment Info Submitted

Checkout Started

Checkout Completed