← API Index

Use the driver API

The term driver relates to the person that delivers the goods, usually by a bike or a car. The following endpoints provide data to support this task. See also other API endpoints for other needed information (like logon/logoff, order content , items etc).

All driver endpoints need a session authenticated with driver permissions; without it they return HTTP 403 access_error. Every mutating endpoint accepts a dupcheck uuid: resending the same uuid within ~36 hours is ignored and acknowledged with the result code <action>duplicate, so unstable mobile connections can safely retry.

Timestamps are passed as ISO8601 datetimes (with timezone offset). Most endpoints accept a dt parameter to report the real event time when requests are sent delayed (offline queueing).

settings

A series of settings come from the backend. This ensures, all drivers do have the same settings.

tour info fetching

api/tours gives the list of all tours. Tours that are ready to be executed carry a counter > 0 in the field Ddate.ordercnt. Use ist >tours.id to fetch a specific tour plan using api/tour.

goods delivery activities

Most of these acknowledge with a generic DriverActionResult.

refund handling

improving accuracy of the delivery time

pauses

charging stations

Since tour32, we provide Charging Locations for a driver app to consume.

legacy endpoints

The unversioned action names (/api/driver/dlvr, /api/driver/trck, ...) still exist and keep answering in the old ad-hoc format {"action": ..., "result": ...}. New clients should use the versioned endpoints above.