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.

address1
required
string

The first line of the street address of the delivery destination.

address2
string

The second line of the street address of the delivery destination.

administrativeArea
string

The geographic or government division, larger than a city/town, for the delivery destination. For example, the name of a province, county, region, or state might be the administrativeArea value for a delivery address. This value is optional, not all delivery addresses include a regional area name other than a city. If you include the state value, you would typically not include an administrativeArea.

city
required
string

The name of the city or town of the delivery destination.

country
string

The two-digit ISO-3166-2 country code of the delivery destination.

deliveredDate
string <date-time>

The date and time that the delivery employee indicated in the Toast POS app that the order was delivered. Response only.

This value is only set when the dining option for the order is DELIVERY. For other dining options, the value is null.

object (ExternalReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

deliveryState
string

An internal representation of the state of a delivery order.

Valid values:

  • PENDING - The delivery is not dispatched. This corresponds to the Unassigned tab of the Delivery screen of the Toast POS app.

  • IN_PROGRESS - The order is on the way to the destination. This corresponds to the En Route tab of the Delivery screen of the Toast POS app.

  • PICKED_UP - The employee who delivers the order has picked up the order from the restaurant.

  • DELIVERED - The order was delivered. This corresponds to the Delivered tab of the Delivery screen of the Toast POS app.

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

The date and time that the restaurant indicated in the Toast POS app that the order was available for delivery and assigned to a delivery employee.

This value is only set when the dining option for the order is DELIVERY. For other dining options, the value is null.

latitude
number <double>

The north/south geographic coordinate of the delivery destination, in decimal format.

longitude
number <double>

The east/west geographic coordinate of the delivery destination, in decimal format.

notes
string

Additional instructions or information about the delivery.

state
required
string <ISO 3166-2>

The postal abbreviation of the state or province of the delivery destination.

The abbreviation must be in ISO 3166-2 format (two capital letters).

zipCode
required
string

The postal or zip code of the delivery destination.

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
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "administrativeArea": "string",
  • "state": "string",
  • "zipCode": "string",
  • "country": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "notes": "string",
  • "deliveredDate": "2019-08-24T14:15:22Z",
  • "dispatchedDate": "2019-08-24T14:15:22Z",
  • "deliveryEmployee": {
    },
  • "deliveryState": "PENDING"
}
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": {
    },
  • "owner": {
    },
  • "pricingFeatures": [
    ],
  • "approvalStatus": "NEEDS_APPROVAL",
  • "guestOrderStatus": "string",
  • "createdDevice": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "initialDate": 0,
  • "lastModifiedDevice": {
    },
  • "curbsidePickupInfo": {
    },
  • "deliveryServiceInfo": {
    },
  • "marketplaceFacilitatorTaxInfo": {
    },
  • "createdInTestMode": true,
  • "appliedPackagingInfo": {
    },
  • "captureSequenceKey": 0,
  • "excessFood": true,
  • "voidServiceCharges": false
}