This method returns a list of available price filters.
http://api.shopstylecollective.com/api/v2/priceFilters?pid=YOUR_API_KEY
| mapped | Returns only mapped price filters if set to 'true' (default is 'false'). |
RESPONSE
A list of price filters.
SAMPLE JSON
{
"metadata": {
"label": "Price",
"pluralLabel": "Prices",
"name": "Price",
"shortName": "p",
"multiSelect": true
},
"priceFilters": [
{
"id": "20",
"name": "$0 – $10",
"longLabel": "$0 – $10",
"urlIdentifier": "20",
"minPrice": 0,
"maxPrice": 10,
"minPriceLabel": "$0"
},
{
"id": "21",
"name": "$10 – $25",
"longLabel": "$10 – $25",
"urlIdentifier": "21",
"minPrice": 10,
"maxPrice": 25,
"minPriceLabel": "$10"
}
]
}
To use price filters in product searches add a query parameter fl=pXYZ where XYZ is the id of the price filter.
For example, using the response from above, to search for 'red dresses' that are priced $10-$25:
http://api.shopstylecollective.com/api/v2/products?pid=YOU_APII_KEY&fts=red+dress&offset=0&limit=10&fl=p21
Notice the fl=p21 corresponds to the price filter with the id of 21.
For more info on product searches see: What are the query parameters?