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

posButtonColorLight and posButtonColorDark added to menus API

DATE:
AUTHOR: The Toast - API team

The Menu, MenuGroup, MenuItem, ModifierGroup, and Modifier objects of the menus API have been updated with the following values:

  • posButtonColorDark: Specifies the button color for the menu entity on the Toast POS app when the app is running in dark mode.

  • posButtonColorLight: Specifies the button color for the menu entity on the Toast POS app when the app is running in light mode.

When an employee configures a POS button's color, they select a color pairing that consists of two colors, one for light mode and one for dark mode. posButtonColorLight contains the HEX code for the light mode color. posButtonColorDark contains the HEX code for the dark mode color.

posButtonColorLight defaults to #f7f7f7 and posButtonColorDark defaults to #1a1c23, the HEX codes when the WHITE color pairing is chosen.

For a complete table of color pairing names and the color HEX codes for light and dark mode associated with each pairing, see this table.

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.

Powered by LaunchNotes