Add task

depot

object

A depot, by default start and finish point for a vehicle on route.

depot.address

string

Address of the location.

depot.crossdock_safety_waiting_duration_s

number

The duration of the minimum time interval between the moment the order arrives at the cross-dock depot and the moment when it can be picked up from there by a vehicle for delivery. This interval is needed so that there is a reserve of time in case the vehicle that brings the orders is late.

Minimum value: 0.
Maximum value: 3.1536e+09.
Default value: 3600.

depot.description

string

Location description.

depot.finish_service_duration_s

number

Duration of service at a depot in the end of a route. Finish service duration can include any operations at depot, e.g. unloading items, documents collection etc. More information

Minimum value: 0.
Maximum value: 3.1536e+09.

depot.flexible_start_time

boolean

By default vehicle start time is equal to either depot, or garage, or shift start time. When this option is set to true, vehicles can start earlier or later than the default start time. In this case the optimal start time will be computed according to cost minimization. More information
Also when flexible_start_time option is used, the solver can generate routes where arrival time is very close to end of the time window. It is often undesired route plans, because there is a risk of being late on such locations. An option minimize_lateness_risk and/or penalize_late_service is recommended to be used together with flexible_start_time to avoid such routes.

depot.hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depot.hard_window

boolean

Restricts time window relaxation during route planning. When true, vehicles are allowed to return to depot only within the specified time window. More information

depot.id

object

Location ID. All locations IDs in task must be unique and have the same type: integer or string. More information

depot.load_service_duration_s

number

Additional duration for loading delivery orders into a vehicle, added only if there is at least one delivery order,loaded in this depot.

Minimum value: 0.

depot.package_throughput

object

Restriction on packaging speed in depot.

depot.package_throughput.kg_per_hour

object

depot.package_throughput.kg_per_hour.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depot.package_throughput.kg_per_hour.value

number

Depot package throughput, kilograms per hour.

Minimum value: 0.

depot.package_throughput.units_per_hour

object

depot.package_throughput.units_per_hour.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depot.package_throughput.units_per_hour.value

number

Depot package throughput, units per hour.

Minimum value: 0.

depot.penalty

object

Penalties for depot time window or throughput failure. More information

depot.penalty.early

object

Penalty components for early service (used instead of out_of_time penalty).

depot.penalty.early.fixed

number

Fixed penalty applied if a vehicle starts serving the depot before the start of the time window. The penalty is applied for any early service, including opening the depot, unloading or uploading the vehicle at the depot or closing the depot. It is applied once for each visit of a depot during which the depot was served early.

Default value: 1000.

depot.penalty.early.minute

number

Penalty for each minute of early service of the depot. Applied in the same cases as the fixed penalty.

Default value: 17.

depot.penalty.late

object

Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.

depot.penalty.late.fixed

number

Fixed penalty applied for each visit of the depot after the end of the time window. Starting from a depot is counted for a visit.

Default value: 1000.

depot.penalty.late.minute

number

Penalty for each minute of lateness for every visit of the depot after the end of the time window.

Default value: 17.

depot.penalty.out_of_time

object

Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.

depot.penalty.out_of_time.fixed

number

Fixed penalty applied if the depot is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 1000.

depot.penalty.out_of_time.minute

number

Penalty for each minute of being outside of the time window of the depot. See the specifications of early and late options for more details in each case.

Default value: 17.

depot.penalty.package_throughput

object

Penalty components for package throughput exceeding.

depot.penalty.package_throughput.fixed

number

Fixed penalty applied if throughput is exceeded.

Default value: 1000.

depot.penalty.package_throughput.kg

number

Penalty for each extra kg of throughput exceeding.

Default value: 50.

depot.penalty.package_throughput.unit

number

Penalty for each extra custom unit of throughput exceeding (units field).

Default value: 100.

depot.penalty.throughput

object

Penalty components for throughput exceeding.

depot.penalty.throughput.fixed

number

Fixed penalty applied if throughput is exceeded.

Default value: 1000.

depot.penalty.throughput.kg

number

Penalty for each extra kg of throughput exceeding.

Default value: 50.

depot.penalty.throughput.unit

number

Penalty for each extra custom unit of throughput exceeding (units field).

Default value: 100.

depot.penalty.throughput.vehicle *

number

Penalty for each extra vehicle per hour of throughput exceeding.

Default value: 100000.

depot.point *

object

WGS84 coordinate of a location. More information

depot.point.lat *

number

Minimum value: -90.
Maximum value: 90.

depot.point.lon *

number

Minimum value: -180.
Maximum value: 180.

depot.preliminary_service_duration_s

number

Duration of preliminary service at depot. This duration can include any operations that can be done before loading the vehicle. These operations will be done before depot_ready_time of deliveries that are loaded at this vehicle. More information

