Technical Docs
Search…
⌃K

Generate Meal Plan

Use the generateMealPlan mutation to create a new meal plan week for the user.
By default, the meal plan is generated based on the user's goals, but you have the ability to overwrite the default settings by using the profileMealPlanSettings mutation.

How to Use

First Request

The first time a user requests generateMealPlan the request will immediately return success = true and mealPlan will be ready to be queried.

Generating a New Meal Plan

If Settings Haven't Changed

If the user's meal plan settings or goals have not changed since the previous meal plan was created then it will not be possible to generate a new meal plan until the last date in the current one has passed. This means that a user cannot generate a new meal plan if the last one is still running.
The mutation will return success=false when the user still has days left in their current meal plan.
You can force the generation of a new meal plan while the last day in the current one is still running passing the parameter addDays = true to the mutation. This is only available for the last day of the current meal plan, and it will append the new week to start the next day.

If Settings Did Change

If the user's meal plan settings (or goals) have changed since the previous meal plan was created then the process will resemble a first-time generation.
Please note that a meal plan is not automatically generated when the user's meal plan settings or goals change.
Deleting and generating a meal plan again
Delete a meal plan only if it hasn't started yet.
If you delete and generate a meal plan again without changing the user's goals or settings, the recipes displayed will remain the same. This occurs because the process will always look for the ideal initial combination according to the given user's goals.

Repeating a meal plan

The mutation accepts a repeat datetime parameter to repeat a past meal plan. The mutation will select the first 7 days in the user's history with a date greater than or equal to repeat. These days will be duplicated and set as the new meal plan.
Because the selected days are sorted and selected only by their date, they may have been generated from meal plans with different settings or have gaps in their original dates.
The mutation will return success=false when the user doesn't have at least 7 days with a date greater than or equal to repeat.
Defining the variety of recipes
Use the variety argument to generate a meal plan with less variety of recipes; therefore, this allows recipes repeated in the meal plan.
There are 3 levels of variety:
  • LOW: Generate three different meals in the week. For example, the meal plan generates three breakfasts, three lunches, three dinners, and three snacks distributed across the week.
  • MEDIUM: Generate 5 different meals in the week.
  • HIGH: All generated meals are different. This is the current behavior of the meal plan.
This is not a required argument, so if it is not defined, the high variety is set as default.
Get the information of the meal plan generated
Instead of executing the mealPlan query separately, include the mealPlan field in the response of the generateMealPlan mutation to retrieve the information of the generated meal plan.
Use this information to debug your meal plan or when the meal plan is generated quickly.
This is not recommended to be used in the Apps because of a timeout of 50 seconds.

Generate a meal plan based on a created template

Generate custom meal plans by using a meal plan template previously created. In addition, if you have a running meal plan, you can add the days from the meal plan template by using the addDays argument as true. For more information, refer to this example.
First, the user creates the meal plan template according to what best fits him and then uses the template ID to pass as an argument in this mutation.
For more information, refer to this example.

Generating a meal plan with a predefined calorie distribution

You may use the distribution arguments to generate a meal plan with a predefined distribution of calories per meal. For example, you may want that breakfast doesn't exceed 30% of total daily calories and dinner doesn't exceed 25%. The request for this example would look as follows:
Mutation
mutation {
generateMealPlan(
breakfastDistribution: 0.3
dinnerDistribution: 0.25
) {
success
message
}
}
It's important to notice that these percentages are per meal and not per meal tag, so if your meal plan's format contains 2 breakfasts, the generator will try to pick two breakfast recipes with calories equal to 30% each, this means that your 2 breakfasts will represent 60% of the daily caloric goal!

Couldn't generate a meal plan?

If you get the Couldn't generate a meal plan with the current settings message, check the meal plan settings by executing the debugMealPlanVariables query. For more information to know the causes and get the solution, see this document.

Arguments

Argument Name
Type
Description
addDays
Boolean
True to allow generating a new meal plan if a user is on her last meal plan day. This field is ignored if ignoreLock is true. Default is false. If the fromTemplate argument is used and the addDays is true, the template days are added to the current meal plan, instead of replacing the running days.
fromTemplate
ID
Use the meal plan template ID from which the meal plan will be generated.
ignoreLock
Boolean
True to allow generating a new meal plan any time, overwriting any pending days in the current plan. Default is false.
includeFavorites
Boolean
True to include 2 random recipes, extracted from the user's favorites, within the generated meal plan.
False no actions are executed and the number of generated days is still 7.
repeat
Datetime
Create a new meal plan repeating the 7 dates after repeat
in user's history. Default to null.
kcalLimit
Float
Sets an upper kcal limit per meal in the meal plan as a percentage of the daily goal. Default is 0.50.
maxNumOfServings
Int
A maximum number of servings per meal is allowed in the meal plan. Must be between 1 and 15. Default is 15.
maxServingWeight
Int
Maximum serving weight in grams per meal. Default is 600.
minServingWeight
Int
Minimum serving weight in grams per meal. Default is 100.
breakfastDistribution
Float
Percentage of the daily calories goal that each breakfast covers.
lunchDistribution
Float
Percentage of the daily calories goal that each lunch covers.
dinnerDistribution
Float
Percentage of the daily calories goal that each dinner covers.
snackDistribution
Float
Percentage of the daily calories goal that each snack covers.
maxTimeMinutes
Object that returns the maximum values for each meal. Expressed in minutes.
For example, maximum preparation time for the following meals:
  • breakfast: 15
  • lunch: 30
  • dinner: 40
  • snack: 30
