try out ↗

← API Index


/api/tours9

Tour overview for operators: all tours (incl. hidden) with geo polygons and address counts, plus the recent and upcoming delivery rides with customer/order counts. Requires operator or superuser permissions; returns empty lists otherwise.

Change Note: replaces legacy /api/tours8 (tours7.jsp) with POJO pattern

Parameters

Name Description Type
pd days back to include delivery rides (default 5) int
ad days ahead to include delivery rides (default 15) int
mp if 0, polygons are not grouped for geo display 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.

OpenAPI

See tours9.yaml

Referenced in skills

Other versions