post
https://stagingstores.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 Voucher API
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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
Request 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 |
Response Schema
| Path | Type | Description |
|---|---|---|
| data | object | Root object containing the getFilters payload. |
| data.getFilters | object | Main container for filter metadata. |
| data.getFilters.status | number | API execution status. 1 indicates success. |
| data.getFilters.data | array | List of filter groups supported by the catalog. |
| data.getFilters.data[].filterGroupName | string | Display name of the filter group (e.g., Country). |
| data.getFilters.data[].filterGroupDescription | string | Description of the filter group. |
| data.getFilters.data[].filterGroupCode | string | Internal code for the filter group (e.g., country). |
| data.getFilters.data[].filters | array | List of filter values inside the group. |
| data.getFilters.data[].filters[].filterValue | string | Display name of the filter value (e.g., Afghanistan). |
| data.getFilters.data[].filters[].isoCode | string | Short ISO code for the filter (e.g., AF). |
| data.getFilters.data[].filters[].filterValueCode | string | Internal system code used in downstream APIs (e.g., afghanistan). |
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.) |
| lounge | Users can filter products based on available lounge locations (e.g., airport lounges) |