DeliveryInfoUpdateRequest

The delivery information fields you can update with PATCH /orders/{orderGuid}/deliveryInfo.

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.

notes
string

Delivery notes provided by the guest who placed the order. Writing to this field overwrites the guest’s original notes and may result in the loss of important order information. Do not replace or remove the guest's notes.

{
  • "deliveredDate": "2019-08-24T14:15:22Z",
  • "dispatchedDate": "2019-08-24T14:15:22Z",
  • "deliveryState": "PENDING",
  • "deliveryEmployee": "string",
  • "notes": "string"
}