DATE:
AUTHOR:
The Toast - API team
Menus API Objects, fields, and values

kitchenName and prepStations added to ModifierOption object in the menus API

DATE:
AUTHOR: The Toast - API team

The ModifierOption object of the menus API has been updated to include a kitchenName value. This value specifies the name that appears on kitchen tickets for the modifier. The kitchenName value is null if a kitchen name is not configured for the modifier.

The ModifierOption object of the menus API has also been updated to include a prepStations value. This value contains an array of GUIDs for the prep stations that have been assigned to this modifier option.

If a modifier's item reference has prep stations assigned to it, then the modifier uses those prep stations. If the modifier's item reference does not have prep stations assigned to it, then the modifier inherits the prep stations of the menu item, menu group, or modifier (in the case of nested modifiers) it is modifying.

The array is empty if no prep stations have been assigned to the modifier.

Like all changes to the menus API, this new value will become available in the menu JSON after a restaurant has made a menus-related change and published the new menu, which initiates regeneration of the restaurant's menus data. For more information, see Menus API returns published data only.

This change has been made to both V2 and V3 of the menus API.

Note

For information on the differences between V2 and V3 of the menus API, see Comparing menus API V2 and V3.

Powered by LaunchNotes