This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Updating delivery information for an order

Important

To use the /deliveryInfo endpoint, you'll need access to the orders.delivery_info:write scope. For more information about API client scopes, and how to get access to them, see Scopes.

You can use the orders API to update delivery information, including some of the following:

  • The current status of the delivery

  • The employee who makes the delivery (requires additional permissions)

  • When the order was dispatched

  • When the order was delivered

The delivery location values (for example, street address and city) and the delivery notes value cannot be updated.