@mailbiz/browser-plugin-ecommerce

Mailbiz Ecommerce Tracking

Browser Plugin to be used with @mailbiz/browser-tracker.

Adds ecommerce events to your Mailbiz tracking.

Maintainer quick start

Part of the Mailbiz JavaScript Tracker monorepo.
Build with Node.js (12 LTS or 14 LTS) and Rush.

Setup repository

npm install -g @microsoft/rush 
git clone https://github.com/Mailbiz/Mailbiz.Tracker.Javascript.git
rush update

Package Installation

With npm:

npm install @mailbiz/browser-plugin-ecommerce

Usage

Initialize your tracker with the EcommercePlugin:

import { newTracker } from '@mailbiz/browser-tracker';
import { EcommercePlugin } from '@mailbiz/browser-plugin-ecommerce';

newTracker('sp1', '{{collector}}', { plugins: [ EcommercePlugin() ] }); // Also stores reference at module level

Then use the available functions from this package to track to all trackers which have been initialized with this plugin:

import { addTrans, addItem, trackTrans, trackAddToCart } from '@mailbiz/browser-plugin-ecommerce';

trackAddToCart({
  sku: '000345',
  name: 'blue tie',
  category: 'clothing',
  unitPrice: 3.49,
  quantity: 2,
  currency: 'GBP',
});

// Grouped, events are sent on `trackTrans()` call
addTrans({
  orderId: 'order-123',
  total: 8000,
  affiliation: 'acme',
  tax: 100,
  shipping: 50,
  city: 'pheonix',
  state: 'arizona',
  country: 'USA',
  currency: 'JPY',
});
addItem({
  orderId: 'order-123',
  sku: '1001',
  name: 'Blue t-shirt',
  category: 'clothing',
  price: '2000',
  quantity: '2',
  currency: 'JPY',
});
trackTrans();

Copyright and license

Licensed and distributed under the BSD 3-Clause License (An OSI Approved License).

Copyright (c) 2022 Mailbiz.

All rights reserved.