shift

A shift contains all of the time-based details included in a route. Shifts are used with shift_patterns to instantiate routes.

Name Type Description
breaks driver_break[] The driver breaks that should be inserted onto the shift. See Routing with Driver Breaks.
breaks_relative_to_start boolean Defines if the break start time is relative to the shift start. Defaults to false. See Routing with Driver Breaks.
custom custom User-supplied custom fields that are returned unmodified in the response. These have no effect on optimization.
enable_end_stem_time boolean Defines if the optimization includes the effect of the time it takes to drive from the last job to the depot. Defaults to the value of settings.defaults.enable_end_stem_time.
enable_start_stem_time boolean Defines if the optimization includes the effect of the time it takes to drive to the first job. Defaults to the value of settings.defaults.enable_start_stem_time.
end_time timespan If using optimize_start_time, set this field to determine the latest time that the shift can end. Defaults to the value of settings.defaults.end_time, if provided.
id id Unique ID of the shift.
max_driving_time timespan The maximum time the driver can spend driving during a shift. This is useful for meeting Hours of Service regulations.
max_working_time timespan The maximum total time of the route. Defaults to the value of settings.defaults.max_working_time, if provided.
name string The name of the shift.
normal_working_time timespan The total working time before overtime rates must be paid. Defaults to the value of settings.defaults.normal_working_time, if provided.
optimize_start_time boolean Allows the shift to start after its start_time if it is efficient to do so. Defaults to the value of settings.defaults.optimize_start_time.
start_time timespan The time of day that the driver starts the shift at the start location. Defaults to the value of settings.defaults.start_time, if provided.

Example

{
  "id": "shift0",
  "start_time": "09:00",
  "end_time": "17:00",
  "max_driving_time": "08:00",
  "enable_start_stem_time": true
}

See Also