post https://canvas.xoxoday.com/chef/v1/oauth/api/
GetVouchers API enables the user to get a list of vouchers with desired filters available with the Xoxoday catalog
Get Voucher API Schema
| Parameter | Type | Description |
|---|---|---|
| limit | Int | Number of results to return per page (used for pagination). |
| page | Int | Page number of results to fetch when using pagination. |
| includeProducts | String | Comma-separated list of product IDs to explicitly include in the response. |
| excludeProducts | String | Comma-separated list of product IDs to explicitly exclude from the response. |
| sort | SortData | Sorting configuration (e.g., by price, name, popularity). |
| sort.field | String | The field name to sort by (e.g., "name") |
| sort.order | String | Sorting order → "ASC" for ascending or "DESC" for descending. |
| filters | Array of Object | List of filters to apply. Each filter object should contain a key and value. |
| filters.key | String | The filter key (e.g., country, currency, product_category). |
| filters.value | String | The filter value corresponding to the key (e.g., IN, USD, Electronics). |
Filter Reference Table
| Key | Value Type | Description |
|---|---|---|
| productName | String | Product names to be included |
| country | String | Countries to be included |
| price | String | Price range filters to be included |
| minPrice | String | Minimum price of the products looked for |
| maxPrice | String | Maximum price of the products looked for |
| currencyCode | String | Currency codes to be included |
| deliveryType | String | Delivery type to the voucher (realtime or delayed |
Implementation Notes
- To fetch exchangeRate in the GetVouchersAPI, pass "exchangeRate": 1 in the request body
- To fetch the list of filters, use GetFiltersAPI
- If the value type for a product is "open_value", please refer to the "minValue" and the "maxValue" parameters
- The values passed in the "fee" and "discount" parameters are in percentage (%)
- We recommend you cache the response from GetVouchersAPI in your database every time you sync our catalog
- Use filters “minPrice” and “maxPrice” along with “currencyCode”, as this allows you to search prices with respect to a specific currency. If no currency is provided, the filter will not be applied.
Learn about Error Handling, Rate limiting and Best Practice .