Page Comparison

Method Objective

The method returns an API response when requesting product recommendations.

Note
Please note that the priority way of placing the product recommendations blocks on the site is to insert the DIV tag created in the PersonaClick account and fill it automatically with the PersonaClick 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 parameters

Code Block

theme	FadeToGrey

personaclick("recommend", code, params, success, error);

Name	Type	Requirement	Description
code	string	required	Unique code of the recommendation block. See this value in the "data-recommender-code" attribute of the block created in PersonaClick account.
params	object	required	Object with request parameters.
success	function	required	A callback function, to which the API response will be passed. Response type: object.
error	function	optionally	A callback function that will be called when an error occurs (any HTTP status code other than 200).

Request parameters

Name	Type	Requirement	Description
item	number/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.
exclude	array	optionally	Product IDs array, which should be excluded from the recommended products list.
category	number/string	required in some cases	Category ID. This parameter is mandatory for all blocks set on category pages.
search_query	string	required in some cases	The text of the search query. This parameter is mandatory for the requests of blocks that use the "Search" algorithm.
limit	number	optionally	A maximum number of products per page.
locations	array	optionally	Array with location IDs. If used, the API response will return products available in the listed locations.
brands	array	optionally	Array with brand names. If used, only the products of the listed brands will be returned in the API response.
exclude_brands	array	optionally	Array with brand names. If used, the API response will exclude the products of the listed brands.
categories	array	optionally	Array with category IDs. If used, the API response will only return products that are included in the listed categories.
discount	boolean	optionally	If 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.
resize_image	number	optionally	Product Image Size. Available values (px): 120, 140, 160, 180, 200, 220. The default is the original size.
extended	number	optionally	Allows getting extended information about products for self-rendering of the recommended products widget. See the "recommends" property of the API response. Default: false
prevent_shuffle	boolean	optionally	If set to true value this will disable product shuffling in the API response.
page	number	optionally	Used when pagination is needed. The API returns products of the specified page and limit (limit is set in the block's settings in the account or as an additional parameter in the request).

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	Array/Object Array	Depending on the value of the "extended" parameter in the API request, it returns either an Array or an Object Array. The Array contains only product IDs. The Object Array contains objects with the following properties: barcode – product barcode, if it was imported in the product catalog (type: string) brand – product vendor (type: string) categories – an Object array with details of the product category hierarchy, where each object has properties: "id" – category ID (type: string) "level" – сategory level in the hierarchy (type: string) "name" – category name (type: string) "name_with_parent" – string name from the name of the parent and main product categories, separated by a "-" (type: string) "parent_id" – parent category ID (type: string) "url" – category page url (type: string) category_ids – an array of IDs of the product category hierarchy (type: String array) currency – product currency (type: string, matches the currency of the PersonaClick account, or the user value set in the settings of the PersonaClick account) discount – the percentage difference between the old price and the current price (type: number) discount_formatted – the percentage difference between the old and the current price that is formatted as a string with the "%" symbol (type: string) id – product ID (type: string) image_url – URL of the original product image (type: string) image_url_handle – relative URL of the original product image (type: string) image_url_resized – the object with the URLs of the resize product image. Available object keys matching the size of the image in pixels: 120, 140, 160, 180, 200, 220, 310, 520 (type: object) is_new – new arrival product (type: boolean). See the parameter in the product catalog import (XML, HTTP API) leftovers – rough number of the products left in stock. Available values are: "one" - one product "few" - 2-10 products "lot" - over 10 products model – model and product name (type: string) name – product name (type: string) oldprice – integer old price of the product (type: number) oldprice_formatted – formatted integer old price of the product, including currency (type: string) oldprice_full – old price of the product (type: number) oldprice_full_formatted – formatted old price of the product, including currency (type: string) params – object array with 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 – integer current price of the product (type: number) price_formatted – formatted integer current price of the product, including currency (type: string) price_full – current price of the product (type: number) price_full_formatted – formatted current price of the product, including currency (type: string) rating – product rating (type: number) relative_sales_rate – level of sales of current product ( in percentage) in relation to the maximum level of sales of products in the store (type: number) sales_rate – level of product sales (absolute value) (type: number) url – product page URL (type: string) url_handle - relative product page URL (type: string)
id	number	Unique block identifier. Corresponds to the block ID in the list of blocks in the PersonaClick account.
snippet	string	JS snippet code attached to the recommender.

Examples of use

For blocks with algorithms that require the "Product ID":

Code Block

language	js
theme	FadeToGrey

personaclick("recommend", "1fd1b3495137bc3c9299816026acf36f", {item: 100500}, function(response) {
  // the functionality of rendering a block of product recommendations
}, function(error) {
  // when something went wrong
});

For blocks with algorithms that require the "Category ID":

Code Block

language	js
theme	FadeToGrey

personaclick("recommend", "1fd1b3495137bc3c9299816026acf36f", {category: 146}, function(response) {
  // the functionality of rendering a block of product recommendations
}, function(error) {
  // when something went wrong
});

For blocks with an algorithm that requires the "Search Query":

Code Block

language	js
theme	FadeToGrey

personaclick("recommend", "1fd1b3495137bc3c9299816026acf36f", {search_query: "To be or not to be"}, function(response) {
  // the functionality of rendering a block of product recommendations
}, function(error) {
  // when something went wrong
});

Full example:

Code Block

language	js
theme	FadeToGrey

personaclick("recommend", "1fd1b3495137bc3c9299816026acf36f", {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], extended: true}, function(response) {
  // the functionality of rendering a block of product recommendations
}, function(error) {
  // when something went wrong
});

Column

Page Navigation

Table of Contents

maxLevel	3
indent	0px
style	none

Related Pages

Filter by label (Content by label)

showLabels	false
showSpace	false
sort	title
cql	label = "recommenders"

Versions Compared

Old Version 18

New Version 19

Key

Method Objective

Syntax and parameters

Request parameters

API response properties

Examples of use