Filters
To highlight certain brands or health options in a recipe or shopping list, you can apply brand filters or health filters to some or all items in a request. When a customer navigates to the recipe page or shopping list page, these brands or health options are provided as part of the shopping list. If a brand match is not found at the store, an alternative is provided.
Instacart’s matching algorithm attempts to find, but can't guarantee, a direct match to your desired product list.
Add filters
You can specify preferred brands or health filters by making an API request with the Filter object set on some or all of the items. There is no limit to the number of brands or health options that can be added to a filters array; however, for best results, we recommend 10 or fewer brands or health options per item.
The Filter object consists of the following arrays:
brand_filters: An optional filter that returns only products of the designated brand names.health_filters: An optional filter that returns only the designated health specific products.
By keeping the brand names and health options separate from the product names, Instacart can match other similar products by any of the brand names in the array.
Brand filters
For brand_filters, add comma-separated brand names to the array. The brand filter is case-sensitive. Brand names must be spelled exactly as they appear on Instacart.
Health filters
For health_filters, add comma-separated health options to the array. The health filter is case-sensitive. Health options must be defined exactly as they're listed in the Filter Object.
Try it out
To try this out yourself, copy this sample request and substitute in your API key. Click the link in the response to confirm that the brands can be seen in the recipe page.
The following image shows a recipe page with brand filters applied:
