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 order source enumeration values

2022-11-18

2022-12-05

Orders

Customer object removed from loyalty API

2022-10-24

2022-11-01

Loyalty

Menus API V3 filters menu entities for ordering partners

2022-10-05

2023-01-13

Menus

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

Change

Change Announcement

Planned Production Deployment

APIs Affected

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

Orders API bulkOrders endpoint rate limit reduced

2021-05-27

2021-07-12

Orders

Correct price information for reused modifier options with menu-specific pricing

2021-06-11

2021-06-21

Menus

Credit cards API will not return null denial reasons

2021-04-28

2021-05-10

Credit cards

Refund information changes in `Order` object changes to support new refund functionality

2021-01-13

2021-01-27

Orders, loyalty

Service charges persist correctly for dine-in orders

2020-10-01

2020-10-05

Orders

Integration test required before authentication service upgrade deployed in production environment

2020-08-28

2020-09-17

Toast API servers: cash management, configuration, credit cards, labor, menus, orders, partners, restaurants, stock, partner

Stock API verifies that menu items exist and are not archived

2020-07-03

No longer planned

No longer planned

New authentication endpoint for Toast APIs, old authentication endpoint sunset

2020-05-01

2020-06-30

Toast API servers: cash management, configuration, credit cards, labor, menus, orders, partners, restaurants, stock, partner

New values for credit card authorization

2020-05-01

2020-06-30

Credit cards

New modifierOptionTaxInfo value, taxInfo value replaced

2020-03-06

Postponed

Postponed

Menu entity visibility changes

ORDERING_PARTNERS enum is available in production

2020-04-17

2020-05-25

Menus

Menus API v1 sunset

2020-02-14

2020-05-25

Menus

Configuration API pagination links corrected

2020-03-20

2020-04-20

Configuration

TimeEntry object returns rounded hour values

2020-01-16

2020-02-24

Labor

New PROCESSING_VOID payment status value

2019-12-13

2020-01-27

Orders

Menu JSON data export will be removed

2019-10-11

2020-01-20

All

applicableDiscounts endpoint returns correct discounts

2019-09-20

2019-09-25

Orders

Service charges can be calculated before or after discounts

2019-08-16

2019-09-23

Orders, Configuration

Rate limiting changes

2019-07-12

2019-08-26

All

Credit cards API validates zip code and CVV

2019-07-12

2019-07-29

Credit cards

Labor API returns success response when deleting already deleted resources

2019-07-12

2019-07-22

Labor

Labor API rejects employee names with special characters

2019-06-14

2019-07-22

Labor

Restaurants API no longer returns archived restaurants

2019-06-14

2019-07-22

Restaurants

Restaurants API no longer returns deleted services

2019-06-07

2019-06-24

Restaurants

My Integrations configuration page changes for restaurants

2019-05-30

2019-06-06

All

Orders API uses updated tax calculation algorithms

2019-04-12

2019-06-15

Orders

Restaurant access endpoint removed from user management API

2019-04-12

2019-07-16

Partners

Menu data export menu-specific prices corrected

2019-03-22

2019-04-03

Menu data export files

Orders API enforces units of measure

2019-02-15

No longer planned

No longer planned

Discount support changes in the orders API

2019-02-15

2019-04-01

Orders

Credit cards API enforces required authorization request values and ISO 8601 date/time format

2019-01-25

2019-04-01

Credit cards

New Validation of Credit Card Information

2018-12-26

2019-01-31

Credit cards

Credit cards API will require willSaveCard and cardNumberOrigin values

2018-10-19

2018-11-30

Credit cards

Orders API enforces minimum selections for modifier groups

2018-10-19

2018-11-19

Orders

New tax configuration options at Toast POS system restaurants

2018-08-24

2018-10-03

Orders

Fixed check discounts applied before percentage check discounts

2018-07-31

2018-08-06

Orders