Minimum value: 0.
Maximum value: 3.1536e+09.

depot.preset_id

string

Preset number for depot properties.

depot.ref

string

Location reference.

depot.service_duration_s

object

Duration of service at location. Service duration can include any operations at location, such as loading or unloading items from a vehicle, or any other time associated with a location (apart from waiting, which is time after arrival and before service).More information

depot.service_duration_s.fixed

number

Fixed service duration for any part of the order.

depot.service_duration_s.scaled

number

Service time for a part of an order, which is multiplied by order ratio.

depot.throughput

object

Depot throughput limit. More information

depot.throughput.kg_per_hour

object

depot.throughput.kg_per_hour.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depot.throughput.kg_per_hour.value

number

Throughput, kilograms per hour.

Minimum value: 0.

depot.throughput.units_per_hour

object

depot.throughput.units_per_hour.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depot.throughput.units_per_hour.value

number

Throughput, custom units per hour.

Minimum value: 0.

depot.throughput.vehicle_count

object

depot.throughput.vehicle_count.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depot.throughput.vehicle_count.value

number

Throughput, simultaneously vehicles.

Minimum value: 0.
Maximum value: 1e+09.

depot.time_window

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depot.time_windows[]

array

List of allowed time windows. Time windows can not overlap. Fields time_window and time_windows are mutually exclusive. Either none or all of time_window must have corresponding hard_time_window. More information

