1. Data Feeds
  2. Product Feed

Data Feeds

Product Feed

This section will describe the strcuture and format required for a custom product feed.

Product Data Feed:

The product data feed is required to use the following Shopbox features: Find Similar, New Products for You and Promotions for You. The table below describes the required fields and values. An example JSON is shown below the table.

Field Type Description Required
id String The product’s ID Yes
title String The product’s title Yes
description String The product’s description Yes
url String The product’s url Yes
image String URL for the product image to be displayed Yes
price JSON Map Key/Value pair of ISO 4217 currency codes and
product prices in required currencies. This is the
price as displayed on the product details page		 Yes
regular_price JSON Map Key/Value pair of ISO 4217 currency codes and
product prices before discounts or sales are
applied. This is the price as displayed on the
product details page		 Yes
stock Integer The quantity in stock Yes
brand String The product’s brand Yes
top_category String The main category the product comes under Yes
category_list List List of associated categories or keywords Ideal
created_at String ISO 8601 formatted datetime of when the
product page was first created		 Yes
updated_at String ISO 8601 formatted datetime of when the
product was last updated		 Yes
cart_id String The id of the add to cart button – used for in
app “add to cart” functionality		 No
custom_categorical JSON Map Key/Value pair of Customer defined fields which
lists of categorical data. Note that the value of
the inner map can be a list of just one element
per product. Common examples of categorical
data sources include: size, age_group, gender
and color		 No
custom_numerical JSON Map Key/Value pair of Customer defined fields which
contain numerical values. Common examples of
these include size, dimensions, and weight		 No
custom_metadata JSON Map Key/Value pair of Customer defined fields which
contains data to be stored along with product,
which may be used in fetching product
information. For example, it may include
additional urls which are associated with a product.		 No
active Boolean Is this product live and visible on the retailer’s site. No
sb_ignore Boolean A value of true will exclude this product from
appearing in recommendations of other products.
Note that recommendations will still be created for
this product.		 No
{
   "id":"inano123456",
   "title":"ipod-nano",
   "description":"It's the small iPod with a big idea: Video.",
   "url":"https://www.example.com/ipod-nano",
   "image":"https://www.example.com/images/ipod-nano.jpg",
   "price":{
      "EUR":"199.99",
      "GBP":"166.58"
   },
   "regular_price":{
      "EUR":"250.00",
      "GBP":"208.26"
   },
   "stock":55,
   "brand":"Apple",
   "top_category":"Consumer Electronics",
   "category_list":[
      "MP3 Player",
      "Music",
      "Flash Memory"
   ],
   "created_at":"2007-12-31T19:00:00-05:00",
   "updated_at":"2007-12-31T19:00:00-05:00",
   "cart_id":"cart_123456",
   "custom_categorical":{
      "color":[
         "red",
         "blue"
      ],
      "generation":[
         "6th"
      ]
   },
   "custom_numerical":{
      "width_mm":38.7,
      "weight_g":36.8
   }
}

SFTP Instructions:

For SFTP instruction please contact you customer success agent or alternatively email [email protected]

Previous <- Contextual grids
Next Order Feed ->