Docs menu
Documentation changelog
What changed in this documentation and why, newest first.
- 2026-09-21
New guide: integrating from a TMS, ERP or WMS
A sixth guide now sits alongside the previous five. It maps data from a TMS, an ERP or a WMS onto the one route optimisation job body, with a table matching the job body's field names against the Pilot data template's own column names.
- 2026-09-07
Units, the sample job body and the example response corrected
Vehicle dimensions and payload were previously labelled metres and tonnes, while the actual stored columns are centimetres and kilograms; the sample job body used across the guides and the reference page now sends whole numbers in the real units. Order dimensions, weight and distance now state their units too. The example result response now uses the stop type literals PICKUP_POINT and DROP_POINT, rescales durations to a minute scale consistent with the distances shown, and is wrapped in the real success, message, error_code, data envelope. The 409 JOB_ALREADY_PROCESSING trigger is also stated more accurately: it fires once the job has been picked up for processing, which can happen while it still reports QUEUED.
- 2026-09-04
Job request body fields completed by hand
The specification did not fully describe the body of POST jobs. The fields external_reference, optimization_options, vehicles and orders were completed by hand from the backend source and are marked on the operation page as completed from backend source.
- 2026-09-04
Conflict and error codes confirmed
DUPLICATE_EXTERNAL_ID, ACTIVE_EXTERNAL_ID_CONFLICT and IDEMPOTENCY_CONFLICT are now confirmed directly in the add-on source. JOB_ALREADY_PROCESSING, RESULT_NOT_READY, RESULT_UNAVAILABLE and WEBHOOK_LIMIT_REACHED remain labelled as taken from the specification rather than confirmed in code.
- 2026-09-04
Webhook delivery confirmed as a single attempt
Route optimisation webhook delivery is attempted once, with no automatic retry. Polling is the fallback when delivery fails, and a replay can be requested from the Route4Green team.
- 2026-09-04
replaces_job_id documented on submit
Submitting a job now documents the optional replaces_job_id field. Naming a job that is still QUEUED atomically supersedes it, and that job becomes CANCELLED. This is the only way a job ever reaches CANCELLED, there is no separate cancel endpoint.
- 2026-09-04
tour_mode position order corrected
The generated description on the tour planning operation page predates the actual server behaviour. A callout on the group page now lists the six positions of tour_mode in the order the server actually parses them, with the sixth position noted as a minute count rather than a flag.
- 2026-08-20
OpenAPI snapshot pulled
This documentation is generated from an OpenAPI snapshot that was stored and reviewed on 20 August 2026. The snapshot is not refreshed automatically, so a new internal endpoint added upstream will not appear here unless a separate reviewed update brings it in.