Get Route Execution

This endpoint returns a single route execution with the array of route execution steps.

Parameters

routeExecutionId

The ID of the route execution to find.

Response Body

{
  "id": 0,
  "routeId": 0,
  "assignmentId": 0,
  "companyId": 0,
  "vehicleId": 0,
  "driverId": 0,
  "steps": 
  [ 
   {
        "id": 0,
        "routeExecutionId": 0,
        "routeLegId": 0,
        "status": "active",
        "planPolyline": "string",
        "planDeparture": "2023-05-18T10:01:59.448Z",
        "planArrival": "2023-05-18T10:01:59.448Z",
        "planStopOverDuration": 0.0,
        "planBreakDuration": 0.0,
        "planDistance": 0.0,
        "planDuration": 0.0,
        "realDeparture": "2023-05-18T10:01:59.448Z",
        "realArrival": "2023-05-18T10:01:59.448Z",
        "realStopOverDuration": 0.0,
        "realBreakDuration": 0.0,
        "remainingDuration": 0.0,
        "remainingDistance": 0.0,
        "eta": "2023-05-18T10:01:59.448Z",
        "departurePlaceId": 0,
        "departureClientId": 0,
        "departureAddress": "string",
        "departureLatitude": 0.0,
        "departureLongitude": 0.0,
        "arrivalPlaceId": 0,
        "arrivalAddress": "string",
        "vehicleId": 0,
        "licensePlate": "string",
        "driverName": "string",
        "name": "string",
        "routeId": 0,
        "code": "string",
        "compliance": 0.0,
        "vehiclePosition": 0.0,
        "realDuration": 0.0,
        "realDistance": 0.0,
        "route": null,
        "vehicleId": 0,
        "waypoints": null,
        "totalDuration": 0.0,
        "totalDistance": 0.0
    }
  ]
  "status": -1,
  "name": "string",
  "code": "string",
  "color": 0,
  "planDeparture": "2025-07-02T08:00:00Z",
  "planArrival": "2025-07-02T12:30:00Z",
  "planDistance": 0.0,
  "planDuration": 0.0,
  "realBreakDuration": 0.0,
  "remainingDuration": 0.0,
  "remainingDistance": 0.8,
  "RemainingDistance": 0.0,
  "eta": "2025-07-02T12:15:00Z",
  "departurePlaceId": 0,
  "departureAddress": "string",
  "departureLatitude": 0.0,
  "departureLongitude": 0.0,
  "arrivalPlaceId": 0,
  "arrivalAddress": "string",
  "arrivalLatitude": 0.0,
  "arrivalLongitude": 0.0,
  "totalDuration": 0.0,  
  "totalDistance": 0.0,
  "vehiclePosition": 0.0,
  "onTripNow": false,
  "costPerKm": 0.0,
  "costPerHour": 0.0,
  "licensePlate": "string",
  "realDuration": 0.0,
  "realDistance": 0.0,
  "compliance": 0.0,
  "realStopOverDuration": 0.0,
  "planStopOverDuration": 0.0,
  "planBreakDuration": 0.0,
  "realDeparture": "2025-07-02T08:12:00Z",
  "realArrival": "2025-07-02T12:38:00Z",
  "driverName": "string"
}

