Passing Recommendations Using the JavaScript API

In order to use Reteno 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 Reteno account;
  • set up the passing of recommendations from Reteno to your website.

Settings Description

The JS API function is required to receive recommendations and their further use in product blocks on the site.

Scripts for receiving recommendations

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 ;
        }

});

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

NameTypeExampleDescription
variantIdRequired

String
r262v361The unique ID of the recommendation variation in the Reteno account.
productIdOptional

String
MX-1512\42To pass the product ID from the page the user is on.

Required parameter for recommendations using the product algorithm (similar products, products that were bought together with some items); for other types of algorithms, it is not necessary to pass.
productIdsOptional

List
['123', '543534']To pass a product ID or an array of cart product IDs.

Required parameter for recommendations using the product algorithm (similar products, products that were bought together with some items); for other types of algorithms, it is not necessary to pass.
categoryKeyOptional

String
JacketsTo pass the key of the category the user is in.

Required parameter for recommendations using a categorical algorithm (personally for you in this category); for other types of algorithms, it is not necessary to pass.
allFieldsOptional Booleantrue\falseParameter for determining which product attributes will be in the recommendation request: All (which are available in the product data feed) or only Required:

product_id
url
* container_type

Default parameter setting = false

Response example

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

Response body:

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

Type: List

Description:

  • product_id - recommended product ID
  • container_type must be used when passing the event ProductImpression
  • URL contains a link to the product, with an additional parameter for proper web tracking

❗️

Important

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

Error example

ExampleTypeDescription
variantId r262v361 was not found in configStringNo such recommendation variant identifier was found.

📘

Important

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

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