stop

A stop represents a single stop on a route. Stops can be a job, break, or depot.

Name Type Description
break driver_break or id The break represented by this stop, if the stop's type is break. Can be provided inline as a break object, or as a break.id of a break that has been defined elsewhere in the request.
custom custom User-supplied custom fields that are returned unmodified in the response. These have no effect on optimization.
depot depot or id The depot represented by this stop, if the stop's type is depot. Can be provided inline as a depot object, or as a depot.id of a depot that has been defined elsewhere in the request.
id id The id of the stop. This does not need to match the id of the job, break, or depot that the stop represents.
job job or id The job represented by this stop, if the stop's type is job. Can be provided inline as a job object, or as a job.id of a job that has been defined elsewhere in the request.
type stop_type The type of stop; for example, job or break. See stop_type.

In addition to these fields, the calculated values returned in a stop_response from a previous request may be provided; however, these have no effect on optimization and are overwritten by the resulting values from the new request.

Example

{
  "id": "stop0",
  "type": "job",
  "job": "job0"
}

See Also