Skip to main content
Model available for use in the Templates, and also returned by PureClarity in server-side requests.
Any custom attributes sent in the feed will be available in the Template and returned in the server-side model. Access it using the same name that was provided in the feed.

​
Properties

​
title
string
The title of the recommender
​
type
string
set to recommender-product
​
items
array
The products to show in the recommenderEach product object contains:

​
Product Item Properties

​
items[].Id
string
The unique product Id
​
items[].Sku
string
The product sku
​
items[].Title
string
The product title
​
items[].Link
string
The url to the product
​
items[].Image
string
The url to the main product image
​
items[].ImageOverlay
string
The url to the overlay product image
​
items[].AllImages
array
Array of urls to the product images
​
items[].Description
string
The description of the product
​
items[].Categories
array
An array of category IDs that the product is associated with
​
items[].SearchTags
array
Search tags if provided in the feed
​
items[].AssociatedSkus
array
Child/Variant skus of the product, if provided in the feed
​
items[].AssociatedIds
array
Child/Variant ids of the product, if provided in the feed
​
items[].Brand
object
A brand object that is associated with the product. Only available if a brand Id was sent in the product feed that has associated brand data in the brand feed
​
items[].Price
number
The product price for the user/account
​
items[].DisplayPrice
string
The formatted price with currency for the product (e.g. $19.00)
​
items[].WasPrice
number
The previous price for the product
​
items[].DisplayWasPrice
string
The formatted was price with currency for the product (e.g. $19.00)
​
items[].CurrencySymbol
string
The currency symbol for this products price
​
items[].SavingPrice
number
The saving on the product, taken as the difference between Price and SalePrice
​
items[].SavingDisplayPrice
string
The formatted saving price with current for the product (e.g. $19.00)
​
items[].SavingPercent
string
Percentage saving for the product, between Price and SalePrice. Fixed to 0 dp
​
items[].OnOffer
boolean
True if the product is currently on offer. Set by the OnOffer property in the product feed model
​
items[].NewArrival
boolean
True if the product is new to the store. Set by the NewArrival property in the product feed model
​
items[].clickEvt
string
The JavaScript function to be executed on mouse down over the product elementImportant: This is required to track when users click through on a product. If this is omitted then reporting will be inaccurate
​
html
string
[Serverside mode only] The html rendered version based on the Template

​
Example

{
  "title": "Recommended for You",
  "type": "recommender-product",
  "items": [
    {
      "Id": "P41923",
      "Sku": "SKU-123",
      "Title": "Example Product",
      "Link": "https://example.com/products/example-product",
      "Image": "https://example.com/images/product.jpg",
      "Description": "A great product description",
      "Categories": ["3841", "3842"],
      "Price": 29.99,
      "DisplayPrice": "$29.99",
      "WasPrice": 39.99,
      "DisplayWasPrice": "$39.99",
      "CurrencySymbol": "$",
      "SavingPrice": 10.00,
      "SavingDisplayPrice": "$10.00",
      "SavingPercent": "25",
      "OnOffer": true,
      "NewArrival": false,
      "clickEvt": "_pc('track','click',{zoneid:'PDP01',campaignid:'123',id:'P41923'})"
    }
  ],
  "html": "<div class='pc-recommender'>...</div>"
}