Cloudflare Docs
Zaraz
Cloudflare Docs
Zaraz
GitHub icon
Visit Zaraz on GitHub
Set theme to dark (⇧+D)
  1. Products
  2. Zaraz
  3. Web API
  4. E-commerce

E-commerce

You can use zaraz.ecommerce() anywhere inside the <body> tag of a page.

zaraz.ecommerce() allows you to track common events of the e-commerce user journey, such as when a user adds a product to cart, starts the checkout funnel or completes an order on your website. It is an async function, so you can choose to await it if you would like to make sure it completed before running other code.

To start using zaraz.ecommerce(), you first need to enable it in your Zaraz account and on the tool you plan to send e-commerce data to. Then, add zaraz.ecommerce() to the <body> element of your website.

Right now, Zaraz is compatible with Google Analytics 3 (Universal Analytics), Google Analytics 4, Bing and Facebook Pixel.

​​ Enable e-commerce tracking

You do not need to map e-commerce events to triggers. Zaraz automatically forwards data using the right format to the tools with e-commerce support.

  1. Log in to the Cloudflare dashboard and select your account and domain.
  2. Select Zaraz > Settings.
  3. Enable E-commerce tracking.
  4. Select Save.
  5. Go to Zaraz > Tools Configuration > Third-party tools.
  6. Locate the tool you want to use with e-commerce tracking and select Edit.
  7. Select Settings.
  8. Under Advanced, enable E-commerce tracking.
  9. Select Save.

E-commerce tracking is now enabled. If you add additional tools to your website that you want to use with zaraz.ecommerce(), you will need to repeat steps 6-9 for that tool.

​​ Add e-commerce tracking to your website

After enabling e-commerce tracking on your Zaraz dashboard, you need to add zaraz.ecommerce() to the <body> element of your website:

zaraz.ecommerce('Event Name', { parameters });

To create a complete tracking event, you need to add an event and one or more parameters. Below you will find a list of events and parameters Zaraz supports, as well as code examples for different types of events.

​​ List of supported events

  • Product List Viewed
  • Products Searched
  • Product Clicked
  • Product Added
  • Product Added to Wishlist
  • Product Removed
  • Product Viewed
  • Cart Viewed
  • Checkout Started
  • Checkout Step Viewed
  • Checkout Step Completed
  • Payment Info Entered
  • Order Completed
  • Order Updated
  • Order Refunded
  • Order Cancelled
  • Clicked Promotion
  • Viewed Promotion
  • Shipping Info Entered

​​ List of supported parameters:

ParameterTypeDescription
product_idStringProduct ID.
skuStringProduct SKU number.
categoryStringProduct category.
nameStringProduct name.
brandStringProduct brand name.
variantStringProduct variant (depending on the product, it could be product color, size, etc.).
priceNumberProduct price.
quantityNumberProduct number of units.
couponStringName or serial number of coupon code associated with product.
positionNumberProduct position in the product list (for example, 2).
productsArrayList of products displayed in the product list.
products.[].product_idStringProduct ID displayed on the product list.
products.[].skuStringProduct SKU displayed on the product list.
products.[].categoryStringProduct category displayed on the product list.
products.[].nameStringProduct name displayed on the product list.
products.[].brandStringProduct brand displayed on the product list.
products.[].variantStringProduct variant displayed on the product list.
products.[].priceNumberPrice of the product displayed on the product list.
products.[].quantityNumberQuantity of a product displayed on the product list.
products.[].couponStringName or serial number of coupon code associated with product displayed on the product list.
products.[].positionNumberProduct position in the product list (for example, 2).
checkout_idStringCheckout ID.
order_idStringInternal ID of order/transaction/purchase.
affiliationStringName of affiliate from which the order occurred.
totalNumberRevenue with discounts and coupons added in.
revenueNumberRevenue excluding shipping and tax.
shippingNumberCost of shipping for transaction.
taxNumberTotal tax for transaction.
discountNumberTotal discount for transaction.
couponStringName or serial number of coupon redeemed on the transaction-level.
currencyStringCurrency code for the transaction.
valueNumberTotal value of the product after quantity.
creativeStringLabel for creative asset of promotion being tracked.
queryStringProduct search term.
stepNumberThe Number of the checkout step in the checkout process.
payment_typeStringThe type of payment used.

​​ Event code examples

​​ Product viewed

zaraz.ecommerce('Product Viewed', {
  product_id: '999555321',
  sku: '2671033',
  category: 'T-shirts',
  name: 'V-neck T-shirt',
  brand: 'Cool Brand',
  variant: 'White',
  price: 14.99,
  currency: 'usd',
  value: 18.99,

});

​​ Product List Viewed

zaraz.ecommerce('Product List Viewed', 
  {  products: 
    [
    { 
      product_id: '999555321',
      sku: '2671033',
      category: 'T-shirts',
      name: 'V-neck T-shirt',
      brand: 'Cool Brand',
      variant: 'White',
      price: 14.99,
      currency: 'usd',
      value: 18.99, 
      position: 1, 
    },{ 
      product_id: '999555322',
      sku: '2671034',
      category: 'T-shirts',
      name: 'T-shirt',
      brand: 'Cool Brand',
      variant: 'Pink',
      price: 10.99,
      currency: 'usd',
      value: 16.99, 
      position: 2, 
    },
    ], 
  }

);

​​ Product added

zaraz.ecommerce('Product Added', {
  product_id: '999555321',
  sku: '2671033',
  category: 'T-shirts',
  name: 'V-neck T-shirt',
  brand: 'Cool Brand',
  variant: 'White',
  price: 14.99,
  currency: 'usd',
  quantity: 1,
  coupon: 'SUMMER-SALE',
  position: 2,

});

​​ Checkout Step Viewed

zaraz.ecommerce('Checkout Step Viewed', {
  step: 1,

});

​​ Order completed

zaraz.ecommerce('Order Completed', {
  checkout_id: '616727740',
  order_id: '817286897056801',
  affiliation: 'affiliate.com',
  total: 30.0,
  revenue: 20.0,
  shipping: 3,
  tax: 2,
  discount: 5,
  coupon: 'winter-sale',
  currency: 'USD',
  products: [
    {
      product_id: '999666321',
      sku: '8251511',
      name: 'Boy’s shorts',
      price: 10,
      quantity: 2,
      category: 'shorts',
    },
    {
      product_id: '742566131',
      sku: '7251567',
      name: 'Blank T-shirt',
      price: 5,
      quantity: 2,
      category: 'T-shirts',
    },
  ],

});