New calculatedGuestCount and guestCountWeight values in the orders API

The Order object in the orders API now includes a calculatedGuestCount value, and the Selection object now includes a guestCountWeight value. These values support the calculated guest count feature, which estimates how many guests an order served based on the items ordered.

A Toast POS location configures guestCountWeight for menu items and modifiers in the Menu Manager menu configuration tool in Toast Web. The value can include up to two decimal places. A null value means the location has not configured a weight for the item. A value of 0 means the item does not contribute to the estimate.

The Toast platform sets calculatedGuestCount when the order is placed. It adds the guestCountWeight of each item selection and modifier selection, multiplied by quantity. The value is null if the calculated guest count feature was not enabled for the location when the order was placed. The value is 0 if the feature was enabled but every item on the order had a weight of 0 or null. Later changes to item weights do not change the value for orders that were already placed. Modifying a placed order, for example by adding items, can recalculate the value. The existing guest count entered at the POS is unchanged.

For more information, see Calculated guest count and the Order and Selection objects in the orders API reference.