The method returns an API response when requesting product recommendations.
Syntax and parameters
sdk.recommend(params) { callback }
Name
Type
Requirement
Description
params
enum
required
Request parameters.
callback
function
required
A callback function, to which the API response will be passed.
Request parameters
Name
Type
Requirement
Description
blockId
string
required
Unique code of the recommendation block. See this value in the "data-recommender-code" attribute of the block created in PersonaClick account.
currentProductId
string
required in some cases
Product ID. This parameter is mandatory for the requests of blocks with algorithms that depend on the current product. Algorithms: "Similar", "Products usually purchased with this product", "Store recommendations", etc.
currentCategoryId
string
required in some cases
The parameter allows filtering products by a specified category, for example for the "Popular" algorithm in a category.
API response properties
Name
Type
Description
html
string
HTML-code of the block with products. The template is customized in the PersonaClick account.
title
string
The block title. Corresponds to the value of the "Action" element in the block rules.
recommends
Object Array
An array of objects with product information. Each object has the following properties:
barcode – product barcode, if it was imported in the product catalog (type: string)
brand – product vendor (type: string)
currency – product currency (type: string, matches the currency of the PersonaClick account, or the user value set in the settings of the PersonaClick account)
id – product ID (type: string)
isNew – new arrival product (type: boolean). See the parameter in the product catalog import (XML,HTTP API)
model – model and product name (type: string)
name – product name (type: string)
oldPrice – old price of the product with zeroed pennies (type: double)
oldPriceFormatted – formatted integer old price of the product, including currency (type: string)
oldPriceFull – old price of the product (type: double)
oldPriceFullFormatted – formatted old price of the product, including currency (type: string)
params –JSON of object arraywith pairs of "key" (type: string), "values" (type: array) properties. The data matches the values of the "param" parameter of the product feed/catalog (XML,HTTP API).
picture – link to the product image in the PersonaClick image repository (type: string)
price – current price of the product with zeroed pennies (type: double)
priceFormatted – formatted integer current price of the product, including currency (type: string)
priceFull – current price of the product (type: double)
priceFullFormatted – formatted current price of the product, including currency (type: string)
url – product page URL (type: string)
id
number
Unique block identifier. Corresponds to the block ID in the list of blocks in the PersonaClick account.
Examples of use
For blocks with algorithms without any additional parameters:
sdk.recommend(blockId: "1fd1b3495137bc3c9299816026acf36f") { recommendResult in
// the functionality of rendering a block of product recommendations
}
For blocks with algorithms that require the "Product ID":
sdk.recommend(blockId: "1fd1b3495137bc3c9299816026acf36f", currentProductId: "100500") { recommendResult in
// the functionality of rendering a block of product recommendations
}
Filtering by category:
sdk.recommend(blockId: "1fd1b3495137bc3c9299816026acf36f", currentCategoryId: "146") { recommendResult in
// the functionality of rendering a block of product recommendations
}