posName added to menus API

For menus API V2, the Menu, MenuGroup, MenuItem, ModifierGroup, and ModifierOption objects have been updated with a posName value. This value contains the button label name displayed for the menu entity in the Toast POS app.

For menus API V3, the MenuGroup, MenuItem, ModifierGroup, and ModifierOption objects have been updated with the posName value. The Menu object has not been updated with the posName value in menus API V3.

posName contains an empty string if a posName has not been defined for the menu entity and the name value is used for the button label instead.

Like all changes to the menus API, these new values 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 applies 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.