Field	Description
id	The ID of the route execution integer
routeId	The ID of the route assigned to an existent route execution. integer
assignmentId	The ID of the assignment (if exists) of an existing route, which resulted in the current route execution. integer
companyId	The ID of the company. integer
vehicleId	The ID of the vehicle that is performing this route execution integer
driverId	The ID of the driver that is driving the vehicle. integer
steps	Array of steps in the route execution array
steps[i].id	Identifier of the route step execution. integer
steps[i].routeExecutionId	The ID of the route execution that includes this step. integer
steps[i].routeLegId	The ID of the leg that originated this step. integer
steps[i].status	The status of the execution of the step. See the Route statuses and their IDs. enum/int
steps[i].planPolyline	The polyline expected for this step. string
steps[i].planDeparture	The expected date and time of the vehicle's departure from the begining of the this step. date/time
steps[i].planArrival	The expected date and time of the vehicle's arrival to the end of this step. date/time
steps[i].planStopOverDuration	The planed stop duration, in seconds, in the current step. double
steps[i].planBreakDuration	The planed break duration, in seconds, in the current step. double
steps[i].planDistance	The distance, in KMs, planed for the current step. double
steps[i].planDuration	The planed duration, in seconds, for the step. double
steps[i].realDeparture	The timestamp of the real vehicle's departure from the begining position of this step. This field may not have value if the step was not started. date/time
steps[i].realArrival	The timestamp to the real vehicle's arrival to the ending position of this step. This field may not have value if the step was not completed. date/time
steps[i].realStopOverDuration	The actual duration of the stop at the end of this step, in seconds. This field may not be specified if the stop did not occur. double
steps[i].realBreakDuration	The actual duration of the break taken during this step, in seconds. This field may be null if no break occurred or the data is not available. double
steps[i].remainingDuration	The estimated remaining duration to complete the route, in seconds. This field may be null if the value is not available or the route has already been completed. double
steps[i].remainingDistance	The estimated remaining distance to complete the route, in KMs. This field may be null if the value is not available or the route has already been completed. double
steps[i].eta	The estimated date and time, in UTC, when the vehicle is expected to arrive at the end of this step. This field may be null if the estimation is not available. date/time
steps[i].departurePlaceId	The unique identifier of the departure place for this step. This field may be null if the departure place is not defined. int
steps[i].departureClientId	The identifier of the client associated with the departure location for this step. int
steps[i].departureAddress	The address of the departure location for this step. This field is always present if the step has a defined departure point. string
steps[i].departureLatitude	The geographic latitude of the departure location for this step. double
steps[i].departureLongitude	The geographic longitude of the departure location for this step. double
steps[i].arrivalPlaceId	The unique identifier of the arrival location for this step. This field may not be defined if the arrival place is not defined. int
steps[i].arrivalAddress	The address of the arrival location for this step. This field is always present if the step has a defined arrival point. string
steps[i].vehicleId	The identifier of the vehicle assigned to this route execution step. int
steps[i].licensePlate	The license plate of the vehicle assigned to this route execution step. string
steps[i].driverName	The name of the driver assigned to the route execution. string
steps[i].name	The name of the route. string
steps[i].routeId	The identifier of the route to which this execution step belongs. int
steps[i].code	The code of the route. string
steps[i].compliance	The time deviation, in seconds, relative to the scheduled time of arrival (STA). For active routes, this is the difference between STA and the Estimated Time of Arrival (ETA). For completed routes, it represents the difference between STA and the Actual Time of Arrival (ATA). A negative value indicates early arrival; a positive value indicates a delay. double
steps[i].vehiclePosition	The percentage of the distance of the route step already traveled by the vehicle. double
steps[i].realDuration	The real duration of this route execution step, in seconds. This field may not be included if the step was not completed or duration data is unavailable. double
steps[i].realDistance	The real distance covered by the vehicle in this step, in kilometers. This field may be null if the step was not completed or distance data is not available. double
steps[i].route	This field is not being used. null
steps[i].waypoints	This field is not being used. null
steps[i].totalDuration	The total duration of the route execution step, in seconds. This field may be null if the data is not available or the route has not been fully processed. double
steps[i].totalDistance	The total distance covered by the vehicle in the route execution, in kilometers. This field may be null if the data is not available or the route has not been fully processed. double
status	The status of the route execution. See the Route statuses and their IDs. enum/int
name	The name of the route execution. string
route.code	The code of the route. string
color	The color associated with this route, typically used for visualization purposes (e.g., in maps or timelines). The value is an integer representing an RGB color (e.g., `16711680` = red). This field may be null if no color is assigned. int
planDeparture	The planned departure date and time of the route. This value is scheduled in advance for route planning purposes. date/time
planArrival	The planned arrival date and time of the route. Used for scheduling and performance comparison. date/time
planDistance	The total planned distance of the route, in kilometers. double
planDuration	The total planned duration of the route, in seconds. double
realBreakDuration	The total real break duration taken during the route, in seconds. This field may be null if no break was taken or the data is unavailable. double
remainingDuration	The estimated remaining time to complete the route, in seconds. This field may be null if the data is unavailable or the route is completed. double
remainingDistance	The estimated remaining distance to complete the route, in kilometers. This field may be null if the data is unavailable or the route is completed. double
eta	The estimated arrival time at the final destination of the route. This field may be null if ETA could not be calculated. date/time
departurePlaceId	The identifier of the departure location. This field may not be specified if the departure place is not defined. int
departureAddress	The address of the departure location. string
departureLatitude	The geographic latitude of the departure location. double
departureLongitude	The geographic longitude of the departure location. double
arrivalPlaceId	The identifier of the arrival location. This field may be null if the arrival place is not defined. int
arrivalAddress	The address of the arrival location. string
arrivalLatitude	The geographic latitude of the arrival location. double
arrivalLongitude	The geographic longitude of the arrival location. double
totalDuration	The total duration of the route, in seconds. This field may not be specified if data is not available. double
totalDistance	The total distance of the route, in kilometers. This field may not be specified if data is not available. double
vehiclePosition	The percentage of the distance of the route step already traveled by the vehicle. double
route.onTripNow	Indicates whether the vehicle is currently travelling (`true`) or stopped (`false`), bool
route.costPerKm	The cost of the route per kilometer, if available. This field may not may be specified if cost data is not calculated. double
costPerHour	The hourly cost of running the route, if available. This field may not be specified if cost data is not calculated. double
licensePlate	The license plate of the vehicle assigned to this route execution. string
realDuration	The actual duration of the route, in seconds. May not be specified if the route is not completed. double
realDistance	The actual distance covered, in kilometers. May not be specified if the route is not completed. double
compliance	The time deviation, in seconds, relative to the scheduled time of arrival (STA). For active routes, this is the difference between STA and the Estimated Time of Arrival (ETA). For completed routes, it represents the difference between STA and the Actual Time of Arrival (ATA). A negative value indicates early arrival; a positive value indicates a delay. double
realStopOverDuration	The actual stop duration during the route, in seconds. May not be specified if no stop occurred or the data is unavailable. double
planStopOverDuration	The planned stop duration for the route, in seconds. double
planBreakDuration	The planned break duration for the route, in seconds. double
realDeparture	The actual time the route departed. This field may not be specified if the route has not yet departed. date/time
realArrival	The actual time the route was completed. This field may not be specified if the route is still in progress. date/time
driverName	The name of the driver assigned to the route execution. string

Response HTTP Codes

204 - No content

If a route execution with the specified routeExecutionId was not found.

400 - Bad Request

The value of routeExecutionId is less or equal to zero

401 - Unauthorized

The authentication token is invalid

403 - Forbidden

The user does not have permission to view routes