Driver Availability API
v1For one order, list every active driver with whether the order can be dispatched or locked to them, and why not when it cannot.
For one order, this endpoint lists every active driver in your organization, sorted by name, with whether the order can be dispatched or locked to each of them. The rules are the same as for manual dispatch in the web application: dispatch needs a workday that overlaps every stop’s time window, and a lock needs a driver who is set as working. Removed drivers are not listed.
For each driver the response gives dispatchWorkdays (the workdays the order can be dispatched to, earliest first) or, when that list is empty, a dispatchBlock saying why; and a lockBlockReason, which is LOCK_BLOCK_REASON_UNSPECIFIED when the order can be locked to the driver.
Endpoints Overview
| Endpoint | Required access |
|---|---|
GET/v1/orders/{orderId}/driver-availabilityReturns every active driver of the caller's organization for one order, sorted by name, with whether the order can be dispatched or locked… | Planning & dispatch · View |
The badge is the access group and level an API client needs for the call. See access groups and levels.
Interactive API Explorer
Loading API Documentation...
Related documentation
- Drivers - Manage drivers and their workdays
- Order Skills - The skills and driver lock that constrain an order
- Authentication - API keys and access groups