try out ↗

← API Index


/api/tour31

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, and the delivery addresses. Requires operator or superuser permissions; returns empty lists otherwise.

Change Note: replaces legacy /api/tour30 with POJO pattern

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 7 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 21 A delivery address with geo-coordinates and delivery hints, extended with driver tour-plan info (translated hints, box placement position).

OpenAPI

See tour31.yaml

Referenced in skills

Other versions