Skip to main content

Page types

Pages supported by Rokt Ecommerce

This table shows common page types supported by Rokt Ecommerce, as well as if a page type is considered transactional or non-transactional.

Page typeTransaction or non-transactionCart status
Product selectionTransactionIn-cart
UpsellTransactionIn-cart
Customer detailsTransactionIn-cart
ShippingTransactionIn-cart
Payment detailsTransactionIn-cart
Cart reviewTransactionIn-cart
ConfirmationTransactionPost-cart
Booking detailsNon-transactionPost-cart
Landing pageNon-transactionNon-cart
Enquiry formNon-transactionNon-cart

Page variants

Variants are groupings of layouts that should appear together on a page. Many variants will hold only one layout: the standard auto launch overlay widget which appears on the confirmation page. In the world of multiple layouts, a variant will commonly hold one overlay layout and at least one embedded layout-but could be any combination of layouts which should appear on the page.

There are three pieces of information that we need to know when adding a layout to a page variant:

  • What layout to show? (Select from a list of available layouts in the account)
  • When to show the layout? (Activation event)
  • Where to show the layout? (Target element)

This information is necessary to both render a layout and allow users to save the page. There are two rules for constructing page variants:

  • You are restricted to 1 overlay layout which loads automatically. We'd never want to show two overlay layouts at once to a customer.
  • Embedded layouts cannot have the same target element within a variant

What's a target element?

A target element defines where you want to show Rokt content on your page. We do this by anchoring the layout to an HTML element. The layout will render on the page where the CSS selector matches the defined selector for that layout in the page variant settings. You can elect to define an element when linking your layout to a page or implement a default element id suggested by Rokt as a placeholder when integrating the Rokt tag on your site.

Target element is an optional field for overlay layouts which launch automatically when a page loads. The layout will load over the entire page, so anchoring them to a specific element on a partner's page is not necessary.

What's an activation event?

An activation event is used to determine when you want to show Rokt content on your page. There are a few different activation event options offered by Rokt:

We currently support two activation events:

  • Activate automatically - the layout will automatically be activated when the page loads.
  • Activate manually - the layout will not activate until the partner calls rokt.activate() function on a partner's page.

You select an activation event type for each individual layout per page-variant. A single layout can have different activation events depending on the page-variant selected. For example, a partner may want to load a overlay layout automatically on the confirmation page, but launch the same layout manually on the view booking details page.

Was this article helpful?