Update delivery information

Updates the delivery information of an order that uses the DELIVERY dining option. You can use this endpoint to update the delivery time, dispatch time, the employee who is delivering the order, the delivery state, or a combination of the four. Specify the Toast platform GUID of the order in the PATCH path parameters. Returns a JSON Order object if successful.

For more information, see the Toast Developer Guide.

Request
path Parameters
orderGuid
required
string

The Toast platform identifier of the order that you are adding items to.

header Parameters
Toast-Restaurant-External-ID
required
string

The identifier of the restaurant.

Request Body schema: application/json

A JSON deliveryInfo object containing the delivery information you want to update for an order. This can be either the deliveredDate, dispatchedDate, deliveryState, or DeliveryEmployee.

These are the only values you can update with this endpoint.

string
Responses
200

Success. The response body contains the full order JSON, including information you updated in the deliveryInfo object.

400

The request contains data that is not supported by the API.

patch/orders/{orderGuid}/deliveryInfo
Request samples
application/json
"string"