API


Product API

The Product API is made up of several methods to return product data, including a product set, product histogram and individual product. Additional product query parameters, similar to query parameters used by the ShopStyle website, can be found detailed below.

Query Parameters

Many of the methods listed in the next section accept this set of optional product query parameters, which are similar to query parameters used by ShopStyle:

fts Text search terms, as a user would enter in a Search: field.
cat A product category. Only products within the category will be returned. The easiest way to find values for this parameter is to browse to a category on the ShopStyle website and take the last element of the URL path, e.g., from http://www.shopstyle.com/browse/dresses, use "dresses." Another way is to look at the complete list of categories returned by the /categories .
fl

Specify one or more filters on the query for brand, retailer, price, discount, and/or size. Each filter value has an initial letter and a numeric id. The easiest way to construct a filter list is to do a search on ShopStyle, select one or more filters in the UI, and copy the resulting URL. To convert brand or retailer names to ids, use the /brands and /retailers calls. Here is a sample URL showing sale clothing from two brands and one retailer:

http://www.shopstyle.com/browse/womens-clothes?fl=d0&fl=b3510&fl=b689&fl=r21

Filter prefixes are:

  • b - brand
  • r - retailer
  • p - price
  • d - sale
  • s - size
  • c - color
pdd A "price drop date" expressed as a number of milliseconds since Jan 1, 1970. If present, limits the results to products whose price has dropped since the given date.
sort The sort algorithm to use. Possible values are:

  • PriceLoHi - to sort by price in ascending order
  • PriceHiLo - to sort by price in descending order
  • Recency - to sort by the recency of the products
  • Popular - to sort by the popularity of the products