try out ↗

← API Index


/api/tour33

Driver tour plan for one tour: tour header, the delivery ride (DDate), all deliveries (stops) with box and prediction info, per-customer box return info, the delivery addresses and the available e-car charge points. Requires operator or superuser permissions; returns empty lists otherwise.

Change Note: replaces /api/tour32; the tour header moves from Tour v7 to Tour v9 (adds active, nopreorders, sameday, noautoassign)

Parameters

Name Description Type
tourid the ride id (ddate) to load the plan for int
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
Tour 9 A delivery tour in the admin/operator tour overview, including geo polygons and address counts.
DDate 4 A delivery ride (delivery date on a tour) in the admin/operator tour overview, with customer and order counts.
Delivery 14 One delivery (stop) of a delivery ride: which customer/address is served in which sequence, incl. packing box info and arrival prediction.
DeliveryListState 1 Meta information about the Delivery list of a tour plan: completeness of the geocoded stops. Replaces the 'incomplete' attribute the legacy tour endpoint carried on the Delivery list header.
CustomerInfo 5 Per-customer box return info for a delivery ride: which delivery boxes are still on the customer's record.
Address 22 A delivery address with geo-coordinates and delivery hints, extended with driver tour-plan info (translated hints, box placement position).
ChargePoint 1 An e-car charging point (Ladepunkt) the driver or the tour optimization may use. All addresses of fuel-station customers (orgtype 4) that are assigned to the requested tour are provided with the tour plan; tour_index is 0 unless the charge point was intentionally planned into the tour.

OpenAPI

See tour33.yaml

Other versions