Skip to main content
Model about a product. Sent in data feeds and product deltas.
Set empty array fields to empty array brackets (e.g. [ ]) not empty strings.

Properties

Id
string
required
This is the unique Id of the product. For example, this could be the Sku. The Id must be unique across the product data feed.
Sku
string
Optional Sku of the product if this is different to the product Id.
Title
string
required
The name of the item as it will appear on the website.
Prices
array
required
Array of prices, entry per currency. Each price is a number followed by an ISO4217 currency code such as USD or GBP
SalePrices
array
Array of sale prices, entry per currency. Each price is a number followed by an ISO4217 currency code such as USD or GBP
Description
string
An optional, short, non-formatted description of the item. This field should not contain any HTML
Categories
array
required
An array of category IDs that the product is associated with. If the product exists in multiple categories send them all. These should match the IDs sent in the category feed. Categories should be set to an empty array (e.g. [ ] ), if not set for a record. Do not set to an empty string.
A relative or absolute URL pointing to the products page. If using an absolute URL, specify the URL without a protocol. E.g. // instead of http:// or https://
Image
string
required
An absolute URL pointing to the image of the product. It is best to reference an image which has the suitable dimensions as part of the template design. If possible, specify the URL without a protocol. E.g. // instead of http:// or https://
ImageOverlay
string
A relative or absolute URL pointing to an overlay image to display in the corner of items, such as an “on offer” badge. It is best to reference an image which has the suitable dimensions to the template design. If possible, specify the URL without a protocol e.g. // instead of http:// or https;//
Brand
string
Optional brand identifier. This should be the same as the ID included in the brand feed. Used to show brand information in the search auto-complete, and can be used in the templates.
SearchTags
array
Optional array of text to help PureClarity find products as part of search specific recommenders and for use with segment rule building.
AssociatedSkus
array
An optional array of associated skus. For example if the product is made up of variant products (i.e. a configurable product) this can be provided which will help in search recommenders or allow for tracking products where a particular variant has been bought, and thus the variant sku has been sent in the tracking event
AssociatedIds
array
An optional array of ids of associated products. For example if the product is made up of variant products (i.e. a configurable product) this can be provided which will help in search recommenders or allow for tracking products where a particular variant has been bought, and thus the variant sku has been sent in the tracking event
AccountInclusions
array
Set of accounts where this product should be visible. If set, then the product will only be visible for these accounts. If no account information is present then these will be hidden from the user. This attribute is only valid for B2B sites where account information is being sent. It is mutually exclusive to AccountExclusions and a record with both is invalid.
AccountExclusions
array
Set of accounts where this product should be hidden. If set then the product will only be hidden for these accounts. If no account information is present or the account is not excluded then these will be visible to the user. This attribute is only valid for B2B sites where account information is being sent. It is mutually exclusive to AccountInclusions and a record with both is invalid.
ExcludeFromRecommenders
boolean
If present, and set to true then this product will be hidden from all recommenders. This can be useful to hide products that you never want to promote (such as a free catalogue) or to fulfil regulatory requirements. Default value is false.
OnOffer
boolean
If present, and set to true then this product will be considered “on offer” and may be shown as such in our automated recommendations. Default value is false.
NewArrival
boolean
If present, and set to true then this product will be considered new to the store and may be shown as such in our automated recommendations. Default value is false.
Array of SKUs of products that are related. Used to power the “Complete the look” recommendations in PureClarity. These should be products the site wants to recommend are purchased together.

Example

[
  {
    "Id": "prodCode23",
    "Sku": "PC093673",
    "Title": "Awesome Jeans",
    "Prices": [
      "1.00 GBP",
      "3.43 USD",
      "4.32 EUR"
    ],
    "SalePrices": [
      "0.90 GBP",
      "3.21 USD",
      "4.10 EUR"
    ],
    "Description": "Made of 100% denim with added stretch for comfort.",
    "Categories": [
      "Cat1234",
      "6712",
      "Hats"
    ],
    "Link": "//www.website.com/products/P1",
    "Image": "//www.website.com/thumbnail/image1.jpg",
    "ImageOverlay": "//www.website.com/thumbnail/on-offer.jpg",
    "Brand": "Aspire",
    "SearchTags": [
      "PartCodeA",
      "partCodeB"
    ],
    "AssociatedSkus": [
      "sku1",
      "sku2"
    ],
    "AssociatedIds": [
      "id1",
      "id2"
    ],
    "AccountInclusions": [
      "acc1",
      "acc2"
    ],
    "AccountExclusions": [
      "acc1",
      "acc2"
    ],
    "ExcludeFromRecommenders": true,
    "OnOffer": true,
    "NewArrival": true,
    "RelatedProducts": [
      "PC093672",
      "PC093674"
    ]
  }
]