stop_response

A stop_response provides details about the arrival/departure and time on site for a job, break, or depot on a route.

Name Type Description
arrival_datetime datetime The date and time the driver is projected to arrive at the stop.
arrival_time timespan The time of day the driver is projected to arrive at this stop. Returned instead of arrival_datetime if no dates are provided on routes.
custom custom User-supplied custom fields that were sent in the request. These exist only for job and depot stop types.
distance_to_meters float The distance driven to reach the stop from the previous stop, in meters.
id id The stop.id, job.id, depot.id, or driver_break.id that was provided on the request, if available.
idle_time timespan The amount of idle time the driver spends before the stop (for example, waiting for the time window to open).
location latlon The location of the stop. Only exists for depot type stops.
path_to_stop latlon[] The path to the stop from the previous stop. Only calculated if settings.route_paths is set to true. break type stops do not have a path_to_stop as they do not have a location.
previous_job id The job.id of the job that this stop is linked from. Only exists for job_exit type stops.
time_on_site timespan The total time the driver is projected to spend at the stop.
time_to timespan The amount of time spent driving to the stop from the previous stop.
type stop_type The type of the stop; for example, job or break. See stop_type.
violations violation[] An array of violations on the stop, if any.
assignment_restrictions violation[] An array of violations on the stop, if any. Only calculated if settings.return_assignment_restrictions is set to true.

Example

{
  "id": "job4",
  "arrival_datetime": "2018-01-23T10:07:06",
  "distance_to_meters": 25558,
  "time_to": "00:30:32",
  "idle_time": "00:02:45",
  "time_on_site": "00:15:00",
  "type": "job",
  "violations": [ 
    { "type": "job_delivered_on_disallowed_day" }
  ],
  "path_to_stop": [
    "39.718005,-104.969531",
    "39.718182,-104.969529",
    ....
  ]
}

See Also