disclaimer: order by time desc
Since its initial launch in 2023, the Better Route API has grown from a minimal core into the full public interface for Deep Integration.
This list covers changes visible to API consumers. It doesn't include the regular internal maintenance and security work we do on the API independent of this list, that happens continuously as a matter of course, not as a one-off event worth dating here.
Because we work so closely with our customers on Route pilots and deep integrations, we're also able to pick up other requests and feature ideas for the API on short notice, not just the changes listed here. If there's something you need that isn't reflected below, talk to your Bettermile contact.
- NEW: Introduced the tour start signal endpoint, so you can tell Bettermile when the driver has started (navigating) a tour, as opposed to the tour just being assumed to have started base on the first job status update. It's safe to call repeatedly.
- EXTENDED: Added detailed request and response examples throughout the OpenAPI spec, making it easier for AI agents and coding assistants to integrate against the API.
- FIXED: Requests referencing a non-existing job now correctly return
404 Not Foundinstead of500, on job status changes. - NEW: Added a
subLocalityattribute to address payloads, for better navigation context.
December
- FIXED: Tour dates are now offset to
LocalDate, correctly handling tours across different timezones (e.g. New Zealand vs. Berlin).
September
- NEW: Exposed entrance and parking coordinates on waypoints, for last-meter guidance.
- DEPRECATED:
jobIdsin favour of a newjobIdentifiersfield, on both the tour and sequence response payloads. - NEW: Tour responses now include the destination address and final ETA, when a destination is set, and a Real-Time Tracking (RTT) categorisation for the tour.
- NEW: Sequence responses now include a fidelity score (how closely the driver has followed the provided sequence), and list unassigned jobs separately.
- EXTENDED: Cleaned up and extended error codes across the API for more precise client-side error handling. See the Better Route API reference for the current list.
August
- NEW: Introduced the potential recalculation gain endpoint. See checking for recalculation gain for how to use it.
July
- NEW: Sequence responses now include external job IDs, so clients can map jobs back to their own systems.
June
- NEW: Tours now default to the depot address as their destination, with the option to override it. See defining a custom destination.
May
- NEW: Drivers can now define the first waypoint of a sequence request.
February
- NEW: Introduced endpoints to add, edit, and delete custom timeframes and stop times on waypoints. See setting a custom timeframe and setting custom stop times.
- NEW: External developers can now create custom jobs and update job statuses via the API. See adding custom jobs.
- NEW: Added priority group information to sequence and job-level payloads.
- Initial launch (V1): The Better Route API launches publicly, including
USE_PROVIDEDmode: a way to send a specific, explicit waypoint order, unique to the API and not available in the Bettermile Driver App.