JS API Requests for Different Site Page Types

In order to use Yespo product recommendation algorithms and customize their display on your side (appearance of blocks, display pages, etc.), follow these steps:

• install the script on the site to track the behavior of site visitors;
• upload product data feed to your Yespo account;
• set up the recommendation algorithm in your Yespo account.

Examples of Requests

On the Home Page and 404 Page

eS('getRecommendations', {
  'variantId': 'r554v778'
  }, function(error, products) {

  if (error) {
            console.error(error);
            return ;
        }

});

On the Product Page

eS('getRecommendations', {
  'variantId': 'r554v778',
  'productId': 'MX-1512\42'
  }, function(error, products) {

  if (error) {
            console.error(error);
            return ;
        }

});

On the Cart Page

eS('getRecommendations', {
  'variantId': 'r554v778',
  'productIds': ['123', '543534']
  }, function(error, products) {

  if (error) {
            console.error(error);
            return ;
        }

});

On the Cart Pop-up

Use the StatusCartPage event to determine the page type and display recommendations on the cart pop-up. Example:

eS('sendEvent', 'StatusCartPage');

On the Categories Page

eS('getRecommendations', {
  'variantId': 'r554v778',
  'categoryKey': 'cK'
  }, function(error, products) {


  if (error) {
            console.error(error);
            return ;
        }
});

The JS API method is asynchronous, which allows not to wait for the execution of other functions on the site.

Request Parameters

Response Example

Upon successful submission of the request, you will receive a response similar to the following:

[
 {
 "product_id": "02G439",
 "container_type": "19534_r24v435",
 "url": "https://…?sc_content=19534_r24v435"
  // and other product attributes from the feed
  }
]

Important
Don’t edit the return value in the URL field for web tracking to work correctly.

Error Example

Important
Send the ProductImpressions event after calling and displaying the recommendations block for proper tracking.

Filtering Recommendations

Filtering recommendations through the JavaScript API allows you to show products on your site by filtering recommendations based on data from the feed or contact information stored on your side. For example, you can filter recommendations by the city of residence, clothing size, favorite brand, promotional offer, etc.

Filtering recommendations through JS API saves you from changing the filtering rules in the data source in Yespo account every time.

Request format:

eS('getRecommendations', {
    variantId: 'r362v614',
                'filters': {
                       'include': [{'name': 'city', values: ['Kiev','Kharkiv']}]
                }
  },
  function(error, products) {
    if (error) {
      console.error(error);
      return;
    }
  }
);

Request parameters:

You can also define a field (parameter) by which product categories will be filtered in the feed for display in recommendations. To do this, specify the desired categoryField value in the request.

Example request:

eS('getRecommendations', {
    variantId: 'r1673v2111',
		categoryKey: 'BATHROOM',
    categoryField:'tags_all_category_names'
  },
  function(error, products) {
    if (error) {
      console.error(error);
      return;
    }
  }
);

where tags_all_category_names guarantees a search across all values in the category tree.

To set the appearance of recommendation blocks in eSputnik, please read this guide.