get https://api.apicbase.com/api/v2/menu_planning/menu_cycle_instance/planned_recipes/calendar
Returns a list of recipes by date according to the schedule.
This endpoint provides a list of recipes that are part of a menu cycle for each date within the specified range, across the entire library.
The resulting JSON object is organized by date, allowing for easy querying to determine which recipes should be produced on a specific date based on the schedule.
Query Parameters
from_date(required): The start of the date range to query, in ISO format (YYYY-MM-DD).to_date(required): The end of the date range to query, also in ISO format (YYYY-MM-DD).number_of_recipes_per_day(optional): Limits the number of recipes returned per day. Defaults to 5. When querying a date range (i.e., more than one day), this value must not exceed 10.
The result will include recipes with dates equal to from_date and to_date, not only between them.
For returning recipes of a single day, use the same date in both from_date and to_date parameters.
Constraints
from_datemust be earlier than or equal toto_date.- The range between
from_dateandto_datemust not exceed 31 days. - If querying a range longer than one day,
number_of_recipes_per_daymust not be greater than 10
The 'search' parameter
This parameter can take any value to perform a general search. The given value will be searched in the following fields:
- Menu cycle schedule: name, course name
- Menu cycle instance: course name
- Outlet: name
- Recipe: name