These endpoints allow users to interact with Apicbase's menu planning module, managing and retrieving scheduled menu cycles via the API.
While working with the menu planning API, you will encounter these concepts:
- A menu cycle schedule is the blueprint for a menu cycle. It encompasses information such as the duration of the cycle, the frequency with which it should repeat, and which recipes are served on which days of the week.
- A menu cycle instance is a specific iteration of a menu cycle based on the parameters defined in the schedule. While a schedule generically defines the weekdays and length of a cycle, an instance is mapped onto actual dates. This means that each instance contains the planned recipes for every date in the cycle.
- Planned recipes are added to courses, which belong to schedules. Each planned recipe corresponds to a day of the week and includes a designated portion quantity, serving as a baseline for production planning. Users have the flexibility to adjust this portion quantity for individual dates as needed.
Permissions
Standard permission rules apply, requiring users of user-based access tokens to have the same permission levels to interact with menu cycles through these API endpoints as they do when using the user interface.
Outlet users are limited to actions on menus that are linked to their outlets and not shared by any other outlets.