API requests (current functional) - EN documentation - REES46 Manual
Page tree
Skip to end of metadata
Go to start of metadata

Please note that the priority way of placing the product recommendations blocks on the site is to insert the DIV tag created in the REES46 personal account and fill it automatically with the REES46 library. The instruction below is intended for exceptional cases when an automatic drawing of the block doesn't give the maximum necessary functionality.

Syntax and method parameters

r46("recommend", "dynamic", params, success, error);


NameTypeRequirementDescription
paramsobjectrequiredObject with request parameters.
successfunctionrequiredA callback function, to which the API response will be passed. Response type: object.
errorfunctionoptionallyA callback function that will be called when an error occurs (any HTTP status code other than 200).

Request parameters

NameTypeRequirementDescription
codestringrequiredUnique code of the recommendation block. See this value in the "data-recommender-code" attribute of the block created in REES46 personal account.
itemnumber/stringrequired in some casesProduct ID. This parameter is mandatory for the requests of blocks that use the algorithms "Similar" and "Also bought".
excludearrayoptionallyProduct IDs array, which should be excluded from the recommended products list.
categorynumber/stringrequired in some casesCategory ID. This parameter is mandatory for all blocks set on category pages.
search_querystringrequired in some casesThe text of the search query. This parameter is mandatory for the requests of blocks that use the "Search" algorithm.
limitnumberoptionallyA maximum number of products in the API response.
locationsarrayoptionallyArray with location IDs. If used, the API response will return products available in the listed locations. Locations must be specified in the XML product feed.
brandsarrayoptionallyArray with brand names. If used, only the products of the listed brands will be returned in the API response. Brands must be specified in the XML product feed.
exclude_brandsarrayoptionallyArray with brand names. If used, the API response will exclude the products of the listed brands. Brands must be specified in the XML product feed.
categoriesarrayoptionallyArray with category IDs. If used, the API response will only return products that are included in the listed categories.
discountbooleanoptionallyIf used with "true" value, then only those products, the value of which is less than the "oldprice" value, will be returned in the API response. The old price must be specified in the XML product feed.

API response

NameTypeDescription
htmlstringHTML-code of the block with products. The template is customized in the REES46 personal account.
titlestringThe block title. Corresponds to the value of the "Action" element in the block rules.
productsarrayArray with product IDs.
idnumberUnique block identifier. Corresponds to the block ID in the list of blocks in the REES46 personal account.

Example request for product recommendations

r46("recommend", "dynamic", {item: 100500, exclude: [3, 14, 159, 26535], category: 146, search_query: "To be or not to be", limit: 15, brands: ["Alas", "poor", "Yorick"], categories: [1, 146, 100500]}, function(response) {
  // the functionality of rendering a block of product recommendations
}, function(error) {
  // when something went wrong
});
  • No labels