Skip to main content
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.
ACTIONDESCRIPTION
search_submittedUser searched for products
product_added_to_cartUser added a product to their shopping cart
payment_info_submittedUser added payment information
checkout_startedUser initiated the order process (a transaction is created)
checkout_completedUser completed the order

​
Search Submitted

Fire this event when a visitor searches for products. This event supports the following semantic properties:
PROPERTYTYPEDESCRIPTION
queryStringQuery 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:
PROPERTYTYPEDESCRIPTION
cart_idStringCart ID to which the product was added to
product_idStringDatabase id of the product being viewed
skuStringSKU of the product being viewed
categoryStringProduct category being viewed
nameStringName of the product being viewed
brandStringBrand associated with the product
variantStringVariant of the product
priceNumberPrice ($) of the product being viewed
currencyStringCurrency code associated with the transaction
quantityNumberQuantity of a product
couponStringCoupon code associated with a product (for example, MAY_DEALS_3)
urlStringURL of the product page
image_urlStringImage 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:
PROPERTYTYPEDESCRIPTION
checkout_idStringCheckout transaction ID
order_idStringOrder ID (optional)
shipping_methodStringString representing the shipping method chosen
payment_methodStringString 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:
PROPERTYTYPEDESCRIPTION
order_idStringOrder/transaction ID
affiliationStringStore or affiliation from which this transaction occurred (for example, Google Store)
totalNumberRevenue ($) with discounts and coupons added in.
revenueNumberRevenue ($) associated with the transaction (excluding shipping and tax)
shippingNumberShipping cost associated with the transaction
taxNumberTotal tax associated with the transaction
discountNumberTotal discount associated with the transaction
couponStringTransaction coupon redeemed with the transaction
currencyStringCurrency code associated with the transaction
productsArrayProducts in the order
products.$.product_idStringDatabase id of the product being viewed
products.$.skuStringSKU of the product being viewed
products.$.categoryStringProduct category being viewed
products.$.nameStringName of the product being viewed
products.$.brandStringBrand associated with the product
products.$.variantStringVariant of the product
products.$.priceNumberPrice ($) of the product being viewed
products.$.currencyStringCurrency code associated with the transaction
products.$.quantityNumberQuantity of a product
products.$.couponStringCoupon code associated with a product (for example, MAY_DEALS_3)
products.$.urlStringURL of the product page
products.$.image_urlStringImage 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:
PROPERTYTYPEDESCRIPTION
checkout_idStringCheckout ID
order_idStringOrder/transaction ID
affiliationStringStore or affiliation from which this transaction occurred (for example, Google Store)
subtotalNumberOrder total after discounts but before taxes and shipping
totalNumberRevenue ($) with discounts and coupons added in.
revenueNumberRevenue ($) associated with the transaction (excluding shipping and tax)
shippingNumberShipping cost associated with the transaction
taxNumberTotal tax associated with the transaction
discountNumberTotal discount associated with the transaction
couponStringTransaction coupon redeemed with the transaction
currencyStringCurrency code associated with the transaction
productsArrayProducts in the order
products.$.product_idStringDatabase id of the product being viewed
products.$.skuStringSKU of the product being viewed
products.$.categoryStringProduct category being viewed
products.$.nameStringName of the product being viewed
products.$.brandStringBrand associated with the product
products.$.variantStringVariant of the product
products.$.priceNumberPrice ($) of the product being viewed
products.$.currencyStringCurrency code associated with the transaction
products.$.quantityNumberQuantity of a product
products.$.couponStringCoupon code associated with a product (for example, MAY_DEALS_3)
products.$.urlStringURL of the product page
products.$.image_urlStringImage 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'
    }
  ]
});