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.

Securityoauth2
Request
path Parameters
orderGuid
required
string

The Toast platform identifier of the order that you are updating the delivery information for.

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.

You can update the deliveredDate, dispatchedDate, deliveryState, or DeliveryEmployee.

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

deliveredDate
string <date-time>

The date on which the order was delivered.

deliveryEmployee
string <UUID>

The Toast platform identifier of the employee who is delivering the order.

deliveryState
string

The delivery state of the order.

Enum: "PENDING" "IN_PROGRESS" "PICKED_UP" "DELIVERED"
dispatchedDate
string <date-time>

The date on which the order was dispatched. If dispatchedDate is not specified, it is set to the current system time.

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
{
  • "deliveredDate": "2019-08-24T14:15:22Z",
  • "dispatchedDate": "2019-08-24T14:15:22Z",
  • "deliveryState": "PENDING",
  • "deliveryEmployee": "string"
}
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "openedDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "promisedDate": "2019-08-24T14:15:22Z",
  • "channelGuid": "3c66b5cf-1850-49e6-aef3-40576e6de979",
  • "diningOption": {
    },
  • "checks": [
    ],
  • "table": {
    },
  • "serviceArea": {
    },
  • "restaurantService": {
    },
  • "revenueCenter": {
    },
  • "source": "string",
  • "duration": 0,
  • "deliveryInfo": {
    },
  • "requiredPrepTime": "string",
  • "estimatedFulfillmentDate": "2019-08-24T14:15:22Z",
  • "numberOfGuests": 0,
  • "voided": true,
  • "voidDate": "2019-08-24T14:15:22Z",
  • "voidBusinessDate": 0,
  • "paidDate": "2019-08-24T14:15:22Z",
  • "closedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "businessDate": 0,
  • "server": {
    },
  • "pricingFeatures": [
    ],
  • "approvalStatus": "NEEDS_APPROVAL",
  • "guestOrderStatus": "string",
  • "createdDevice": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "initialDate": 0,
  • "lastModifiedDevice": {
    },
  • "curbsidePickupInfo": {
    },
  • "deliveryServiceInfo": {
    },
  • "marketplaceFacilitatorTaxInfo": {
    },
  • "createdInTestMode": true,
  • "appliedPackagingInfo": {
    },
  • "excessFood": true,
  • "displayNumber": "string"
}