_id | The unique id of the VRP template |
companyId | Our unique company id |
name | The name of the VRP template |
input | All the inputs for the VRP templates |
input.vehicleIds | The list of the unique ids of the vehicles that on the VRP template |
input.trayId | The id of the tray where the orders are that should be run in the VRP template |
input.optimizeFormula | A string value that tells what can of optimize formula that will be used. The different options and their meaning can be found in the table below |
input.maxColli | The number of colli that a vehicle can have. If the value is 0, it's unlimited |
input.maxTripTime | The max time length a vehicle can have, in seconds. If the value is 0, it's unlimited |
input.maxStops | The number of stops a vehicle can have. If the value is 0, it's unlimited |
input.maxWeight | A boolean value. If the value is true, it will take the max weight a vehicle have been set at and calculate the weight of an ordre against it |
input.maxVolume | A boolean value. If the value is true, it will take the max volume a vehicle have been set at and calculate the volume of an ordre against it |
input.timeWindows | A boolean value. If the value is true, time windows will be used. If false, all time windows will be ignored |
input.startLocationId | An id of a location. If it's being set, it will use this location as start location for all vehicles, instead of the vehicles own start location |
input.endLocationId | An id of a location. If it's being set, it will use this location as end location for all vehicles, instead of the vehicles own end location |
input.breakDuration | The break duration is the time a vehicle break is in seconds. If the value of breakDuration or breakDrivingTime is 0, a break won't be added to the vehicle |
input.breakDrivingTime | The break driving time is the time a vehicle have to drive in seconds, before a break will be added. If the value of breakDuration or breakDrivingTime is 0, a break won't be added to the vehicle |
input.autoAssign | A boolean value. If the value is true, the VRP template will assign the generated trips to the vehicles automatically. If the value is false, an user have to manually assign the VRP template |
input.autoPlannedDone | A boolean value. If the value is true, the trips will be marked as done automatically when they have been assigned to a vehicle. If the value is false, an user can do it manually if wanted |
input.autoPinned | A boolean value. If the value is true, the stops on a trip is marked pinned automatically when they have been assigned to a vehicle. If the value is false, an user can do it manually if wanted |
input.vehiclesInfo | An array of more detail list of the vehicles in the VRP template |
input.vehiclesInfo._id | The unique id of the vehicle |
input.vehiclesInfo.name | The name of the vehicle |
input.vehiclesInfo.startLocationId | An id of a location. If it have been set, it will be used if input.startLocationId haven't been set |
input.vehiclesInfo.endLocationId | An id of a location. If it have been set, it will be used if input.endLocationId haven't been set |
input.vehiclesInfo.maxWeight | The max weight of the goods the vehicle can have at once in kg |
input.vehiclesInfo.volume | The max volume of the goods the vehicle can have at once in m3 |
input.vehiclesInfo.maxDrivingTime | The max driving time a vehicle can be out on a route in seconds |
input.vehiclesInfo.maxColli | The max number of colli the vehicle can have at once |
input.vehiclesInfo.maxStops | The max number of stops the vehicle can have on a route |
input.vehiclesInfo.startTimes | An object containing all week days |
input.vehiclesInfo.startTimes[weekDay].value | A date where only the time will be used to set the start time for a vehicle on the giving week day. The time is in UTC |