trackEcommerceOrder

The trackEcommerceOrder() method tracks conversions, including products and payment details.

Syntax

const options: TrackEcommerceOrderOptions = {
  visitCustomVariables: { index: { name: 'name', value: 'value' },
  customDimensions: { dimensionID: 'value', dimensionID: 'value', },
  discount: 'discount',
  shipping: 'shipping',
  subTotal: 'subTotal',
  tax: 'tax',
};

const ecommerceProduct: EcommerceProduct[] = [
    {
      sku: 'sku',
      name: 'name',
      category: ['category'],
      price: 'price',
      quantity: quantity,
      brand: 'brand',
      variant: 'variant',
      customDimensions: {
        dimensionID: 'value',
        dimensionID: 'value',
      },
    },
];

let grandTotal: String = 'grandTotal';
let orderId: String = 'orderId';
await PiwikProSdk.trackEcommerceOrder(orderId, grandTotal, ecommerceProduct, options);

Parameters

products (Array, required)

Product list. Each product should have the following attributes:

sku (string, required)

Product stock-keeping unit.

name (string, optional)

Product name (default: “”).

category (string|Array, optional)

Product category or an array of up to 5 categories. Default: “”.

price (number|string, optional)

Product price has to be a float number or a string containing float number representation. Default: 0.

quantity (number|string, optional)

Product quantity has to be an integer number or a string containing integer representation. Default: 1.

brand (string, optional)

Product brand. Default: “”.

variant (string, optional)

Product variant. Default: “”.

customDimensions (object, optional)

Product custom dimensions. Default: {}.

paymentInformation (object, required)

Complete payment information for products in the cart. Expected attributes:

orderId (string, required)

Unique order identifier.

grandTotal (number|string, required)

The total value of items in a cart has to be a float number or a string containing float number representation.

subTotal (number|string, optional)

The total value of items in a cart without shipping has to be a float number or a string containing float number representation.

tax (number|string, optional)

The total tax amount has to be a float number or a string containing float number representation.

shipping (number|string, optional)

The total shipping cost has to be a float number or a string containing float number representation.

discount (number|string, optional)

The total discount has to be a float number or a string containing float number representation.

Examples

const options: TrackEcommerceOrderOptions = {
  visitCustomVariables: { index: { name: 'name', value: 'value' },
  customDimensions: { dimensionID: 'value', dimensionID: 'value', },
  discount: '18',
  shipping: '60',
  subTotal: '120',
  tax: '39.6',
};

const ecommerceProduct: EcommerceProduct[] = [
    {
      sku: 'craft-311',
      name: 'Unicorn Iron on Patch',
      category: ['Crafts & Sewing', 'Toys', 'Cosmetics'],
      price: '49,9089',
      quantity: 3,
      brand: 'DMZ',
      variant: 'blue',
      customDimensions: {
        1: 'coupon-2020',
        2: '20%',
      },
    },
];

let grandTotal: String = '10000';
let orderId: String = 'order-3415';
await PiwikProSdk.trackEcommerceOrder(orderId, grandTotal, ecommerceProduct, options);

Syntax

Parameters

Examples

Related methods