/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

(int) the ride id (ddate) to load the plan for🔗 ddate_id
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) 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.

Response Types

DeliveryListState

DeliveryListState (v1) docs

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.

Fields (2)
#FieldTypeDescription
0incompletebooltrue if some deliveries could not be fully resolved (e.g. missing geo positions)
1cidliststringcomma-separated customer ids of the affected deliveries (empty if complete)

Data (1 record)

incompletecidlist
false