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
Toast-Alternate-Payment-Type-GUID header field in tender API	2025-07-03	2025-07-07	Tender
Tender API check information matches orders API check information	2025-03-21	2025-06-23	Tender
New cardType values in loyalty API Payment object	2025-04-16	2025-06-16	Orders
New cardType values in orders API Payment object	2025-03-14	2025-06-16	Orders
itemType value removed from orders webhook	2025-02-19	2025-05-26	Orders
New selection type values in ordersBulk response limit	2025-02-19	2025-05-26	Orders
Orders API POST request message body parameter 1 MB size limit	2025-02-05	2025-05-12	Orders
New order source values in orders API information	2025-03-31	2025-05-05	Orders

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

Change	Change Announcement	Planned Production Deployment	APIs Affected
No body parameter in tender API search configuration request	2024-11-04	2025-02-03	Tender
Accept header field in tender API requests	2024-09-05	2024-09-19	Tender
No body parameter in tender API search configuration request	2024-11-04	2025-02-03	Tender
Bearer string enforced in Authorization header field	2024-05-28	2024-10-28	All
Inventory update endpoint behavior change	2024-08-05	2024-08-26	Stock
TLS certificate provider change	2024-05-13	On or after 2024-05-20	All
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	2024-08-01	Menus
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