DeliveryInfo

Required if the dining option behavior is DELIVERY

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.

city
required
string

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

deliveredDate
string <date-time>

The date and time that the delivery employee indicated that the order was delivered in the Toast POS system. Response only. This value is only set when the dining option for the order is DELIVERY. For other dining options, the value is null. Use ISO 8601 date and time format for all Toast APIs.

object (ExternalReference)

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

dispatchedDate
string <date-time>

The date and time that the restaurant indicated that the order was available for delivery and assigned to a delivery employee in the Toast POS system. This value is only set when the dining option for the order is DELIVERY. For other dining options, the value is null. Use ISO 8601 date and time format for all Toast APIs.

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.

{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "zipCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "notes": "string",
  • "deliveredDate": "2019-08-24T14:15:22Z",
  • "dispatchedDate": "2019-08-24T14:15:22Z",
  • "deliveryEmployee": {
    }
}