Searches for products within the specified user's list(s).
http://api.shopstylecollective.com/api/v2/lists/search?pid=YOUR_API_KEY
QUERY PARAMETERS
| userId | ID of the user who's lists will be searched. Required |
| listId | ID of a specific list to search. Optional |
| fts | Free-text search term(s). Optional |
| fl | Filter terms to query for brand, retailer, price, discount, and/or size. Each filter value has an initial letter and a numeric id. Brand and retailer ids can be found by querying the brand and retailer apis. Filter prefixes are:
|
Here is an example query string showing products from two brands at one retailer that are on sale:
?pid=...&userId=...&fl=d0&fl=b3510&fl=b689&fl=r21https://shopstylecollective.zendesk.com/hc/en-us/sections/115000245306-Category-APIOptional; no filters by default
| 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 category api. Optional; defaults to all categories |
| sort | The sort method to use:
|
| limit | Number of results to return. Optional; defaults to 10 lists |
| offset | The starting index to return results from. Optional; defaults to 0 |
SAMPLE RESPONSE
{
"metadata": {
"offset": 0,
"limit": 10,
"total": 3
},
"favorites": [
{
"objectType": "Product",
"id": "5536a1440956f44f05eab45d",
"productId": 475538725,
"imageId": "991b4e200160e3d6f1c949249dd822cc",
"product": {...},
"date": {
date: "2015-04-21",
timestamp: 1429643588,
friendly: "Tue, Apr 21"
},
objectId: "475538725"
},
...
]
}