/api/client/delivery3
Estimated delivery state for the caller's tour stops, plus the driver's current position.
Change Note: Migrated to ResponseFactory/ApiType; fixes lastname field (was incorrectly returning firstname in v2).
Parameters
| Name | Description | Type |
|---|---|---|
| cid | Customer id to inspect (admin only; defaults to authenticated user) | int |
| tid | Tour id to inspect (admin only; returns all stops on that tour) | 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 |
Error Responses
| HTTP Status | Error Code | Description |
|---|---|---|
| 403 | not_authenticated | Caller is not authenticated |
Response Types
| Type | Version | Description |
|---|---|---|
| DeliveryState | 3 | Estimated delivery state for a stop on the driver's tour |
| DriverState | 3 | Current position and identity of the driver on the tour |
OpenAPI
See delivery3.yaml