Food Filter
The filter
object filters the foods according to different criteria. Within the filter object, it is possible to add AND
or OR
logical operators, these operators are defined as must
or should
respectively.
How to use logical operators
Use the following syntaxis ask to filter fieldName1
and FieldName2
filter: {
must: [
{fieldName1: value1},
{FieldName2: value2}
]
}
Use the following syntaxis ask to filter fieldName1
orFieldName2
filter: {
should: [
{fieldName1: value1},
{FieldName2: value2}
]
}
Add recursive filters by combining must and should operators:
filter: {
should: [
{fieldName1: "value1"},
{
must: [
{fieldName2: "value2"},
{fieldName3: value3}
]
}]
}
For example, the above example describes how to filter value1
information or value2
and value3
values. Each value can have a different field type.
Available fields
Field Name
Type
Description
id
ID
Unique ID retrieved from the brandedFoods
or customFoods
search queries
Use this in the following:
externalID
String
Edamam o USDA unique ID, known ad foodID
Use this in the following:
tags
String
Predefined tag to be added to use it to filter food. Add one or more tags. For example: tags: ["tag1", "tag2"].
Use this in the following:
mealTime
MealTime
Valid values are: BREAKFAST
, LUNCH
, DINNER
, SNACK
, TREAT_DESSERT.
Use this in the recipeSearch query
barcode
String
Barcode number
name
String
Food Name
Examples
How to use tags
How to use mealTime
The following example filters the information of lunch and dinner meal times. See an example in the recipeSearch
documentation.
The following example filters the information of lunch or dinner meal times.
How to use ingredients
The following example filters the information by milk OR bread ingredients.
How to use nutrients
The following example filters the information by food that contains Vitamin A and Folic Acid. The nutrient value can be replaced by using any of the values listed on filed name column of the the Nutrient enum table
Last updated