This document contains general information, including the business logic for all of the delivery statuses and how those statuses can change throughout a Delivery.
What is a Delivery Status Group?
Delivery statuses are grouped into three categories: Active, Completed, and Canceled, which are used for display purposes. If you see a status group, the delivery could be in any status associated with that group; for instance, an "Active" delivery may be in the "Assigned" or "Started" status.
Delivery Group: Active
INITIALIZING
Definition: A delivery is in this status while the delivery information is being sent into DeliverThat’s system. Every newly created delivery goes through this status, and a delivery should only be in this status for less than 1 second.
UNASSIGNED
Definition: Delivery is in DeliverThat’s system but is not assigned to a driver.
User Notes
- Allow Store Admin / Operator to update every field up to 1 hour before pickup time.
-
- Store Admin / Operator can cancel a delivery in this status.
ASSIGNED
Definition: A driver has been assigned, but delivery has not yet started.
User Notes
- Store Admin / Operator will be able to modify all fields, except pickup and drop off addresses, 3 hours prior to pickup
- Store Admin / Operator can cancel the delivery. The delivery status will move to “canceled”
- Less than 3 hours to pickup, Store Admin / Operator will only be able to update the following fields:
- Delivery instructions
- Gratuity, but only if it’s greater than the previous inputted value
- Store Admin / Operator can cancel a delivery in this status, but if they cancel less than 3 hours to pickup, we will move the status of the delivery to “completed,” and it will be billed accordingly.
STARTED
Definition: A driver has taken action to start delivery in their mobile application.
User Notes
- Store Admin/Operator can only update the following fields:
- Gratuity, but only if it’s greater than the previous inputted value
- Delivery instructions
- Store Admin / Operator can cancel a delivery in this status, but if they cancel less than 3 hours to pickup, we will move the status of the delivery to “completed,” and it will be billed accordingly.
AT_PICKUP
Definition: A driver has arrived at pickup and is waiting to receive the food.
User Notes
- Store Admin / Operator can only update the following fields:
- Gratuity, but only if it’s greater than the previous inputted value
- Delivery instructions
- Store Admin / Operator can cancel a delivery in this status, but DeliverThat will move the status of the delivery to “completed,” and it will be billed accordingly.
DEPART_PICKUP
Definition: A driver has received delivery contents, received a signature from a restaurant employee, and has departed the restaurant location, and is en route to drop off.
User Notes
- Store Admin / Operator can only update the following fields
- Gratuity, but only if it’s greater than the previous inputted value
- Store Admin / Operator can cancel a delivery in this status, but DeliverThat will move the status of the delivery to “completed,” and it will be billed accordingly.
AT_DROPOFF
Definition: A driver has arrived at the drop-off location and is located where to set up.
User Notes:
- Store Admin / Operator can only update the following fields
- Gratuity, but only if it’s greater than the previous inputted value
- Store Admin / Operator can cancel a delivery in this status, but DeliverThat will move the status of the delivery to “completed,” and it will be billed accordingly.
DEPART_DROPOFF
Definition: A driver has completed the setup and has taken a setup picture.
User Notes
- Store Admin/Operator can only update the following fields
- Gratuity, but only if it’s greater than the previous inputted value
- Store Admin / Operator can cancel a delivery in this status, but DeliverThat will move the status of the delivery to “completed,” and it will be billed accordingly.
Delivery Group: Completed
COMPLETED
Definition: Driver has completed the delivery - Driver required to move to completed to finish the delivery
User Notes
- Store Admin/Operator can only update the following fields
- Gratuity, but only if it’s greater than the previous inputted value and only until the end of the day
Delivery Group: Canceled
CANCELED
Definition: The delivery was canceled by the merchant, customer, or a third party, with the option for additional notes in the Status Reason.
User Notes
- Only a DT Admin can modify canceled deliveries.
CANCELED_BILLABLE
Definition: The delivery was canceled but is still billable to the restaurant (most likely), with the option for additional notes in the Status Reason.
User Notes
- There are scenarios where it would be in this status, and the restaurant is not charged because refunds were added to the delivery (so the restaurant received a credit, etc.)
- Only a DT Admin can modify canceled deliveries.
CANCELED_EXCEPTION
Definition: The delivery was canceled by DeliverThat. This typically happens when a driver is unavailable.
User Notes
- Only a DT Admin can modify canceled deliveries.