depot.time_windows[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depot.time_windows[].time_window *

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depot.time_windows_loading

object

Time windows when the vehicle is allowed to leave the depot on the 1st run

depot.time_windows_loading.hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depot.time_windows_loading.hard_window

boolean

Time window, specified in the "time_window" field, should be hard, incompatible with the "hard_time_window" field.

depot.time_windows_loading.penalty

object

depot.time_windows_loading.penalty.early

object

Penalty components for early service (used instead of out_of_time penalty).

depot.time_windows_loading.penalty.early.fixed

number

Fixed penalty applied if the location starts being served before the start of the time window.

Default value: 1000.

depot.time_windows_loading.penalty.early.minute

number

Penalty for each minute of early arrival when the location starts being served before the start of the time window.

Default value: 17.

depot.time_windows_loading.penalty.late

object

Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.

depot.time_windows_loading.penalty.late.fixed

number

Fixed penalty applied if the location is visited after the end of the time window.

Default value: 1000.

depot.time_windows_loading.penalty.late.minute

number

Penalty for each minute of lateness, when the location is visited after the end of the time window.

Default value: 17.

depot.time_windows_loading.penalty.out_of_time

object

Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.

depot.time_windows_loading.penalty.out_of_time.fixed

number

Fixed penalty applied if the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 1000.

depot.time_windows_loading.penalty.out_of_time.minute

number

Penalty for each minute of lateness or early arrival when the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 17.

depot.time_windows_loading.time_window

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depot.time_windows_loading.time_windows[]

array

List of allowed time windows. Time windows can not overlap. Fields time_window and time_windows are mutually exclusive. Either none or all of time_window must have corresponding hard_time_window. More information

depot.time_windows_loading.time_windows[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depot.time_windows_loading.time_windows[].time_window *

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depot.time_windows_refilling

object

Time windows when the vehicle is allowed to visit a depot (or middle depot) for additional loading

depot.time_windows_refilling.hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depot.time_windows_refilling.hard_window

boolean

Time window, specified in the "time_window" field, should be hard, incompatible with the "hard_time_window" field.

depot.time_windows_refilling.penalty

object

depot.time_windows_refilling.penalty.early

object

Penalty components for early service (used instead of out_of_time penalty).

depot.time_windows_refilling.penalty.early.fixed

number

Fixed penalty applied if the location starts being served before the start of the time window.

Default value: 1000.

depot.time_windows_refilling.penalty.early.minute

number

Penalty for each minute of early arrival when the location starts being served before the start of the time window.

Default value: 17.

depot.time_windows_refilling.penalty.late

object

Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.

depot.time_windows_refilling.penalty.late.fixed

number

Fixed penalty applied if the location is visited after the end of the time window.

Default value: 1000.

depot.time_windows_refilling.penalty.late.minute

number

Penalty for each minute of lateness, when the location is visited after the end of the time window.

Default value: 17.

depot.time_windows_refilling.penalty.out_of_time

object

Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.

depot.time_windows_refilling.penalty.out_of_time.fixed

number

Fixed penalty applied if the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 1000.

depot.time_windows_refilling.penalty.out_of_time.minute

number

Penalty for each minute of lateness or early arrival when the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 17.

depot.time_windows_refilling.time_window

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depot.time_windows_refilling.time_windows[]

array

List of allowed time windows. Time windows can not overlap. Fields time_window and time_windows are mutually exclusive. Either none or all of time_window must have corresponding hard_time_window. More information

depot.time_windows_refilling.time_windows[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depot.time_windows_refilling.time_windows[].time_window *

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depot.time_windows_unloading

object

Time windows when the vehicle is allowed to return to the depot on the last run

depot.time_windows_unloading.hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depot.time_windows_unloading.hard_window

boolean

Time window, specified in the "time_window" field, should be hard, incompatible with the "hard_time_window" field.

depot.time_windows_unloading.penalty

object

depot.time_windows_unloading.penalty.early

object

Penalty components for early service (used instead of out_of_time penalty).

depot.time_windows_unloading.penalty.early.fixed

number

Fixed penalty applied if the location starts being served before the start of the time window.

Default value: 1000.

depot.time_windows_unloading.penalty.early.minute

number

Penalty for each minute of early arrival when the location starts being served before the start of the time window.

Default value: 17.

depot.time_windows_unloading.penalty.late

object

Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.

depot.time_windows_unloading.penalty.late.fixed

number

Fixed penalty applied if the location is visited after the end of the time window.

Default value: 1000.

depot.time_windows_unloading.penalty.late.minute

number

Penalty for each minute of lateness, when the location is visited after the end of the time window.

Default value: 17.

depot.time_windows_unloading.penalty.out_of_time

object

Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.

depot.time_windows_unloading.penalty.out_of_time.fixed

number

Fixed penalty applied if the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 1000.

depot.time_windows_unloading.penalty.out_of_time.minute

number

Penalty for each minute of lateness or early arrival when the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 17.

depot.time_windows_unloading.time_window

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depot.time_windows_unloading.time_windows[]

array

List of allowed time windows. Time windows can not overlap. Fields time_window and time_windows are mutually exclusive. Either none or all of time_window must have corresponding hard_time_window. More information

depot.time_windows_unloading.time_windows[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depot.time_windows_unloading.time_windows[].time_window *

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depot.title

string

Location title.

depot.type

string

Defines a type of depot: depot or crossdock.

• depot — the main depot where orders are stored.
• crossdock — the additional depot where there are no orders initially. To deliver orders from this depot, another vehicle must first deliver them here from the main depot where they are stored.

Default value: depot.

1. depot
2. crossdock

depot.unload_service_duration_s

number

Additional duration for unloading pickup orders from a vehicle, added only if there is at least one pickup order,delivered in this depot.

Minimum value: 0.

depot.use_in_proximity

boolean

When false, this depot will be ignored in computation of proximity and global proximity. When true, this depot will be used in computation of proximity and global proximity.If parameter is not defined, this depot will be used in computation of proximity in compatible mode.

depots[]

array

List of depots. Fields depot and depots are mutually exclusive. More information

depots[].address

string

Address of the location.

depots[].crossdock_safety_waiting_duration_s

number

The duration of the minimum time interval between the moment the order arrives at the cross-dock depot and the moment when it can be picked up from there by a vehicle for delivery. This interval is needed so that there is a reserve of time in case the vehicle that brings the orders is late.

Minimum value: 0.
Maximum value: 3.1536e+09.
Default value: 3600.

depots[].description

string

Location description.

depots[].finish_service_duration_s

number

Duration of service at a depot in the end of a route. Finish service duration can include any operations at depot, e.g. unloading items, documents collection etc. More information

Minimum value: 0.
Maximum value: 3.1536e+09.

depots[].flexible_start_time

boolean

By default vehicle start time is equal to either depot, or garage, or shift start time. When this option is set to true, vehicles can start earlier or later than the default start time. In this case the optimal start time will be computed according to cost minimization. More information
Also when flexible_start_time option is used, the solver can generate routes where arrival time is very close to end of the time window. It is often undesired route plans, because there is a risk of being late on such locations. An option minimize_lateness_risk and/or penalize_late_service is recommended to be used together with flexible_start_time to avoid such routes.

depots[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depots[].hard_window

boolean

Restricts time window relaxation during route planning. When true, vehicles are allowed to return to depot only within the specified time window. More information

depots[].id

object

Location ID. All locations IDs in task must be unique and have the same type: integer or string. More information

depots[].load_service_duration_s

number

Additional duration for loading delivery orders into a vehicle, added only if there is at least one delivery order,loaded in this depot.

Minimum value: 0.

depots[].package_throughput

object

Restriction on packaging speed in depot.

depots[].package_throughput.kg_per_hour

object

depots[].package_throughput.kg_per_hour.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depots[].package_throughput.kg_per_hour.value

number

Depot package throughput, kilograms per hour.

Minimum value: 0.

depots[].package_throughput.units_per_hour

object

depots[].package_throughput.units_per_hour.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depots[].package_throughput.units_per_hour.value

number

Depot package throughput, units per hour.

Minimum value: 0.

depots[].penalty

object

Penalties for depot time window or throughput failure. More information

depots[].penalty.early

object

Penalty components for early service (used instead of out_of_time penalty).

depots[].penalty.early.fixed

number

Fixed penalty applied if a vehicle starts serving the depot before the start of the time window. The penalty is applied for any early service, including opening the depot, unloading or uploading the vehicle at the depot or closing the depot. It is applied once for each visit of a depot during which the depot was served early.

Default value: 1000.

depots[].penalty.early.minute

number

Penalty for each minute of early service of the depot. Applied in the same cases as the fixed penalty.

Default value: 17.

depots[].penalty.late

object

Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.

depots[].penalty.late.fixed

number

Fixed penalty applied for each visit of the depot after the end of the time window. Starting from a depot is counted for a visit.

Default value: 1000.

depots[].penalty.late.minute

number

Penalty for each minute of lateness for every visit of the depot after the end of the time window.

Default value: 17.

depots[].penalty.out_of_time

object

Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.

depots[].penalty.out_of_time.fixed

number

Fixed penalty applied if the depot is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 1000.

depots[].penalty.out_of_time.minute

number

Penalty for each minute of being outside of the time window of the depot. See the specifications of early and late options for more details in each case.

Default value: 17.

depots[].penalty.package_throughput

object

Penalty components for package throughput exceeding.

depots[].penalty.package_throughput.fixed

number

Fixed penalty applied if throughput is exceeded.

Default value: 1000.

depots[].penalty.package_throughput.kg

number

Penalty for each extra kg of throughput exceeding.

Default value: 50.

depots[].penalty.package_throughput.unit

number

Penalty for each extra custom unit of throughput exceeding (units field).

Default value: 100.

depots[].penalty.throughput

object

Penalty components for throughput exceeding.

depots[].penalty.throughput.fixed

number

Fixed penalty applied if throughput is exceeded.

Default value: 1000.

depots[].penalty.throughput.kg

number

Penalty for each extra kg of throughput exceeding.

Default value: 50.

depots[].penalty.throughput.unit

number

Penalty for each extra custom unit of throughput exceeding (units field).

Default value: 100.

depots[].penalty.throughput.vehicle *

number

Penalty for each extra vehicle per hour of throughput exceeding.

Default value: 100000.

depots[].point *

object

WGS84 coordinate of a location. More information

depots[].point.lat *

number

Minimum value: -90.
Maximum value: 90.

depots[].point.lon *

number

Minimum value: -180.
Maximum value: 180.

depots[].preliminary_service_duration_s

number

Duration of preliminary service at depot. This duration can include any operations that can be done before loading the vehicle. These operations will be done before depot_ready_time of deliveries that are loaded at this vehicle. More information

Minimum value: 0.
Maximum value: 3.1536e+09.

depots[].preset_id

string

Preset number for depot properties.

depots[].ref

string

Location reference.

depots[].service_duration_s

object

Duration of service at location. Service duration can include any operations at location, such as loading or unloading items from a vehicle, or any other time associated with a location (apart from waiting, which is time after arrival and before service).More information

depots[].service_duration_s.fixed

number

Fixed service duration for any part of the order.

depots[].service_duration_s.scaled

number

Service time for a part of an order, which is multiplied by order ratio.

depots[].throughput

object

Depot throughput limit. More information

depots[].throughput.kg_per_hour

object

depots[].throughput.kg_per_hour.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depots[].throughput.kg_per_hour.value

number

Throughput, kilograms per hour.

Minimum value: 0.

depots[].throughput.units_per_hour

object

depots[].throughput.units_per_hour.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depots[].throughput.units_per_hour.value

number

Throughput, custom units per hour.

Minimum value: 0.

depots[].throughput.vehicle_count

object

depots[].throughput.vehicle_count.time_window

string

The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero.

depots[].throughput.vehicle_count.value

number

Throughput, simultaneously vehicles.

Minimum value: 0.
Maximum value: 1e+09.

depots[].time_window

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depots[].time_windows[]

array

List of allowed time windows. Time windows can not overlap. Fields time_window and time_windows are mutually exclusive. Either none or all of time_window must have corresponding hard_time_window. More information

depots[].time_windows[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depots[].time_windows[].time_window *

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depots[].time_windows_loading

object

Time windows when the vehicle is allowed to leave the depot on the 1st run

depots[].time_windows_loading.hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depots[].time_windows_loading.hard_window

boolean

Time window, specified in the "time_window" field, should be hard, incompatible with the "hard_time_window" field.

depots[].time_windows_loading.penalty

object

depots[].time_windows_loading.penalty.early

object

Penalty components for early service (used instead of out_of_time penalty).

depots[].time_windows_loading.penalty.early.fixed

number

Fixed penalty applied if the location starts being served before the start of the time window.

Default value: 1000.

depots[].time_windows_loading.penalty.early.minute

number

Penalty for each minute of early arrival when the location starts being served before the start of the time window.

Default value: 17.

depots[].time_windows_loading.penalty.late

object

Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.

depots[].time_windows_loading.penalty.late.fixed

number

Fixed penalty applied if the location is visited after the end of the time window.

Default value: 1000.

depots[].time_windows_loading.penalty.late.minute

number

Penalty for each minute of lateness, when the location is visited after the end of the time window.

Default value: 17.

depots[].time_windows_loading.penalty.out_of_time

object

Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.

depots[].time_windows_loading.penalty.out_of_time.fixed

number

Fixed penalty applied if the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 1000.

depots[].time_windows_loading.penalty.out_of_time.minute

number

Penalty for each minute of lateness or early arrival when the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 17.

depots[].time_windows_loading.time_window

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depots[].time_windows_loading.time_windows[]

array

List of allowed time windows. Time windows can not overlap. Fields time_window and time_windows are mutually exclusive. Either none or all of time_window must have corresponding hard_time_window. More information

depots[].time_windows_loading.time_windows[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depots[].time_windows_loading.time_windows[].time_window *

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depots[].time_windows_refilling

object

Time windows when the vehicle is allowed to visit a depot (or middle depot) for additional loading

depots[].time_windows_refilling.hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depots[].time_windows_refilling.hard_window

boolean

Time window, specified in the "time_window" field, should be hard, incompatible with the "hard_time_window" field.

depots[].time_windows_refilling.penalty

object

depots[].time_windows_refilling.penalty.early

object

Penalty components for early service (used instead of out_of_time penalty).

depots[].time_windows_refilling.penalty.early.fixed

number

Fixed penalty applied if the location starts being served before the start of the time window.

Default value: 1000.

depots[].time_windows_refilling.penalty.early.minute

number

Penalty for each minute of early arrival when the location starts being served before the start of the time window.

Default value: 17.

depots[].time_windows_refilling.penalty.late

object

Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.

depots[].time_windows_refilling.penalty.late.fixed

number

Fixed penalty applied if the location is visited after the end of the time window.

Default value: 1000.

depots[].time_windows_refilling.penalty.late.minute

number

Penalty for each minute of lateness, when the location is visited after the end of the time window.

Default value: 17.

depots[].time_windows_refilling.penalty.out_of_time

object

Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.

depots[].time_windows_refilling.penalty.out_of_time.fixed

number

Fixed penalty applied if the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 1000.

depots[].time_windows_refilling.penalty.out_of_time.minute

number

Penalty for each minute of lateness or early arrival when the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 17.

depots[].time_windows_refilling.time_window

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depots[].time_windows_refilling.time_windows[]

array

List of allowed time windows. Time windows can not overlap. Fields time_window and time_windows are mutually exclusive. Either none or all of time_window must have corresponding hard_time_window. More information

depots[].time_windows_refilling.time_windows[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depots[].time_windows_refilling.time_windows[].time_window *

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depots[].time_windows_unloading

object

Time windows when the vehicle is allowed to return to the depot on the last run

depots[].time_windows_unloading.hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depots[].time_windows_unloading.hard_window

boolean

Time window, specified in the "time_window" field, should be hard, incompatible with the "hard_time_window" field.

depots[].time_windows_unloading.penalty

object

depots[].time_windows_unloading.penalty.early

object

Penalty components for early service (used instead of out_of_time penalty).

depots[].time_windows_unloading.penalty.early.fixed

number

Fixed penalty applied if the location starts being served before the start of the time window.

Default value: 1000.

depots[].time_windows_unloading.penalty.early.minute

number

Penalty for each minute of early arrival when the location starts being served before the start of the time window.

Default value: 17.

depots[].time_windows_unloading.penalty.late

object

Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.

depots[].time_windows_unloading.penalty.late.fixed

number

Fixed penalty applied if the location is visited after the end of the time window.

Default value: 1000.

depots[].time_windows_unloading.penalty.late.minute

number

Penalty for each minute of lateness, when the location is visited after the end of the time window.

Default value: 17.

depots[].time_windows_unloading.penalty.out_of_time

object

Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.

depots[].time_windows_unloading.penalty.out_of_time.fixed

number

Fixed penalty applied if the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 1000.

depots[].time_windows_unloading.penalty.out_of_time.minute

number

Penalty for each minute of lateness or early arrival when the location is visited outside of the time window. See the specifications of early and late options for more details in each case.

Default value: 17.

depots[].time_windows_unloading.time_window

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depots[].time_windows_unloading.time_windows[]

array

List of allowed time windows. Time windows can not overlap. Fields time_window and time_windows are mutually exclusive. Either none or all of time_window must have corresponding hard_time_window. More information

depots[].time_windows_unloading.time_windows[].hard_time_window

string

Allowed hard time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. Hard time window must include time range defined in corresponding time_window field. Fields hard_time_window and hard_window are mutually exclusive. More information

depots[].time_windows_unloading.time_windows[].time_window *

string

Allowed time window to visit location, in [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00, 2018-09-06T10:15:00Z/2018-09-06T12:45:00Z. More information

depots[].title

string

Location title.

depots[].type

string

Defines a type of depot: depot or crossdock.

• depot — the main depot where orders are stored.
• crossdock — the additional depot where there are no orders initially. To deliver orders from this depot, another vehicle must first deliver them here from the main depot where they are stored.

Default value: depot.

1. depot
2. crossdock

depots[].unload_service_duration_s

number

Additional duration for unloading pickup orders from a vehicle, added only if there is at least one pickup order,delivered in this depot.

Minimum value: 0.

depots[].use_in_proximity

boolean

When false, this depot will be ignored in computation of proximity and global proximity. When true, this depot will be used in computation of proximity and global proximity.If parameter is not defined, this depot will be used in computation of proximity in compatible mode.

initial_routes[]

array

List of routes in old response, which has to be loaded into solver.

initial_routes[].fixed_order

boolean

Locations, specified in initial_routes, cannot be reordered

initial_routes[].immutable

boolean

A route, specified in initial_routes, is used without changes.

initial_routes[].route[] *

array

Sequence of route nodes, comprising a route.

initial_routes[].route[].actual_arrival_time_s

object

Actual arrival time at the location.

initial_routes[].route[].actual_departure_time_s

object

Actual time of departure from the location.

initial_routes[].route[].actual_service_start_time_s

object

Actual time of service start in the location.

initial_routes[].route[].arrival_time_s

object

Arrival time at the location. Arrival happened before the start of the time window, will incur waiting time.

initial_routes[].route[].departure_time_s

object

Time of departure from the location.

initial_routes[].route[].load_to_head[]

array

List of orders that should be loaded to the head of the vehicle at depot or anchor location, in case trailers are used. Orders are listed in the order of serving.

initial_routes[].route[].load_to_trailer[]

array

List of orders that should be loaded to the trailer of the vehicle at depot, in case trailers are used. Orders are listed in the order of serving.

initial_routes[].route[].multi_order

boolean

An order is one of several orders at exactly the same location which are served together. Arrival time is the same for all orders in the group, also the orders share shared_service_duration_s. Total service duration of all orders in multi-order group is computed as: max(shared_service_duration_s) + sum(service_duration_s).

initial_routes[].route[].node *

object

Route component.

initial_routes[].route[].node.type

string

Type of a route component.

1. depot

initial_routes[].route[].node.value *

object

A representation of a location in initial routes

initial_routes[].route[].node.value.actual_total_service_duration_s

number

Actual total duration of service at a location (according to actual_arrival_time_s and actual_departure_time_s).

initial_routes[].route[].node.value.added_shared_service_duration_s

number

Added duration of shared service, for first order in multi-order equals to shared_service_duration_sFor other orders in multi-order maybe non-zero,if shared_service_duration_s of current order is more than shared_service_duration_s of previous orders

Minimum value: 0.
Maximum value: 3.1536e+09.

initial_routes[].route[].node.value.anchor_mode

string

Default value: Undefined.

1. Decoupling
2. Rolling
3. Coupling
4. Undefined

initial_routes[].route[].node.value.delivered_orders[]

array

List of IDs of orders delivered to the drop_off, depot or crossdock for delivery to the destination.

initial_routes[].route[].node.value.delivery_deadline

string

Time by which the pickup order without specified delivery_to field should be delivered to any depot, in [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00, 2018-09-06T10:15:00Z. More information

initial_routes[].route[].node.value.fixed_position

boolean

It is not allowed to move location or insert other locations before it

initial_routes[].route[].node.value.fixed_run

boolean

Order can only be added in the run in which it was planned

initial_routes[].route[].node.value.fixed_shift

boolean

Order can only be added in the shift in which it was planned

initial_routes[].route[].node.value.fixed_vehicle

boolean

Order can only be taken by the vehicle in which it was planned

initial_routes[].route[].node.value.id *

object

Reference to a location specified in locations. More information

initial_routes[].route[].node.value.keep_in_vehicle

boolean

When order is dropped it still takes space in the vehicle

initial_routes[].route[].node.value.loaded_orders[]

array

Ids of delivery orders, loaded into the vehicle in garage or depot.

initial_routes[].route[].node.value.parking_mode

string

Default value: Undefined.

1. ParkingBegin
2. ParkingRefill
3. ParkingEnd
4. Undefined

initial_routes[].route[].node.value.parking_type

string

1. trailer
2. vehicle

initial_routes[].route[].node.value.picked_orders[]

array

A list of IDs of orders picked up in the crossdock or depot.

initial_routes[].route[].node.value.pickup_id

object

ID of a pickup corresponding to this delivery.

initial_routes[].route[].node.value.pickup_ids[]

array

List of IDs of pickups corresponding to this delivery.

initial_routes[].route[].node.value.service_waiting_duration_s

number

Duration of waiting for service at a location. It can be non-zero when, for example, an order is a part of a multi-order, in this case waiting duration includes duration of service of the other orders from the multi-order.

Minimum value: 0.
Maximum value: 3.1536e+09.

initial_routes[].route[].node.value.split_info

object

Information about split part of the order (in case if the order was split)

initial_routes[].route[].node.value.split_info.order_ratio

number

Order ratio, included in this part.

initial_routes[].route[].node.value.split_info.part_id

integer

Number of this part of the order.

initial_routes[].route[].node.value.split_info.parts_count

integer

Number of parts, in which the order was split.

initial_routes[].route[].node.value.split_info.units

number

Size of this part in custom units (in case there was corresponding quant specified for this order).

initial_routes[].route[].node.value.split_info.volume_cbm

number

Volume of this part, cubic meters (in case there was corresponding quant specified for this order).

initial_routes[].route[].node.value.split_info.weight_kg

number

Weight of this part, kilograms (in case there was corresponding quant specified for this order).

initial_routes[].route[].node.value.total_service_duration_s

number

Total duration of service at a location, it includes service_duration_s, added_shared_service_duration_s` parking_service_duration_sandservice_waiting_duration_s`.

Minimum value: 0.
Maximum value: 3.1536e+09.

initial_routes[].route[].node.value.trailer_decoupled

boolean

initial_routes[].route[].node.value.trailer_used

boolean

initial_routes[].route[].node.value.undroppable

boolean

Location cannot be dropped

initial_routes[].route[].node.value.unfeasible_reasons[]

array

List of unfeasible reasons.

initial_routes[].route[].node.value.unfeasible_reasons[].custom_type

string

Type of custom units that caused overload in case of OVERLOAD_CUSTOM.

initial_routes[].route[].node.value.unfeasible_reasons[].overload *

number

The overload value. The unit used depends on the overload type:

• OVERLOAD_WEIGHT - overload in kg.
• OVERLOAD_SIZE - extra size in custom units (units field).
• OVERLOAD_VOLUME - excess volume in m^3.
• OVERLOAD_CUSTOM - extra size in custom units (custom field).

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• OVERLOAD_WEIGHT - vehicle was carrying over maximum defined weight,
• OVERLOAD_SIZE - the cargo did not fit into the vehicle based on its size in custom units (units field),
• OVERLOAD_VOLUME - the cargo volume exceeds vehicle storage space,
• OVERLOAD_CUSTOM - the cargo did not fit into the vehicle based on its size in custom units (custom field),

1. OVERLOAD_WEIGHT
2. OVERLOAD_SIZE
3. OVERLOAD_VOLUME
4. OVERLOAD_CUSTOM

initial_routes[].route[].node.value.unfeasible_reasons[].late_duration_s *

number

The duration of late arrival, (arrival time) - (end of time window), seconds.

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• FAILED_HARD_TIME_WINDOW - the vehicle could not reach the location within a specified hard time window,

1. FAILED_HARD_TIME_WINDOW

initial_routes[].route[].node.value.unfeasible_reasons[].tags[] *

array

List of missing required tags.

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• REQUIRED_TAGS_VIOLATION - the vehicle doesn't have required tags.

1. REQUIRED_TAGS_VIOLATION

initial_routes[].route[].node.value.unfeasible_reasons[].tags[] *

array

List of present excluded tags.

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• EXCLUDED_TAGS_VIOLATION - the order has the vehicle's excluded tags.

1. EXCLUDED_TAGS_VIOLATION

initial_routes[].route[].node.value.unfeasible_reasons[].overrun_s *

number

The amount of time by which the hard transit time restriction was exceeded, in seconds

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• TRANSIT_TIME_VIOLATION - cannot satisfy hard transit time requirement while fulfilling the order,

1. TRANSIT_TIME_VIOLATION

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[] *

array

List of all incompatibile load type pairs

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[].incompatible_order_id *

object

Reference to a location specified in locations. More information

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[].types[] *

array

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[].types[].other_type *

string

Load type of the incompatible order.

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[].types[].self_type *

string

Load type of the current order.

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• INCOMPATIBLE_LOAD_TYPES_VIOLATION - the order is incompatible with other order in run by load types.

1. INCOMPATIBLE_LOAD_TYPES_VIOLATION

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[] *

array

List of all incompatibile zone pairs

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[].incompatible_order_id *

object

Reference to a location specified in locations. More information

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[].zones[] *

array

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[].zones[].other_zone *

string

Load type of the incompatible order.

initial_routes[].route[].node.value.unfeasible_reasons[].incompatibilities[].zones[].self_zone *

string

Load type of the current order.

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• INCOMPATIBLE_ZONES_VIOLATION - the order is incompatible with other order in run by zones.

1. INCOMPATIBLE_ZONES_VIOLATION

initial_routes[].route[].node.value.unfeasible_reasons[].tags[] *

array

List of vehicle's allowed zones.

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• ALLOWED_ZONES_VIOLATION - location doesn't belong to any of vehicle's allowed zones.

1. ALLOWED_ZONES_VIOLATION

initial_routes[].route[].node.value.unfeasible_reasons[].tags[] *

array

List of present forbidden zones.

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• FORBIDDEN_ZONES_VIOLATION - location belongs to some of the vehicle's forbidden zones.

1. FORBIDDEN_ZONES_VIOLATION

initial_routes[].route[].node.value.unfeasible_reasons[].text *

string

Explanation for the reason the location was not feasible.

initial_routes[].route[].node.value.unfeasible_reasons[].type *

string

Possible reasons:

• OTHER - the location is not feasible for a different reason.

1. OTHER

initial_routes[].route[].node.value.zones[]

array

List of zones.

initial_routes[].route[].node.type

string

Type of a route component.

1. location

initial_routes[].route[].node.value *

object

A representation of a location in initial routes

initial_routes[].route[].node.value.actual_total_service_duration_s

number

Actual total duration of service at a location (according to actual_arrival_time_s and actual_departure_time_s).

initial_routes[].route[].node.value.added_shared_service_duration_s

number

Added duration of shared service, for first order in multi-order equals to shared_service_duration_sFor other orders in multi-order maybe non-zero,if shared_service_duration_s of current order is more than shared_service_duration_s of previous orders

Minimum value: 0.
Maximum value: 3.1536e+09.

initial_routes[].route[].node.value.anchor_mode

string

Default value: Undefined.

1. Decoupling
2. Rolling
3. Coupling
4. Undefined

initial_routes[].route[].node.value.delivered_orders[]

array

List of IDs of orders delivered to the drop_off, depot or crossdock for delivery to the destination.

initial_routes[].route[].node.value.delivery_deadline

string

Time by which the pickup order without specified delivery_to field should be delivered to any depot, in [D.]HH[:MM[:SS]] format or ISO 8601 2018-09-06T10:15:00+03:00, 2018-09-06T10:15:00Z. More information

initial_routes[].route[].node.value.fixed_position

boolean

It is not allowed to move location or insert other locations before it

initial_routes[].route[].node.value.fixed_run

boolean

Order can only be added in the run in which it was planned

initial_routes[].route[].node.value.fixed_shift

boolean

Order can only be added in the shift in which it was planned

initial_routes[].route[].node.value.fixed_vehicle

boolean

Order can only be taken by the vehicle in which it was planned

initial_routes[].route[].node.value.id *

object

Reference to a location specified in locations. More information

initial_routes[].route[].node.value.keep_in_vehicle

boolean

When order is dropped it still takes space in the vehicle

initial_routes[].route[].node.value.loaded_orders[]

array

Ids of delivery orders, loaded into the vehicle in garage or depot.

initial_routes[].route[].node.value.parking_mode

string

Default value: Undefined.

1. ParkingBegin
2. ParkingRefill
3. ParkingEnd
4. Undefined

initial_routes[].route[].node.value.parking_type

string

1. trailer
2. vehicle

initial_routes[].route[].node.value.picked_orders[]

array

A list of IDs of orders picked up in the crossdock or depot.

initial_routes[].route[].node.value.pickup_id

object

ID of a pickup corresponding to this delivery.

initial_routes[].route[].node.value.pickup_ids[]

array

List of IDs of pickups corresponding to this delivery.

initial_routes[].route[].node.value.service_waiting_duration_s

number

Duration of waiting for service at a location. It can be non-zero when, for example, an order is a part of a multi-order, in this case waiting duration includes duration of service of the other orders from the multi-order.

Minimum value: 0.
Maximum value: 3.1536e+09.

initial_routes[].route[].node.value.split_info

object

Information about split part of the order (in case if the order was split)

initial_routes[].route[].node.value.split_info.order_ratio

number

Order ratio, included in this part.

initial_routes[].route[].node.value.split_info.part_id

integer

Number of this part of the order.

initial_routes[].route[].node.value.split_info.parts_count

integer

Number of parts, in which the order was split.

initial_routes[].route[].node.value.split_info.units

number

Size of this part in custom units (in case there was corresponding quant specified for this order).

initial_routes[].route[].node.value.split_info.volume_cbm

number

Volume of this part, cubic meters (in case there was corresponding quant specified for this order).

initial_routes[].route[].node.value.split_info.weight_kg

number