Tables and References

Abbrevation

Name

Description

PDT

planned delivery time

Manual input based on customer wishes.

TDT

target delivery time

Calculated possible time span of delivery, based on pre-defined time constraints and traffic forecasts.

DDT

driver delivery time

Time span of delivery to be communicated to the driver based on TDT.

ETA

estimated time of arrival

Time span of delivery to be communicated to the end customer based on TDT.
Used for customer notification.

ATA

actual time of arrival

Time of the driver's actual arrival at the customer's address (via driver's GPS position)

ATD

actual time of delivery

Time of the driver's actual succesful delivery at the customer's address (timestamp of POST /deliverydone/{delivery_id})

PPT

planned pickup time

Manual input based on customer wishes.

ELS

estimated length of stay (minutes)

ALS

actual length of stay (minutes)

TFP

driving time from preceding delivery

Delivery status

Status ID

Status key

Description

0

none

The delivery is either completely new and was never assigned to a tour or it was reset after canceling a tour containing this delivery. Deliveries in status 'none' can used for new tour planning processes and can also be deleted if needed. But be aware that you should never delete deliveries while there is a tour planning in process which uses these deliveries!

1

assigned

The delivery is assigned to a tour.

2

delivered

The delivery was assigned to a tour and successfully delivered by the driver to the recipient. Additional codes can be used (see Delivery codes below)

3

tooearly

The delivery was assigned to a tour, the tour has already been started and ETA calculations noticed that this delivery's ETA is predicted to be earlier than the planned delivery time (PDT) if there won't be any further delay or a driver break.

4

delayed

The delivery was assigned to a tour, the tour has already been started and ETA calculations noticed that this delivery's ETA is predicted to be later than the planned delivery time (PDT) and thus, there is a delay which is relevant for the customer.

5

cancelled

The delivery is marked as canceled and will not be reused for tour plannings (again)

6

problem

The 'problem' status can be used to indicate any kind of issues with this delivery. It has no technical implications on the tour itself

7

repeat

The delivery is marked as 'to be repeated'. This status is not used in the standard routing process but can be used by API developers to indicate that this delivery should be delivered again for some reason.

8

undelivered

The delivery was assigned to a tour and the driver tried to deliver it to the recipient but he/she was not successful (e.g. because the recipient was not at home). Additional codes can be used (see Delivery codes below)

9

notready

The delivery is created but not ready for tour assignment. This can e.g. happen if the order data is already processed but the item to be delivered is not yet available in the depot. Deliveries in this status will not be used for tour planning

10

inprogress

The delivery is currently processed by the routing algorithm. If the planning was successful the state changes to assigned or none in case of failure.

Delivery Codes

Code ID

Label (EN/DE)

1

'Delivery to the recipient' /
'Zustellung beim Empfänger'

2

'Delivery to a neighbor' /
Zustellung beim Nachbarn

3

'Delivery to a parcel shop' /
Zustellung im Paketshop

4

'Recipient not available' /
'Empfänger nicht anwesend'

5

'Acceptance refused' /
'Annahme verweigert'

6

'Recipient could not be identified' /
'Empfänger nicht auffindbar'

7

'Delivery to the recipient in a parcel shop' /
'Übergabe an Empfänger aus Paketshop'