maxIngredientsCount
Object that returns the maximum values for each meal. Expressed in minutes.
For example, maximum ingredient count for the following meals:
  • breakfast: 7
  • lunch: 5
  • dinner: 5
  • snack: 6
variety
MPVariety
Define the variety of the recipes generated in the meal plan. Possible Values: LOW, MEDIUM, or HIGH

Available fields

The following field will be part of the response.
Field name
Type
Description
success
Boolean
True if the meal plan template has been created. Otherwise, it displays False
message
String
Description of the result
mealPlan
Returns the information of the meal plan generated.

Examples

Create a new meal plan week for the user:

Mutation
Response
mutation {
generateMealPlan {
success
message
}
}
{
"data": {
"generateMealPlan": {
"success": true,
"message": "Meal plan generated."
}
}
}

Add days to the meal plan

Create another week when the last day from the last meal plan is still running:
Mutation
Response
mutation {
generateMealPlan(addDays: true) {
success
message
}
}
{
"data": {
"generateMealPlan": {
"success": true,
"message": "Meal plan generated."
}
}
}

Repeat a week

Repeat the week from 2020-05-20 to 2020-05-27. Remember that repeat has to be a DateTime in UTC timezone.
Mutation
Response
mutation {
generateMealPlan(repeat: "2020-05-20T10:25:14.120000Z") {
success
message
}
}
{
"data": {
"generateMealPlan": {
"success": true,
"message": "Meal plan generated."
}
}
}

Set the maximum preparation times and the maximum ingredients

Set the maximum preparation times and the maximum ingredients for the breakfast, lunch, dinner, and snack meals
Mutation
Response
mutation {
generateMealPlan (
maxTimeMinutes:{
breakfast:10,
dinner:5,
snack:200,
lunch:3
}
maxIngredientsCount:
{
breakfast:7,
dinner:5,
snack:5,
lunch:3
}
)
{
success
message
}
}
{
"data": {
"generateMealPlan": {
"success": true,
"message": "Meal plan generated."
}
}
}

Define a low variety of recipes

Request
Response
mutation {
generateMealPlan(variety: LOW) {
success
message
}
}
{
"data": {
"generateMealPlan": {
"success": true,
"message": "Meal plan generated."
}
}
}
Execute the mealPlan query to check the generated recipes.

Generate a Meal Plan based on a Meal Plan Template

The following example describes how to generate a meal plan based on a given template ID
Request
Response
mutation {
generateMealPlan(
fromTemplate: "TWVhbFBsYW5UZW1wbGF0ZTphNjc5NGIwYy1lN2Y4LTQ5ZDYtOWIxZC04M2ExZTY0MDExZmE="
) {
success
message
mealPlan {
day
date
}
}
}
{
"data": {
"generateMealPlan": {
"success": true,
"message": "Meal plan generated.",
"mealPlan": [
{
"day": 2,
"date": "2022-01-15 02:00:00+00:00"
},
{
"day": 1,
"date": "2022-01-14 02:00:00+00:00"
}
]
}
}
}
As follows find a step by step explanation of how to get the template ID and use it to generate a meal plan:

Add days from a meal plan to the current meal plan

The following example adds the days created in a meal plan template to the meal plan currently active.
Request
Response
mutation {
generateMealPlan(
fromTemplate: "TWVhbFBsYW5UZW1wbGF0ZToyYTVmY2Q3Zi0wNzJlLTRiMjYtOGE3ZC1iYTgxNDZhMmY3ZTQ="
addDays: true
) {
success
message
}
}
{
"data": {
"generateMealPlan": {
"success": true,
"message": "Meal plan generated."
}
}
}
In the following example, 5 days from the meal plan template is added to the current meal plan:

UI/UX example

In the same way, we have code examples, this is an implementation example in which see results of the API execution in the Suggestic App.
Login to the App, tap on the Meal Plan option, and the 7-day meal plan is listed. The information is separated per day and per meal type: