Skip to main content
POST
/
getFilters
Get Filters API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/getFilters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "plumProAPI.mutation.getFilters",
  "tag": "plumProAPI",
  "variables": {
    "data": {
      "filterGroupCode": "Country",
      "includeFilters": "usa",
      "excludeFilters": "uae"
    }
  }
}
'
{
  "data": {
    "getFilters": {
      "status": 1,
      "data": [
        {
          "filterGroupName": "Country",
          "filterGroupDescription": "Filter by country",
          "filterGroupCode": "country",
          "filters": [
            {
              "filterValue": "United States",
              "isoCode": "US",
              "filterValueCode": "usa"
            }
          ]
        }
      ]
    }
  }
}

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.

​
Note:

  1. In the getFilter API Request, “includeFilters” & ” excludeFilters ” will only work by passing value in ” filterGroupCode ”
  2. 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

PropertyTypeDescription
filterGroupCodestringfilter category name representing a specific filter group applied
includeFiltersstringFilters that should be explicitly included
excludeFiltersstringFilters that should be explicitly excluded

​
Response Schema

PathTypeDescription
dataobjectRoot object containing the getFilters payload.
data.getFiltersobjectMain container for filter metadata.
data.getFilters.statusnumberAPI execution status. 1 indicates success.
data.getFilters.dataarrayList of filter groups supported by the catalog.
data.getFilters.data[].filterGroupNamestringDisplay name of the filter group (e.g., Country).
data.getFilters.data[].filterGroupDescriptionstringDescription of the filter group.
data.getFilters.data[].filterGroupCodestringInternal code for the filter group (e.g., country).
data.getFilters.data[].filtersarrayList of filter values inside the group.
data.getFilters.data[].filters[].filterValuestringDisplay name of the filter value (e.g., Afghanistan).
data.getFilters.data[].filters[].isoCodestringShort ISO code for the filter (e.g., AF).
data.getFilters.data[].filters[].filterValueCodestringInternal system code used in downstream APIs (e.g., afghanistan).

​
List of available filterGroupCode

Filter nameFunctionality
countryUsers can filter products based on the country
priceUsers can filter products based on price range (0 – 1,000, 10,000 – above, etc.)
voucher_categoryUsers can filter products based on categories like Electronics, Food & Restaurant
product_categoryUsers can filter products based on types like e-gift voucher, Experience, Physical voucher
currencyUsers can filter products based on the product currency (INR, USD, AUD, etc.)

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

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

Response

Filter list returned successfully.

​
data
object