Developer updates

Orders API Objects, fields, and values

New selectionType values in ordersBulk endpoint response

On 2025-05-26, the selectionType value in the Selection object in the orders API ordersBulk endpoint will include two new enumerated values. The following...

February 19, 2025

Orders API Objects, fields, and values

itemType value will be removed from orders webhook

On 2025-05-26 the payload of the orders webhook will no longer include the itemType value in the AppliedPackagingItem object. This value does not include any...

February 19, 2025

Orders API

Orders API will limit POST message body size to one megabyte

On 2025-05-12, the orders API will restrict the size of POST request message body parameters to 1 megabyte (1 MB). On 2025-05-12, if you include more than 1...

February 5, 2025

Menus API Objects, fields, and values

eligiblePaymentAssistancePrograms added to MenuItem object in menus API

The MenuItem object has been updated with an eligiblePaymentAssistancePrograms value. This value contains an array of strings that indicate which payment...

January 15, 2025

Tender API Objects, fields, and values

Tender API search configuration request will not include body parameter

On 2025-02-03, the tender API search configuration request sent by the Toast platform will no longer include a body parameter. The search configuration...

November 4, 2024

Authentication

Bearer authorization type string enforced for API authentication

When you authenticate your API client to use Toast APIs, you must provide a bearer-type authentication token in the Authorization header field of your...

October 28, 2024

Orders API Webhooks

New orders updated webhook

The Toast platform includes a new orders updated webhook. You can use the orders updated webhook to receive order updates as they occur. The orders updated...

October 3, 2024

Menus API

posName, posButtonColorLight, and posButtonColorDark added to Premodifier object in menus API

The Premodifier object of the menus API has been updated with the following values: When an employee configures the POS button color for a premodifier, they...

September 18, 2024

General API updates

OpenAPI specification files now available for Toast APIs

You can now download OpenAPI specification files for Toast platform APIs. OpenAPI is a standard for defining HTTP REST APIs. You can use OpenAPI...

September 11, 2024

Gift Cards API

New relatedTransaction value for gift cards API redeem transactions

The gift cards integration API includes a new relatedTransaction value in the TransactionInformationRedeem object for gift card redeem transactions. The...

September 5, 2024