Skip to main content
POST
/
fetchFilters
Fetch Filter API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/fetchFilters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "plumProAPI.mutation.fetchFilters",
  "tag": "plumProAPI",
  "variables": {
    "data": {
      "categoryType": "offers",
      "includeFilters": "5647",
      "excludeFilters": "6444",
      "countryIds": [
        976
      ]
    }
  }
}
'
{
  "data": {
    "fetchFilters": {
      "status": 1,
      "data": [
        {
          "filterGroupName": "Category",
          "filterGroupDescription": "Filter by offer category",
          "filterGroupCode": "voucher_category",
          "filters": [
            {
              "filterValue": "Food & Restaurant",
              "isoCode": "FR",
              "filterValueCode": "food_restaurant"
            }
          ]
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Request Schema

FieldTypeDescription
categoryTypeStringDefines the product category for which filters are requested.
includeFiltersStringComma-separated list of filter keys that must be explicitly included in the response.
excludeFiltersStringComma-separated list of filter keys that should be excluded from the response.
countryIdsArrayList of country IDs used to scope filters based on regional availability.

​
Response Schema

Field PathTypeDescription
data.fetchFilters.data.filtersArrayList of filter values applicable for the requested category and country
data.fetchFilters.data.filters[].filter_value_idNumberUnique identifier of the filter value
data.fetchFilters.data.filters[].filter_valueStringDisplay name of the filter value
data.fetchFilters.data.filters[].imageStringImage URL associated with the filter value. Empty if not available
data.fetchFilters.data.filters[].filtersArrayNested filters under the filter value. Currently empty
data.fetchFilters.data.filters[].categoryTypeStringCategory for which the filter applies (e.g. offers)
data.fetchFilters.data.filters[].countNumberNumber of items available for this filter value
data.fetchFilters.data.optionsArrayCurrently returned as an empty array for offers category
data.fetchFilters.data.brandsArrayCurrently returned as an empty array for offers category
data.fetchFilters.data.countriesArrayCountry-wise aggregation of available items
data.fetchFilters.data.countries[].countryIdNumberInternal country identifier
data.fetchFilters.data.countries[].countryNameStringName of the country
data.fetchFilters.data.countries[].countStringTotal number of items available for the country

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

application/json
​
query
enum<string>
default:plumProAPI.mutation.fetchFilters
required
Available options:
plumProAPI.mutation.fetchFilters
​
tag
enum<string>
default:plumProAPI
required
Available options:
plumProAPI
​
variables
object
required

Response

Filter list returned successfully.

​
data
object