Warning

This site is no longer being maintained. Visit the eDocs documentation portal for updated information.

Visit eDocs
Dismiss message

Integrating Add to Cart and Checkout

Created by Iván Tajes · last update December 16, 2019

Identifying a product page and integrating add2Cart and checkout

EmpathyX public API offers ways to identify a page as a product page and facilitates tracking of add2Cart and checkout.

For this integration to work properly, it is mandatory that the landing on the PDP page comes from an EmpathyX search. If we visit the PDP page directly without searching for or clicking on any product in EmpathyX, this add2cart logic will not work because the action of clicking on a result causes the item to be stored in local storage (to be used later).

Method Parameter Description
productPage productId: string This function must be called after initializing EmpathyX in a product page, passing the current product id as parameter. Please note that the productId must be an existing field in the feed and should be specified beforehand to our team. This method gets the result from the localStorage and moves it to the sessionStorage. The best practice is launching this call when the PDP load.
add2CartOnProductPageClicked   This function should be hooked into the add2cart’s button onclick handler and it doesn’t need any parameter. This method gets the result from the sessionStorage and launch a tagging request in order to track de add2cart event.
checkout productsIds: string / string[] This function should be hooked into the checkout’s button onclick handler. It expects the checkout/baskets product id/list of products ids.
Identifying a product page Integrating add2Cart Integrating checkout

In order to allow EmpathyX to identify the current page as a product page, our public API has a productPage function that only requires a string parameter (the product id that the page belongs to).

Please note that the productId must be an existing field in the feed and should be specified beforehand to our team.

1
2
3
4
5
6
7
8
9
10
function initEmpathyX() {
  EmpathyX.init({
    instance: '{API_INSTANCE}',
    lang: 'en',
    scope: 'mobile',
    currency: 'EUR',
    consent: false
  });
  EmpathyX.productPage('{PRODUCT_ID}');
}