DeliveryInfo

Information related to delivery orders. 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.

• 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.

• deliveryEmployee:
  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.

{
  "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": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string"
  },
  "deliveryState": "PENDING"
}