Driver Tracking All Ep
POST/v1/driver_tracking/all
Driver Tracking All Endpoint - Query Driver Routes and GPS Data
Retrieves comprehensive driver tracking information including routes, GPS breadcrumbs, and geofence data based on specified filters. This endpoint provides real-time visibility into driver movements and order execution status.
Request
driver_schedule_ids: list[str] | None = None
List of driver schedule identifiers to filter results.
updated_as_of: datetime | None = None
Filter for schedules updated on or after this timestamp.
order_numbers: list[int] | None = None
List of order numbers to filter results. If provided, only tracking data for these orders will be returned.
order_ids: list[str] | None = None
List of order identifiers to filter results. If provided, only tracking data for these orders will be returned.
shift_date: date | None = None
Filter by the shift date (schedule date).
shift_as_of: datetime | None = None
Filter for shifts starting on or after this timestamp.
driver_ids: list[str] | None = None
List of driver identifiers to filter results.
driver_names: list[str] | None = None
List of driver names to filter results.
shift_type: ShiftType | None = None
Type of shift to filter by.
Show Shift Types
am
Morning shift.
pm
Afternoon/evening shift.
markets: list[str] | None = None
List of market names to filter results.
depots: list[str] | None = None
List of depot names to filter results.
At least one filter parameter must be provided. The response is optimized based on the number of schedules requested.
Response
Returns a list of DriverRouteLog objects with the following structure:
driver_id: str
Unique identifier for the driver.
driver_name: str
Name of the driver.
driver_schedule_id: str
Unique identifier for the driver's schedule.
depot_id: str | None
Identifier of the driver's home depot.
depot_name: str
Name of the driver's home depot.
shift: str
Shift type (AM or PM).
shift_start: datetime
Scheduled start time of the shift.
shift_end: datetime
Scheduled end time of the shift.
timezone: str
Timezone for the shift times.
driver_log: DriverLog
Driver's activity log containing clock in/out times and break information.
assigned_orders: list[NumberId]
List of orders assigned to the driver.
Show Child Attributes
number: str
Order number.
id: str
Order identifier.
route: list[MiniRouteDetail]
Detailed route information for each stop.
Show Child Attributes
load_status: str | None
Current status of the load.
origin_id: str
Identifier of the origin location.
origin_name: str
Name of the origin location.
destination_id: str
Identifier of the destination location.
destination_name: str
Name of the destination location.
action: str
Type of action at this stop (loading, dropping, etc.).
order_id: str | None
Associated order identifier.
order_number: int | None
Associated order number.
projected_start_time: datetime | None
System-calculated start time for this stop.
projected_end_time: datetime | None
System-calculated end time for this stop.
manual_start_time: datetime | None
Driver-reported start time.
manual_end_time: datetime | None
Driver-reported end time.
manual_start_gps_lat: float | None
Latitude of manual start location.
manual_start_gps_lon: float | None
Longitude of manual start location.
gps_start_event: MiniBreadcrumb | None
GPS data for route segment start.
gps_end_event: MiniBreadcrumb | None
GPS data for route segment end.
route_id: str | None
Identifier for the route segment.
route_distance: float | None
Distance of the route segment in miles.
route_minutes: int | None
Estimated travel time in minutes.
delay_minutes: int | None
Reported delay in minutes.
delay_reason: str | None
Reason for any delays.
break_minutes: int | None
Break time taken in minutes.
product_movements: list[MiniLoadProductMovement | MiniDropProductMovement]
Product loading or dropping details at this stop.
geofences: list[Geofence]
List of geofence definitions for locations on the route.
breadcrumbs: list[MiniBreadcrumb]
GPS tracking points for the driver.
Show Child Attributes
date: datetime
Timestamp of the GPS reading.
date_received: datetime | None
Timestamp when the GPS data was received by the system.
driver_schedule_id: str
Associated driver schedule identifier.
lat: float
Latitude coordinate.
lon: float
Longitude coordinate.
order_id: str | None
Associated order identifier.
order_number: int | None
Associated order number.
geofence: GeoFenceEvent | None
Geofence event information if the GPS point triggered a geofence.
Responses
- 200
- 422
Successful Response
- application/json
- Example (from schema)
[
{
"driver_schedule_id": "string",
"driver_name": "string",
"driver_id": "string",
"depot_name": "string",
"depot_id": "string",
"shift": "string",
"shift_end": "2025-12-17T21:49:50.616Z",
"shift_start": "2025-12-17T21:49:50.616Z",
"timezone": "string",
"driver_log": {
"start_odometer": 0,
"end_odometer": 0,
"tractor": "string",
"trailer": "string"
},
"assigned_orders": [
{
"id": "string",
"number": 0
}
],
"route": [
{
"load_status": "string",
"origin_id": "string",
"origin_name": "string",
"origin_address": "string",
"origin_city": "string",
"origin_state": "string",
"origin_postal_code": "string",
"origin_site_name": "string",
"origin_lat": 0,
"origin_lon": 0,
"destination_id": "string",
"destination_name": "string",
"destination_address": "string",
"destination_city": "string",
"destination_state": "string",
"destination_postal_code": "string",
"destination_site_name": "string",
"destination_lat": 0,
"destination_lon": 0,
"action": "string",
"order_id": "string",
"order_number": 0,
"projected_start_time": "2025-12-17T21:49:50.616Z",
"projected_end_time": "2025-12-17T21:49:50.616Z",
"manual_start_time": "2025-12-17T21:49:50.616Z",
"manual_end_time": "2025-12-17T21:49:50.616Z",
"manual_start_gps_lat": 0,
"manual_start_gps_lon": 0,
"gps_start_event": {
"driver_schedule_id": "5eb7cf5a86d9755df3a6c593",
"lat": 0,
"lon": 0,
"date": "2025-12-17T21:49:50.616Z",
"order_id": "string",
"order_number": 0,
"geofence_event": {
"within": false,
"location_id": "string",
"location_name": "string"
},
"action": "string",
"trigger": "time"
},
"gps_end_event": {
"driver_schedule_id": "5eb7cf5a86d9755df3a6c593",
"lat": 0,
"lon": 0,
"date": "2025-12-17T21:49:50.616Z",
"order_id": "string",
"order_number": 0,
"geofence_event": {
"within": false,
"location_id": "string",
"location_name": "string"
},
"action": "string",
"trigger": "time"
},
"route_id": "string",
"route_distance": 0,
"route_minutes": 0,
"delay_minutes": 0,
"delay_reason": "string",
"break_minutes": 0,
"product_movements": [
{
"type": "load",
"product_name": "string",
"product_id": "string",
"supplier_name": "string",
"supplier_id": "string",
"bol_number": "string",
"bol_id": "string",
"net_volume": 0,
"gross_volume": 0,
"date": "2025-12-17T21:49:50.616Z",
"executed": false
},
{
"type": "drop",
"product_name": "string",
"tank_id": "string",
"dropped_volume": 0,
"date": "2025-12-17T21:49:50.616Z",
"executed": false
}
],
"current": false,
"complete": false,
"start_time": "2025-12-17T21:49:50.616Z",
"end_time": "2025-12-17T21:49:50.616Z"
}
],
"last_update": {
"last_heartbeat": "2025-12-17T21:49:50.617Z",
"lat": 0,
"lon": 0,
"detail": {
"load_status": "string",
"origin_id": "string",
"origin_name": "string",
"origin_address": "string",
"origin_city": "string",
"origin_state": "string",
"origin_postal_code": "string",
"origin_site_name": "string",
"origin_lat": 0,
"origin_lon": 0,
"destination_id": "string",
"destination_name": "string",
"destination_address": "string",
"destination_city": "string",
"destination_state": "string",
"destination_postal_code": "string",
"destination_site_name": "string",
"destination_lat": 0,
"destination_lon": 0,
"action": "string",
"order_id": "string",
"order_number": 0,
"projected_start_time": "2025-12-17T21:49:50.617Z",
"projected_end_time": "2025-12-17T21:49:50.617Z",
"manual_start_time": "2025-12-17T21:49:50.617Z",
"manual_end_time": "2025-12-17T21:49:50.617Z",
"manual_start_gps_lat": 0,
"manual_start_gps_lon": 0,
"gps_start_event": {
"driver_schedule_id": "5eb7cf5a86d9755df3a6c593",
"lat": 0,
"lon": 0,
"date": "2025-12-17T21:49:50.617Z",
"order_id": "string",
"order_number": 0,
"geofence_event": {
"within": false,
"location_id": "string",
"location_name": "string"
},
"action": "string",
"trigger": "time"
},
"gps_end_event": {
"driver_schedule_id": "5eb7cf5a86d9755df3a6c593",
"lat": 0,
"lon": 0,
"date": "2025-12-17T21:49:50.617Z",
"order_id": "string",
"order_number": 0,
"geofence_event": {
"within": false,
"location_id": "string",
"location_name": "string"
},
"action": "string",
"trigger": "time"
},
"route_id": "string",
"route_distance": 0,
"route_minutes": 0,
"delay_minutes": 0,
"delay_reason": "string",
"break_minutes": 0,
"product_movements": [
{
"type": "load",
"product_name": "string",
"product_id": "string",
"supplier_name": "string",
"supplier_id": "string",
"bol_number": "string",
"bol_id": "string",
"net_volume": 0,
"gross_volume": 0,
"date": "2025-12-17T21:49:50.617Z",
"executed": false
},
{
"type": "drop",
"product_name": "string",
"tank_id": "string",
"dropped_volume": 0,
"date": "2025-12-17T21:49:50.617Z",
"executed": false
}
],
"current": false,
"complete": false,
"start_time": "2025-12-17T21:49:50.617Z",
"end_time": "2025-12-17T21:49:50.617Z"
}
},
"breadcrumbs": [
{
"driver_schedule_id": "5eb7cf5a86d9755df3a6c593",
"lat": 0,
"lon": 0,
"date": "2025-12-17T21:49:50.617Z",
"order_id": "string",
"order_number": 0,
"geofence_event": {
"within": false,
"location_id": "string",
"location_name": "string"
},
"action": "string",
"trigger": "time"
}
],
"geofences": [
{
"location_id": "string",
"location_name": "string",
"geo_json": {
"type": "Feature",
"geometry": {
"type": "polygon",
"coordinates": [
[
[
null
]
]
]
},
"properties": {}
}
}
],
"complete": false,
"hours_assigned": 0,
"hours_available": 0,
"loaded_miles": 0,
"total_miles": 0
}
]
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}