sortOrder added to the MenuItem and ModifierOption objects in the menus API

The MenuItem and ModifierOption objects now include a new sortOrder value. This value contains a number your integration can use to determine the order in which items or modifiers appear on kitchen tickets. The sortOrder value can be any positive or negative integer, or zero. The sortOrder value is null if a sort order has not been configured for the item or modifier.

Using the sortOrder value, you can create sorting logic for menu items and modifiers as needed by your integration. If your integration uses the sortOrder value, be sure to communication any expectations for how to set that value with your integrated restaurants so that their settings align with your integration's sorting logic. The Toast platform does not associate any specific ordering expectations with the number. It is up to the integration and the restaurant to agree on expected behavior.

To see the sort order for a menu item or modifier in Toast Web

1. Access Toast Web .

2. Choose Menus > Bulk management > Advanced properties to open the Advanced properties page.

3. From the Show/Hide menu, select Preparation > Sort Order to see the Sort Order column.

4. Expand the menus hierarchy on the Advanced properties page to locate the menu item or modifier item reference you want to edit.

   The Sort Order column shows the number assigned to the menu item or modifier.

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.

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