Bettermile Route API (1.0.0)

Typical lifecycle

1. Create a tour (POST /v1/tours) for a given date, assignment (vehicle / route / driver) and depot. Bettermile looks up the jobs associated with that assignment from Data Gateway.
2. Create a sequence (POST /v1/tours/{tourId}/sequences) to get an optimised order of waypoints for the respective tour. Sequence creation is synchronous — the returned sequenceId is usable immediately to fetch the full sequence via GET /v1/tours/{tourId}/sequences/{sequenceId} or GET /v1/tours/{tourId}/sequences/latest.
3. (optional) Track and adjust the tour as it's driven: pin or unpin a waypoint's timeframe or stop time when it needs to be fixed against automatic recalculation, and report job status changes (POST /v1/tours/{tourId}/jobs/statuses) as an auxiliary channel alongside the DataGateWay connector updates.
4. (optional) Custom jobs and waypoints (Custom Job / Custom Waypoint tags) let you add a job to a tour that wasn't provided via DataGateway, and group jobs into a waypoint manually.

All endpoints share a single x-api-key for authentication and a general per-customer rate limit (see the 429 response on each operation).