post https://canvas.xoxoday.com/chef/v1/oauth/api
Filters API allows you to identify filters that are available which can be applied to filter the products in Get Merchandise API
Note:
- In the getFilter API Request, "includeFilters" & " excludeFilters " will only work by passing value in " filterGroupCode "
- You can pass empty values in the getFilters API request for all the parameters to get a list of all the available filters
Get Filters API Schema
| Property | Type | Description |
|---|---|---|
filterGroupCode | string | filter category name representing a specific filter group applied |
includeFilters | string | Filters that should be explicitly included |
excludeFilters | string | Filters that should be explicitly excluded |
List of available filterGroupCode
| Filter name | Functionality |
|---|---|
| country | Users can filter products based on the country |
| price | Users can filter products based on price range (0 – 1,000, 10,000 – above, etc.) |
| voucher_category | Users can filter products based on categories like Electronics, Food & Restaurant |
| product_category | Users can filter products based on types like e-gift voucher, Experience, Physical voucher |
| currency | Users can filter products based on the product currency (INR, USD, AUD, etc.) |
| merchandise | Users can filter products based on merchandise categories (e.g., Apparel, Home, Lifestyle) |