Skip to main content

​
Overview

PureClarity accepts a JSON based data feed format which contains all products in the e-commerce system and includes product information such as the product Id, name, image URL and prices. When a full feed is submitted it is used as the latest full version of all products that are currently live and available to customers. I.e. any products not sent in a new feed will no longer be used by PureClarity. Feeds can also contain category, brand, user and account pricing information.
The maximum size of a product feed is 250Mb.
As well as the full product feed, you can also send record deltas, which are updates to individual records that PureClarity holds. Please note that there are limits to the frequency you can send both full feeds and product deltas to PureClarity. Please see the Product Updates section on our pricing page for more information. The format of a feed is a JSON object, with 1 or more sections populated. Possible sections are:
As individual feeds can be large for bigger stores - consider sending multiple feeds to PureClarity, 1 for each type of data.
When using Categories or Brands, please include a Version field, set to 2.
Some examples can be found below. Please see the documentation for the relevant model. 
{
  "Products": [
    { <product1> }, ... ,{ <productN> }
  ]
}

{
  "Version":2,
  "Categories": [
    {<category1>}, ... ,{<categoryN>}
  ]
}

{
  "Version":2,
  "Brands": [ 
    {<category1>}, ... ,{<categoryN>}
  ]
}

{
  "Products": [ {<product1>}, ... ,{<productN>} ],
  "AccountPrices": [ {<price1>}, ..., {<priceN>} ],
}

{
  "Users": [ 
    { <user1> }, ... ,{ <userN> }
  ]
}
Below is an example of a user feed with custom fields. In this example “News” is a customer field to determine if a person has signed up to the newsletter and “HasChildren” if a person has indicated they have any children. 
{
  "Users":  [
    {
      "UserId": "02345",
      "Email":  "fred@smith.com",
      "FirstName": "Fred",
      "LastName": "Smith",
      "Salutation": "Mr",
      "DOB": "12/1/1988",
      "Gender": "M",
      "Country": "UK",
      "News": "Y",
      "HasChildren": "N"
    },
    {
      "UserId": "02346",
      "Email":  "jane.brown@outlook.com",
      "FirstName": "Jane",
      "LastName": "Brown",
      "Salutation": "Ms",
      "DOB": "12/1/1978",
      "Gender": "F",
      "Country": "UK",
      "News": "Y",
      "HasChildren": "Y"
    }
  ]
}