API update announcements

The following table describes Toast API changes that may require updates to your API client software and the dates that those changes take effect in the Toast platform production environment. See information about all Toast API changes in API change log.

Important

The changes described in this section are a subset of all Toast API changes. For information about all API changes, see API change log.

Change

Change Announcement

Planned Production Deployment

APIs Affected

New selection type values for Toast gift card transactions

2023-11-13

2024-01-22

Orders

Menus API V3 filters menu entities for ordering partners

2022-10-05

To be determined

Menus

The following table describes Toast API changes that have already occurred.

Change

Change Announcement

Planned Production Deployment

APIs Affected

Labor API disabled value in Employee object will be removed.

2023-06-22

2023-11-27

Labor

New order source enumeration value

2023-01-06

2023-02-13

Orders

Customer object removed from loyalty API

2022-10-24

2022-11-01

Loyalty

New order source enumeration values

2022-11-18

2022-12-05

Orders

Loyalty reversal requests can include a null account identifier value

2022-01-21

2022-03-14

Loyalty

Gift card integration redeem transactions include cash out

2021-11-17

2022-01-17

Gift cards

Loyalty externalId for menu entities will be null

2022-02-09

First use of version 2.55 of the Toast POS app. Expected 2022-02-23.

Loyalty

New Invoice order source

2022-01-31

2022-02-07

Orders

New pagination parameter, existing pagination parameter deprecated

2021-09-03

2021-12-06

Configuration