Introduction


The checkout page typically contains forms user needs to fill in ourder to make a purchase. Example checkout pages:

  • Payment details page
  • Shopping details page
  • etc

The following properties must be defined for the checkout pages of the online store: page, website, user, cart, version.

Required variables


page

You need to define only page.type variable in the digitalData.page object. All other variables are either optional or will be automatically filled by the SegmentStream SDK.

Usually the checkout step is divided into several steps. We recommend filling the page.category variable with words that best describe each step: ‘Authorization’, ‘Shipping’, ‘Payment’, ‘Order Review’.

More about the page object

Example:

  window.digitalData = {
    ...,
    page: {
      type: 'checkout',
      category: 'Shipping' //Value depends on the checkout step
    },
    ...
  }

cart

As the user completes checkout steps, the digitalData.cart object is enriched with new variables: vouchers, voucherDiscount, shippingCost, shippingMethod, paymentMethod.

Do not initialize a variable if its value is not yet known. For example, in the authorization step, you do not need to pass the shippingCost, shippingMethod, paymentMethod variables.

More about the cart object

Example:

window.digitalData = {
  ...,
  cart: {
    id: "CART2203",
    vouchers: [
      "MYVOUCHER1"
    ],
    voucherDiscount: 20,
    shippingCost: 5,
    shippingMethod: "DHL",
    currency: "GBP",
    subtotal: 100,
    total: 85,
    lineItems: [
      ...,
      {
        product: {
          id: "1234567890",
          url: "http://website.com/product.html",
          imageUrl: "http://website.com/image.png",
          thumbnailUrl: "http://website.com/image_thumb.png",
          name: "Big Boots",
          description: "Product description",
          manufacturer: "Timberland",
          category: ["Footwear","Boots"],
          currency: "GBP",
          unitPrice: 60,
          unitSalePrice: 50,
          skuCode: "TBL6065RW"
        },
        quantity: 2,
        subtotal: 100
      },
      ...
    ]
  },
  ...
}

website

You need to declare and fill in only 6 variables in the digitalData.website object. The following 3 variables are required: website.type, website.currency, website.environment. The remaining variables depend on the characteristics of your site.

More about the website object

Example:

  window.digitalData = {
    ...,
    website: {
      region: "London",
      regionId: "11",
      type: "desktop",
      language: "en-gb",
      currency: "GBP",
      environment: "production"
    },
    ...
  }

user

The composition of the digitalData.user object strongly depends on the requirements of the project. We recommend that you fill at least the following variables: userId, user.email, user.isLoggedIn, user.firstName, user.isSubscribed

If you do not have information about a particular property of a visitor, do not declare the variable. For example: you do not know if the visitor is subscribed to the email-list.
Correct: do not declare the variable digitalData.user.isSubscribed.
Wrong: declare a variable and assign it a value of FALSE.

More about the user object

Example:

window.digitalData = {
  ...,
  user: {
    firstName: "John",
    userId: "4638mn1",
    email: "[email protected]",
    isLoggedIn: true,
    isSubscribed: false
  },
  ...
}

version

The digitalData.version variable must be declared and filled when loading each page of the site.

More about the version variable

Example:

window.digitalData = {
  ...,
  version: '1.1.3',
  ...
}

Example


In the end, your code will be similar to:

window.digitalData = {
  page: {
    type: 'checkout',
    category: 'Checkout'
  },
  website: {
    type: "desktop",
    currency: "GBP",
    environment: "production"
  },
  user: {
    firstName: "John",
    userId: "4638mn1",
    email: "[email protected]",
    isLoggedIn: true,
    isSubscribed: false
  },
  cart: {
    id: "CART2203",
    vouchers: [
      "MYVOUCHER1"
    ],
    voucherDiscount: 20,
    shippingCost: 5,
    shippingMethod: "DHL",
    currency: "GBP",
    subtotal: 100,
    total: 85,
    lineItems: [
      {
        product: {
          id: "1234567890",
          url: "http://website.com/product.html",
          imageUrl: "http://website.com/image.png",
          thumbnailUrl: "http://website.com/image_thumb.png",
          name: "Big Boots",
          description: "Product description",
          manufacturer: "Timberland",
          category: ["Footwear","Boots"],
          currency: "GBP",
          unitPrice: 60,
          unitSalePrice: 50,
          skuCode: "TBL6065RW"
        },
        quantity: 2,
        subtotal: 100
      },
    ]
  },
  version: '1.1.3',
}

/**
 * SegmentStream JavaScript SDK snippet should be
 * placed after the digitialData object definition
 */

For convenience, we did not list the repeating elements of the items and lineItems arrays.

This document was last updated on April 13, 2020. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, please let us know!