Meal Plan

This is how the data structure of a Meal Plan object looks like:

{
  "meal_plan_id": "5f27a59a9a8641078c7057eeec0a1b90",
  "start_date": 
    ...
  "end_date":
    ...
  "meals": [
    {
      "id": "894f285cd9d543d3b78b374f59b56311",
      "meal_type": "MEAL_TYPE_BREAKFAST",
      "date_time":
        ...
      "content": {
        "recipe": 
          ...
      },
      "generated": true,
      "day_slot": 3,
      "date":
        ...
    },
    {
      "id": "aab8f93131724117836f8cab365518c6",
      "meal_type": "MEAL_TYPE_LUNCH",
      "date_time":
        ...
      "content": {
        "recipe": 
          ...
      },
      "generated": true,
      "day_slot": 4,
      "date":
        ...
    },
    {
      "id": "4b50cf3d2bf24ebe9c4630d2816fea99",
      "meal_type": "MEAL_TYPE_DINNER",
      "date_time":
        ...
      "content": {
        "recipe": 
          ...
      },
      "generated": true,
      "day_slot": 5,
      "date":
        ...
    },
    ...
  ],
  "result_code": "GENERATION_RESULT_CODE_SUCCESS"
}

The following attributes store the core information of a meal plan:

Attribute	Type	Description	Example Value
meal_plan_id	string	The meal plan identifier.	aab8f93131724117836f8cab365518c6
start_date	array	The start date of the meal plan.	See start_date.
end_date	array	The end date of the meal plan.	See end_date.
meals	array	The information on different meals included in the plan.	See meals.
result_code	string	The meal plan generation result code.	GENERATION_RESULT_CODE_SUCCESS: Appears when the meal plan is generated successfully. GENERATION_RESULT_CODE_NOT_ENOUGH_MEALS: Appears when the meal plan fails to generate due to an insufficient number or variety of meals available for you.

Each array further contains additional attributes as described below.

start_date/end_date

  "start_date": {
    "year": 2020,
    "month": 10,
    "day": 1
  },
  "end_date": {
    "year": 2020,
    "month": 10,
    "day": 10
  },

Attribute	Type	Description	Example Value
year	integer	The year.	2020
month	integer	The month.	10
day	integer	The day of the month.	1

meals

"meals": [
    {
      "id": "894f285cd9d543d3b78b374f59b56311",
      "meal_type": "MEAL_TYPE_BREAKFAST",
      "date_time":
        ...
      "content": {
        "recipe": 
          ...
      },
      "generated": true,
      "day_slot": 3,
      "date":
        ...
    },
    ...
    ],

Attribute	Type	Description	Example Value
id	string	The meal identifier.	894f285cd9d543d3b78b374f59b56311
meal_type	string	A label to identify the type of meal.	MEAL_TYPE_BREAKFAST MEAL_TYPE_LUNCH MEAL_TYPE_DINNER
date_time	array	This attribute is deprecated and displays the same value as the date attribute.	-
content	array	Contains the recipe data for the meal.	See Recipe Data.
generated	boolean	Shows whether the meal is auto-generated or has been manually added by the user to the meal plan.	true false
day_slot	number	The day slot assigned to the meal. Each day consists of up to 7 slots, each containing a single meal along with its recipe information.	3
date	array	The date assigned to the meal.	"date": { "year": 2020, "month": 10, "day": 1 }

The Meal Plan API provides the following endpoints:

Note: All Meal Plan API endpoints first check whether a meal plan is already assigned to the user. When not found, a meal plan gets created and assigned to the user automatically. This means there is no need to manually create a meal plan for the user.

Generate a Meal Plan

Get Meal Plan Settings

Update Meal Plan Settings

Get Meals

Add a Meal

Delete Meal