Nutritious Pumpkin Meal

    @snowplow/browser-plugin-ecommerce
    TypeScript icon, indicating that this package has built-in type declarations

    3.6.0 • Public • Published

    Snowplow Ecommerce Tracking

    npm version License

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

    Adds ecommerce events to your Snowplow tracking.

    Maintainer quick start

    Part of the Snowplow JavaScript Tracker monorepo.
    Build with Node.js (14 or 16) and Rush.

    Setup repository

    npm install -g @microsoft/rush 
    git clone https://github.com/snowplow/snowplow-javascript-tracker.git
    rush update

    Package Installation

    With npm:

    npm install @snowplow/browser-plugin-ecommerce

    Usage

    Initialize your tracker with the EcommercePlugin:

    import { newTracker } from '@snowplow/browser-tracker';
    import { EcommercePlugin } from '@snowplow/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 '@snowplow/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 Snowplow Analytics Ltd, 2010 Anthon Pang.

    All rights reserved.

    Keywords

    none

    Install

    npm i @snowplow/browser-plugin-ecommerce

    Homepage

    bit.ly/sp-js

    DownloadsWeekly Downloads

    2,745

    Version

    3.6.0

    License

    BSD-3-Clause

    Unpacked Size

    574 kB

    Total Files

    12

    Last publish

    Collaborators

    • snowplow-analytics
    • cogsp
    • paul_boocock