Geoptimization API  -  Geoptimization REST API

id
optional

Example : "null"

string

language
optional

Example : "null"

string

orders
optional

< json_TSOrder > array

message
optional

Example : "null"

string

status
optional

Example : "null"

string

depots
optional

List of depots

< json_TSDepot > array

message
optional

error message
Example : "null"

string

status
optional

response status, OK or ERROR

json_Status

feature
optional

json_EbookingWebhookFeature

payload
optional

object

lastKnownPosition
optional

List of positions

< json_OperationalLastKnownPosition > array

message
optional

error message
Example : "null"

string

operationalOrderAchievements
optional

List of orders

< json_OperationalOrderAchievement > array

status
optional

response status, OK or ERROR

json_Status

address
optional

Example : "null"

string

addressComplement
optional

Example : "null"

string

city
optional

Example : "null"

string

country
optional

Example : "null"

string

geocodeAddressLine
optional

Example : "null"

string

geocodeCity
optional

Example : "null"

string

geocodePostalCode
optional

Example : "null"

string

geocodeType
optional

number

postcode
optional

Example : "null"

string

region
optional

Example : "null"

string

score
optional

number

message
optional

error message
Example : "null"

string

status
optional

response status, OK or ERROR

json_Status

token
optional

the token string
Example : "null"

string

validUntil
optional

The token validity end date

number

dayNums
optional

< number > array

force
optional

if true, any existing operational planning will be replaced if false and if optimization period overlaps any existing operational planning, export will fail.

boolean

resourceMapping
optional

List of MobileResourceMapping defining relation between resource identifier in optimize request and real mobile resource identifier

< json_OperationalResourceMapping > array

startDate
optional

real date corresponding to day 1 of optimize request data

number

taskId
optional

Task identifier. Must point to a completed optimization.
Example : "null"

string

accuracy
optional

GPS positioning accuracy (radius in meters)

number

batteryLevel
optional

Battery level of the device

number

date
optional

last position recording date

number

gpsStatus
optional

GPS status of the device

json_GPSStatus

id
optional

Example : "null"

string

lat
optional

Latitude

number

lon
optional

Longitude

number

privateLife
optional

Private life status in Mobile App. If true, it means that mobile App is currently in Private life mode, therefore this position is the last known position before the Private life switch.

boolean

achievementComment
optional

Achievement comment
Example : "null"

string

achievementEnd
optional

Achievement end date and time

number

achievementEndLat
optional

Achievement end latitude

number

achievementEndLon
optional

Achievement end longitude

number

achievementStart
optional

Achievement start date and time

number

achievementStartLat
optional

Achievement start latitude

number

achievementStartLon
optional

Achievement start longitude

number

apprauchSmsId
optional

Example : "null"

string

apprauchSmsStatus
optional

Example : "null"

string

data
optional

fulfillment form data

< string, string > map

date
optional

Planning day

number

end
optional

Planned end date and time

number

feedbackSmsId
optional

Example : "null"

string

feedbackSmsStatus
optional

Example : "null"

string

geocode
optional

json_GeocodeInfos

id
optional

Example : "null"

string

lastSynchroStatusChange
optional

Last change from mobile app

number

lat
optional

Latitude

number

lon
optional

Longitude

number

operationalResourceId
optional

Mobile resource identifier (mobile app login)
Example : "null"

string

order
optional

Original order

json_TSOrder

pictures
optional

List of picture relative urls. Url root for pictures is https://geoservices.geoconcept.com/ToursolverCloud/api/rest/otmobile/pictures/

< string > array

plannedOrder
optional

Planned order

json_TSPlanned

signaturePicture
optional

Signature, as a picture relative URL (a flavor of the reference signatureSvg)

Is bound and synced from the signaturesSvg field. Is a relative URL, as also done for the pictures field (see its documentation for details).
Example : "null"

string

signatureSvg
optional

Signature svg
Example : "null"

string

simulationDayId
optional

day containing this order in the simulation used to fill the fulfillment planning
Example : "null"

string

simulationId
optional

identifier of the simulation used to fill the fulfillment planning
Example : "null"

string

start
optional

Planned start date and time

number

status
optional

fulfillment status

json_OperationalOrderStatus

synchroStatus
optional

Sync status

json_OperationalOrderSynchroStatus

timeWindowEnd
optional

number

timeWindowSmsId
optional

Example : "null"

string

timeWindowSmsStatus
optional

Example : "null"

string

timeWindowStart
optional

number

type
optional

Event type

json_OperationalOrderType

id
optional

resource identifier
Example : "null"

string

operationalId
optional

Mobile identifier
Example : "null"

string

message
optional

error message
Example : "null"

string

plannedOrders
optional

the planned stops

< json_TSPlanned > array

simulationId
optional

Id of the simulation associated to this task
Example : "null"

string

status
optional

response status, OK or ERROR

json_Status

taskId
optional

the id of the optimization task (usefull if result is automatically sent through a webhook).
Example : "null"

string

unplannedOrders
optional

the orders which has not been planned because: <li>it was sent by an other mail service <li>it was not scheduled by any resource.

< json_TSUnplanned > array

warnings
optional

the list of warning messages (and associated error codes) about possible Orders and Resources elements constraints misconfiguration.

< json_TSWarning > array

currentCo2
optional

Remaining Kg CO2 of the current solution

number

currentCost
optional

Cost of the current solution

number

currentCourierCost
optional

Courier cost of the current solution

number

currentDeliveredQuantity
optional

Total quantity delivered of the current solution

number

currentDeliveryCost
optional

Delivery cost of the current solution

number

currentDriveCost
optional

Drive cost of the current solution

number

currentDriveDistance
optional

Drive distance of the current solution

number

currentDriveTime
optional

Drive time in seconds of the current solution

number

currentFixedCost
optional

Fixed cost of the current solution

number

currentLateTime
optional

Late time in seconds of the current solution

number

currentNightsCost
optional

Nights cost of the current solution

number

currentOpenTourNumber
optional

initial number of open tours (tours with at least one visit)

number

currentOverWorkCost
optional

Overwork cost of the current solution

number

currentOverWorkTime
optional

Over work time in seconds of the current solution

number

currentPickUpQuantity
optional

Total quantity picked-up of the current solution

number

currentPlannedVisits
optional

Number of planned visits of the current solution (new engine only)

number

currentRestTime
optional

Rest time in seconds of the current solution

number

currentUnplannedVisits
optional

Number of visits unplanned or delivered by a courier of the current solution

number

currentVisitsNb
optional

number

currentWaitTime
optional

Wait time in seconds of the current solution

number

currentWorkCost
optional

Work cost of the current solution

number

currentWorkTime
optional

Work time in seconds of the current solution

number

initialCo2
optional

Remaining Kg CO2 of the initial solution

number

initialCost
optional

Cost of the initial solution

number

initialCourierCost
optional

Courier cost of the initial solution

number

initialDeliveredQuantity
optional

Total quantity delivered of the initial solution

number

initialDeliveryCost
optional

Delivery cost of the initial solution

number

initialDriveCost
optional

Drive cost of the initial solution

number

initialDriveDistance
optional

Drive distance of the initial solution

number

initialDriveTime
optional

Drive time in seconds of the initial solution

number

initialFixedCost
optional

Fixed cost of the initial solution

number

initialLateTime
optional

Late time in seconds of the initial solution

number

initialNightsCost
optional

Nights cost of the initial solution

number

initialOpenTourNumber
optional

initial number of open tours (tours with at least one visit)

number

initialOverWorkCost
optional

Overwork cost of the initial solution

number

initialOverWorkTime
optional

Over work time in seconds of the initial solution

number

initialPickUpQuantity
optional

Total quantity picked-up of the initial solution

number

initialPlannedVisits
optional

Number of planned visits of the initial solution (new engine only)

number

initialRestTime
optional

Rest time in seconds of the initial solution

number

initialUnplannedVisits
optional

Number of visits unplanned or delivered by a courier of the initial solution

number

initialWaitTime
optional

Wait time in seconds of the initial solution

number

initialWorkCost
optional

Work cost of the initial solution

number

initialWorkTime
optional

Work time in seconds of the current solution

number

message
optional

error message
Example : "null"

string

mileageChartRemainingTime
optional

Mileage and travel time matrix computing remaining time. This information may not be available depending on the geographical area.

number

optimizeStatus
optional

Current status of the optimization process

json_OptimizeStatus

simulationId
optional

Id of the simulation associated to this task
Example : "null"

string

startTime
optional

Start time of the optimization

number

status
optional

response status, OK or ERROR

json_Status

subOptimAbortedNb
optional

Number of sub-optimizations in aborted state

number

subOptimErrorNb
optional

Number of sub-optimizations in error state

number

subOptimFinishedNb
optional

Number of sub-optimizations in finished state

number

subOptimNb
optional

Number of sub-optimizations created (after pre-sectorization)

number

subOptimRunningNb
optional

Number of sub-optimizations in running state

number

subOptimWaitingNb
optional

Number of sub-optimizations in waiting state

number

firstStopAsked
optional

First stop demand stamp

number

message
optional

error message
Example : "null"

string

status
optional

response status, OK or ERROR

json_Status

message
optional

error message
Example : "null"

string

status
optional

response status, OK or ERROR

json_Status

taskId
optional

the id of the optimization task (usefull if result is automatically sent through a webhook).
Example : "null"

string

tours
optional

List of tours (one tour per resource per day)

< json_TSTour > array

unplannedOrders
optional

the orders which has not been planned because: <li>it was sent by an other mail service <li>it was not scheduled by any resource.

< json_TSUnplanned > array

warnings
optional

the list of warning messages (and associated error codes) about possible Orders and Resources elements constraints misconfiguration.

< json_TSWarning > array

beginDate
optional

This date will be used if you try to export the optimization result through TsCloud GUI.

Format : YYYY-MM-DD

Default : day+1.

number

countryCode
optional

Main country code used to route the optimization to the good optimization server farm.
Example : "null"

string

depots
optional

list of depots (for reloading or starting tours)

< json_TSDepot > array

language
optional

Language to use for message localization
Example : "null"

string

options
optional

the optimize task options

json_TSOptions

orders
optional

list of orders (visits to do)

< json_TSOrder > array

organization
optional

In multi-user content, you generally create various organizations that allows to define who sees what. If you set the organization here, only users that can see this organization will see the result of this optimization in the UI.

Note that if you specified a teamId instead of sending the resources in the optimization data, the organization will be guessed from the team.

If no organization is set, all users will see the result.
Example : "null"

string

resources
optional

collection of resources, the elements which will perform deliveries, pick-ups, commercial visit, etc.

< json_TSResource > array

simulationName
optional

Simulation name

Optional : generated automatically if not provided
Example : "null"

string

userLogin
optional

In multi-user content, you can specify a user login you. The simulation will be owned by this user. By default, the owner of the simulation is the default user of the account.
Example : "null"

string

message
optional

error message
Example : "null"

string

status
optional

response status, OK or ERROR

json_Status

taskId
optional

the id of the optimization task that was launched
Example : "null"

string

id
optional

Example : "null"

string

message
optional

error message
Example : "null"

string

resources
optional

List of resources

< json_TSResource > array

status
optional

response status, OK or ERROR

json_Status

message
optional

error message
Example : "null"

string

simulation
optional

json_TSSimulation

status
optional

response status, OK or ERROR

json_Status

type
optional

TSOrder type (stored in a custom data)
Example : "null"

string

value
optional

Cost for this type

number

allProductsRequired
optional

Indicates whether a resource must provide all required products or one at least.

Set it to True to indicate that a resource must provide all the depot required products. Set it to False to indicate that a resource must provide at least one of the depot required products.

Type : boolean Default : True

boolean

availability
optional

Indicates whether a depot is included in the planning process or not.

This constraint enables you to easily modify your optimization problem configuration without having to add nor delete your original data.

* Set it to True to include a depot element in the planning process.

* Set it to False to ignore it: it will not be used in the planning.

boolean

deliveryQuantities
optional

The available quantities of products available at the depot.

You can specify up to 24 quantities

Type : float array

< number > array

excludeResources
optional

The list of resources excluded from the depot.

Use this constraint to specify a list of resources that can not use the depot.

Type : string array. Default: Empty array: no resource is excluded from the depot
Example : "null"

string

fixedLoadingDuration
optional

The fixed duration for a resource to load at depot. Use this constraint to specify how long takes any resource reload at the depot. You can specify an additional duration according to the quantity to reload, using loadingDurationPerUnit.

Type : "hh:mm:ss", DateTime. Default : "00:00:00".

Example :

tsDepot fixedVisitDuration = "00:30:00" indicates that 30 minutes are needed to load at the depot. tsDepot loadingDurationPerUnit = 120 indicates that 120 seconds are needed to load one unit. If the quantity to reload is 8, for instance, the variable part is 120*8. 16 minutes are required to load at the depot. Total load time = 30 minutes + 16 minutes = 46 minutes accounted for this reload break.
Example : "null"

string

id
optional

The unique identifier of the depot
Example : "null"

string

loadingDurationPerUnit
optional

The time needed to load a unit of product. This constraint is added to the fixed part of the loading duration: it depends on the total quantity to load.

Type : "hh:mm:ss", DateTime, Integer (number of seconds). Default : 0.
Example : "null"

string

openingDaysList
optional

The depot days of opening, related to the nth depot time window.

Use this constraint to specify the days of operation of a depot referring to a depot time window. It must be related to the tsResourceWorkDays constraint of the resources, as resources work days define the planning period. Depot may be opened on a 64-days long period max, from day 1 to day 64.

Type : string value containing days separated with commas (like "1, 2, 5" or "4, 20/05/2010") or intervals (like "1-10", "2=>5" or "22/05/2010=>03/06/2010"). For day intervals, prefer the "=>" separator. 1 is the first day of the planning period, the corresponding date, if any, is defined by the oldest date, for all resources, in the tsResourceWorkDays constraint. No date in the depots days of opening description can precede the first day of the planning period defined by the resources (which is day 1). Default : 1=>64.

Example :

* Set it to "1" (or "14/05/2010) when a depot is opened on the first day of the planning period. Set it to "1, 2, 4, 5" (or "14/05/2010,15/05/2010,17/05/2010,18/05/2010") if depot may not be visited on the third day of a five-days planning period.

* Set it to "1=>5" (or "14/05/2010=>18/05/2010") to define a 5-days long period during which the depot is opened.

< string > array

pickupQuantities
optional

The available space for a product available at the depot.

You can specify up to 24 values.

Type : float array

< number > array

priority
optional

Depot priority.

Use this constraint to specify a priority on the depot. If two depots are nearby the system considers the one with the highest priority

**Type : * integer

number

requiredProducts
optional

The list of the products a depots contains.

Use this constraint when a depot must be affected to a specific kind of resource: these resources will have to provide the required required to be able to load at the depot.

Type : string (as a list of products separated with commas).

Default : none
Example : "null"

string

resourceNames
optional

Lists the resources that can use the depot.

Type : string array.

Default : Empty array: no resource can use the depot.

Example : Specify ["Vehicle 1","Vehicle 2"] to allow only the resources with tags "Vehicle 1" and "Vehicle 2" to use the depot.
Example : "null"

string

timeWindows
optional

The depot time windows.

Use this constraint to specify a depot time window during which the depot is opened. A depot time window is defined by its start time, its end time and days of opening. The start time of a depot time window is the first instant when a resource can enter the depot. Its end time is the last instant when a resource can enter the depot (but it may leave it afterward). You can specify up to 4 depot time windows for each depot.

Type : "hh:mm:ss", DateTime. Default : "00:00:00".

< json_TSTimeWindow > array

travelTimeModifier
optional

Indicates the value of the travel time modifier.

When reaching a location situated in a large city, one may want to take into account driving difficulties, such as narrow streets and congestion. The travel time modifier enables to increase the travel times around a location. It is describes by three values. The value by which multiply the travel times around the location (tsDepotTravelTimeModifierValue), the portion of the travel time on which the modifier applies (tsDepotTravelTimeModifierLength) an offset to add to any travel duration leaving or reaching the location (tsDepotTravelTimeModifierOffSet).

Example :

* Set tsResource travelTimeModifierValue to 1.5, tsResource travelTimeModifierLength to 300 and tsResource travelTimeModifierOffSet to 60 for Resource 1

* Set tsDepot travelTimeModifierValue to 2, tsDepot travelTimeModifierLength to 420 and tsDepot travelTimeModifierOffSet to 0 for Depot 1 If the initial travel duration between Resource 1 and Depot 1 was 1000, one obtains a travel time 360 * 1.5 + 60 + 280 + 420 * 2 + 0 = 1660

Type : float, Default : 1

json_TSTravelTimeModifier

x
optional

longitude WGS84 of depot

number

y
optional

latitude WGS84 of depot

number

orderOriginalResourceId
optional

The identity of the resource which visits the customer when evaluating an existing planning.

* Use this constraint when you want to evaluate an existing planning.

* Use the orderOriginalVisitDay constraint to specify the working day when the visit must be planned.

* Use the orderPosition constraint to specify the position of a visit in the tour.

Type : string (storing a unique resource tag). Default: : not used
Example : "null"

string

orderOriginalVisitDay
optional

Indicates the work day when the resource which visits the customer when evaluating an existing planning.

* Use this constraint when you want to evaluate an existing planning.

* Use the orderOriginalResourceID to specify the resource which visit the customer.

* Use the orderPosition to specify the position of a visit in the tour.

Type : integer between 1 and 64 or string representing a date.

1 is the first day of the planning period, the corresponding date, if any, is defined by the oldest date, for all resources, in the tsResourceWorkDays constraint. if the original visit day is in the date format, this date cannot precede the first day of the planning period defined by the resources (which is day 1).

Default : not used if the tsOrderOriginalResourceIDis not used, 1 overwise
Example : "null"

string

orderPosition
optional

The position of a customer in a resource tour.

Use this constraint when you want to evaluate a tour.

Type : integer. Default : not used

number

allowBridge
optional

Allow toll If false, all bridges will be avoided.

Default : true.

boolean

allowToll
optional

Allow toll If false, all toll ways will be avoided.

Default : true.

boolean

allowTunnel
optional

Allow toll If false, all tunnels will be avoided.

Default : true.

boolean

balanceType
optional

Route plans balancing type

* NONE : no balancing

* ORDERS : balance the number of orders (to be used with balanceValue)

* HOURS : balance the route plans duration

* QUANTITY : balance the route plans delivered quantity

Only available with OTSolver

json_BalanceType

balanceValue
optional

Route plans balancing target (to be used with balanceType)

Locked route plans are not considered.

Only available with OTSolver

number

countDepotsInDeliveryCost
optional

Depot cost configuration for tour delivery cost

Specifies how depots stops are counted in tour delivery cost (using PenaltyPerVisit defined on resources).

Possible values are :

* NONE : depots stops are not counted in tour delivery cost

* ALL : each depot stop counts as one visit in tour delivery cost

* ALLBUTFIRST : first depot stop is ignored but each following depot stop will count as one visit in tour delivery cost

* FIRST : only first depot stop is counted in tour delivery cost

Default : NONE.

json_DepotCostMode

countVisitCostOnceIfSameLocation
optional

If true, PenalPerVisit will counted only once in tour delivery cost if several visits at the same location are planned consecutively.

boolean

distanceType
optional

Set the distance unit (meters, feet, km or miles), defaut is meters

json_DistanceType

evaluation
optional

Enable this if you just want to evaluate (get cost, distances, etc) a set of tours. Therefore, you must fill the evaluationInfos objects in orders

Default : false.

(see TSEvaluationInfos)

boolean

excludeVisitCostIfMaxAdditionalCost
optional

Exclude visit delivery cost for visits having the maximum additional cost

boolean

fuelCode
optional

Vehicles fuel type. Possible values are :

* diesel

* undefined

* unleaded
Example : "null"

string

maxOptimDuration
optional

maximum optimization time. Default is one minute.

Type : Time ("hh:mm" or "hh:mm:ss") or Integer (number of minutes)
Example : "null"

string

noReload
optional

Use it to forbid/allow reloads

Default : false.

boolean

reloadDuration
optional

Default reload duration

Type : Time ("hh:mm" or "hh:mm:ss") or Integer (number of minutes)
Example : "null"

string

routingMethod
optional

Routing method

Specifies routing method used for travel time and distance matrix computation

Possible values are :

* TIME : routes minimizing travel time are used

* DISTANCE : routes minimizing travel distance are used

Default : TIME.

json_RoutingMethod

sendResultToWebhook
optional

Enable result export to webhook

If enabled, optimization result will be sent to the webook you defined in Toursolver Cloud configuration.

Possible values are :

* NONE : result will not be sent automatically when optimization finishes. You will have to call the result or toursResult service to retrieve it.

* ORDERS : the "orders" result will be sent to the specified webhook. See OptimResultResult object for details.

* TOURS : the "tours" result will be sent to the specified webhook. See OptimToursResult object for details.

Default : NONE.

json_WebhookExportMode

speedPattern
optional

Speed pattern name

Specifies the speed pattern to be used for this optimization. "default_profile" is the internal name for the default speed pattern (its actual name in UI depends on your locale).

You can use your own speed pattern (defined in Toursolver UI) but you will have to use its internal name : if you created a pattern called "Paris august speed pattern", its internal name will be "paris_august_speed_pattern".

If set to null (or not defined), no speed pattern will be used at all (same speeds for whole day).
Example : "null"

string

startFromEvaluationInfo
optional

Enable this if you want the optimization to start from a specified initial configuration. Therefore, you must fill the evaluationInfos

Default : false.

objects in orders (see TSEvaluationInfos).

boolean

teamId
optional

If you did not specify any resource in your request, all resources defined in your tenant will be used for this optimization. If you specify a team identifier, only the resources of this team will be used.
Example : "null"

string

useForbiddenTransitAreas
optional

Whether to use forbidden transit areas

Specifies true to use forbidden transit areas, and false to ignore forbidden transit areas

If omitted, default to true, but has no effect if no forbidden transit areas are supplied

boolean

useOTSolver
optional

Whether to use OTSolver instead of TSDK

OTSolver is the new optimization engine behind Toursolver. It behaves better with big problems (more than 1000 visits). This is still a beta version and all the constraints supported by TSDK are not supported yet but they will be implemented as soon as possible.

OTSolver must be enabled for your account before you can use it.

boolean

vehicleCode
optional

Vehicles regulations.

Possible values are :

* bicycle

* bus

* car

* deliveryIntermediateVehicle

* deliveryLightCommercialVehicle

* emergencyTruck

* emergencyVehicle

* intermediateVehicle

* lightCommercialVehicle

* pedestrian

* taxi

* truck

If not specified, vehicle type defined in UI will be used
Example : "null"

string

active
optional

Indicates whether the order should scheduled or not

Default : True.

boolean

allSkillsRequired
optional

Indicates whether a resource must provide all required skills or one at least.

* Set it to True to indicate that a resource must provide all the customer required skills.

* Set it to False to indicate that a resource must provide at least one of the customer required skills.

Default : True.

boolean

assignResources
optional

The identities of the resources that can deliver a customer.

Use this constraint when you want some customers to be delivered by specific resources.

Type : string array containing resources tag ID

Default : not used.

< string > array

courierPenalty
optional

The cost of the order delivered by an independant transport device.

Use this constraint when an order can be delivered independantly to specify the cost of the device. The solver engine will assign it to a courier device or integrate it in a tour according to the least cost.

Type : float.

Default : not used.

number

customDataMap
optional

Private feature data.

Use this feature when you need to keep accessible private data about customers. For instance if you need to export the address of an element in a planning report, store it there. These informations can also be exported to the mobile app.

max 50 fields

Default : empty.

< string, string > map

customerId
optional

Example : "null"

string

delayPenaltyPerHour
optional

The penalty per hour for being late at a customer.

Use this constraint to allow a smarter control, with respect to time windows, than with the use of the tsOrderPunctuality constraint.

Type : float.

Default : not used.

number

email
optional

Example : "null"

string

evaluationInfos
optional

first order assignment (specifying resource, day and position in route).

Use it to compare optimization result with a previous optimization

Warning : used only if startFromEvaluationInfo is set to true in options.

json_TSEvaluationInfos

excludeResources
optional

The identities of the resources which must not deliver a customer.

Use this constraint when you want to prevent some customers from being delivered by specific resources.

< string > array

fixedVisitDuration
optional

The fixed part of the total time spent visiting a customer.

Use this constraint to specify the minimum time spent at a customer’s. Use it to store the time needed by a vehicle to park, for instance, or the time planned for a commercial meeting.

Type : Time ("hh:mm" or "hh:mm:ss") or Integer (number of minutes).

Default : not used.

Example :

* tsOrderFixedVisitDuration = "00:30:00" indicates that the visit will be 30 minutes long.

* tsOrderUnloadingDurationPerUnit = 120 indicates that 120 seconds are necessary to unload one unit. With a tsOrderQuantity equal to 8, for instance, the variable part is 120*8 (960 seconds or 16 minutes) to unload the customer ordered quantity.

* Total delivery time = 30 minutes + 16 minutes = 46 minutes accounted for the customer delivery.
Example : "null"

string

frequency
optional

The visit occurrence within a defined period.

Use this constraint to plan multiple visits at a customer during a period.

Type: string value describing the number of visits over a period. Default: not used.

Example :

Frequency = "3/5" means a customer must be visited 3 times within a 5-days long period. The solver engine will create and optimize routes respecting an optimal duration between consecutive visits. Thus, back to the example, the computed period is 5/3 rounded = 2. The best solution will respect, as far as possible, a 2-days long period between each visit (ex: day1, day3, day5 is a good solution).
Example : "null"

string

getNotifications
optional

boolean

id
optional

The unique identifier of the order
Example : "null"

string

label
optional

Example : "null"

string

minDuration
optional

The min duration of the visit that enables partition.

When the total duration of an order is very long, you may want to part it into multiple consecutive visits. First use this constraint to specify a duration threshold from which visit can be cut into multiple parts. Then use the tsOrderMinPartDuration to specify the min duration of one part.

Type : Time ("hh:mm" or "hh:mm:ss") or Integer (number of minutes).

Default : not used.
Example : "null"

string

minPartDuration
optional

The min duration of a part of a split visit.

When the total duration of an order is very long, you may want to part it into multiple consecutive visits. First use the tsOrderMinDuration to specify a duration threshold from which the visit can be cut into multiple parts. Then use this constraint to specify the min duration of one part. The visit is split into parts of the set duration, and eventually a bigger one.

Type : Time ("hh:mm" or "hh:mm:ss") or Integer (number of minutes).

Default : not used.
Example : "null"

string

phone
optional

Example : "null"

string

possibleVisitDaysList
optional

The possible visit days related to each visit time window.

Use this constraint to specify the possible visit days of a customer referring to a visit time window. It must be related to the tsResourceWorkDays constraint of the resources, as resources work days define the planning period. You can plan visits on a 64-days-long period max.

Type : array of string values containing visit days separated with commas (like "1, 2, 5" or "4, 20/05/2010") or intervals (like "1-10", "2=>5" or "22/05/2010=>03/06/2010"). For day intervals, prefer the "=>" separator. Be carrefull, if the separator of date is - then "1-5" corresponds to May the 1st of the current year. 1 is the first day of the planning period, the corresponding date, if any, is defined by the oldest date, for all resources, in the tsResourceWorkDays constraint. No date in the possible visit days description can precede the first day of the planning period defined by the resources (which is day 1). Default: 1=>64.

You can set up to 4 sets of visit days in this array. If you define several time windows, each time window will apply to corresponding set of possible days : first time window applies to first possible days set, second time window applies to second possible days set, etc.

Example :

* Set it to "1" (or "14/05/2010) when a customer must be visited on the first day of the planning period.

* Set it to "1, 2, 4, 5" (or "14/05/2010,15/05/2010,17/05/2010,18/05/2010") if the customer cannot be visited on the third day of a five days planning period.

* Set it to "1=>5" (or "14/05/2010=>18/05/2010") to define a 5-days long period during which the customer can be visited.

< string > array

punctuality
optional

The priority for a customer to be delivered on time.

Use this constraint to introduce different priority levels for the respect of visit time windows (when defined). Specify a value from 1 to 5 to set the priority: customers with a punctuality set to 5 will have less risk of delayed deliveries than a customer with a punctuality set to 1. You can specify more precisely punctuality requirements to enforce delay control by using the tsOrderDelayPenaltyPerHour constraint instead of the tsOrderPunctuality constraint.

Type : integer value from 1 to 5.

Default : 1.

number

quantities
optional

The requested product quantities for an order.

Use this constraint to specify the product quantities ordered by a customer, for instance. Up to 24 quantities can be used to order different products. Useless when planning commercial tours.

Type : float array (maximum of 3 significant digits after decimal separator).

Default : 0 Max : 2,147,483.

Example :

* Use this constraint to store the number of ordered packages, when working with packages.

* Use this constraint to store the number of ordered liters, when working with liquids.

* Use multiple dimensions when working with multiple products: when delivering fuels for instance, you will use as many dimensions as types of fuels

Warning : The quantity constraint of the Orders elements must be related to the corresponding capacity constraint of the Resources elements: thus, an order will not be planned whenever no resource with the related capacity has been defined.

< number > array

requiredSkills
optional

The list of the skills a customer requires to be visited.

Use this constraint when an order must be affected to a specific kind of resource: these resources will have to provide the required skills to be able to visit the customer.

Type : string array.

Default : none.

Example :

* Specify the word "Maintenance" as a required skill for a maintenance visit. Only the resources providing the "Maintenance" skill can perform the visit.

* Specify "Small vehicle" as a required skill for a customer living down town.

< string > array

resourceCompatibility
optional

Value for compatibility with resources.

If the order has a compatibility constraint value, a resource is compatible with the order if its compatibility value is either non-existent either larger or equal to the order’s one. See tsResourceOrderCompatibility.

Example :

* Set tsOrderResourceCompatibility to 254.18 and tsResourceOrderCompatibility to 260.12: order and resource are compatible

* Set tsOrderResourceCompatibility to 254.18 and tsResourceOrderCompatibility to 200: the order can not be affected to the resource

* Set tsOrderResourceCompatibility to 254.18 and tsResourceOrderCompatibility empty: order and resource are compatible

* Set tsOrderResourceCompatibility empty and tsResourceOrderCompatibility to 260.12: order and resource are compatible

Type : double

Default : -1

number

sequenceNumber
optional

number

timeWindows
optional

The visit time windows.

Use this constraint to specify a visit time window during which the order can be delivered. A visit time window is defined by its start time, its end time and possible visit days (see tsOrderTimeWindow1_EndTime, tsOrderPossibleVisitDays1). You can specify up to 4 visit time windows for a customer.

Type : array of time windows

Default : "00:00:00".

Example : A customer can only be delivered: *

* on Monday from 11:00:00 to 12:00:00 AM and from 04:00:00 to 05:00:00 PM,

* on Tuesday, Wednesday, Thursday from 08:00:00 to 09:00:00 AM and from 04:00:00 to 05:00:00 PM,

* on Friday from 08:00:00 to 09:00:00 AM.

Its visit time windows will be specified as follows:

* first time window StartTime = "08:00:00", EndTime = "09:00:00", first set of possible days = "2=>5",

* second time window StartTime = "11:00:00", EndTime = "12:00:00", second set of possible days = 1,

* third time window StartTime = "16:00:00", EndTime = "17:00:00", third set of possible days = "1=>4".

< json_TSTimeWindow > array

travelTimeModifier
optional

Indicates the value of the travel time modifier.

When reaching a location situated in a large city, one may want to take into account driving difficulties, such as narrow streets and congestion. The travel time modifier enables to increase the travel times around a location. It is describes by three values. The value by which multiply the travel times around the location (tsOrderTravelTimeModifierValue), the portion of the travel time on which the modifier applies (tsOrderTravelTimeModifierLength) an offset to add to any travel duration leaving or reaching the location (tsOrderTravelTimeModifierOffSet).

Example :

* Set tsOrderTravelTimeModifierValue to 1.5, tsOrderTravelTimeModifierLength to 300 and tsOrderTravelTimeModifierOffSet to 60 for Order 1

* Set tsOrderTravelTimeModifierValue to 2, tsOrderTravelTimeModifierLength to 420 and tsOrderTravelTimeModifierOffSet to 0 for Order 2 If the initial travel duration between Order 1 and Order 2 was 1000, one obtains a travel time 360 * 1.5 + 60 + 280 + 420 * 2 + 0 = 1660

Type : float

Default : 1

json_TSTravelTimeModifier

tsOrderBefore
optional

Example : "null"

string

tsOrderBeforeMaxTimeSpacing
optional

Example : "null"

string

tsOrderBeforeMinTimeSpacing
optional

Example : "null"

string

tsOrderFixed
optional

If true force the use of the specified day, resource and start time

boolean

tsOrderLastVisit
optional

The number of days before the beginning of the planning the last visit belonging to the order has been performed

Use this constraint in case of a frequency order to specify from how many days the last visit was performed before starting the current planning. The default value indicates this constraint is to be unused in the planning.

Type : negative integer

Default : 0 Max : -2,147,483.

Example :

If tsOrderLastVisit = -2, the last visit of the same order has been performed two days ago.

Warning : if the number of occurences of the frequency is more than one, the constraints tsOrderLastVisit and tsOrderMinimumSpacing are not considered.

number

tsOrderMaximumSpacing
optional

The maximum number of days required between two visits of a same order.

Use this constraint in case of frequency order to specify how many days at most should be left between two visits of the order.

Type : integer

Max : 2,147,483.

number

tsOrderMinimumSpacing
optional

The minimum number of days required between two visits of a same order.

Use this constraint in case of frequency order to specify how many days at least should be left between two visits of the order.

Type : integer

Default : 0 Max : 2,147,483.

Warning : if the number of occurences of the frequency is more than one, the constraints tsOrderLastVisit and tsOrderMinimumSpacing are not considered.

number

type
optional

The type of visit at a customer.

* 0 (Delivery): the resource will delivere related quantities.

* 1 (PickUp): the resource will pick-up related quantities.

* 2 (DeliveryFirst): the resource will not mix deliveries and pick-ups in a same rotation.

It is possible to mix pickups and 0 type deliveries in the same rotation. However, the delivered products will come from the depot and the pickup products will be unloaded at the depot. No product delivered to a customer can come from a pickup at another customer’s.

Type : Integer.

Default : 0 (Delivery).

number

unloadingDurationPerUnit
optional

The time needed to deliver one unit of product.

Use this constraint when the time spent at a customer depends on the quantity to deliver. It is the time needed to unload one unit of the quantity stored in the customer tsOrderQuantity constraint.

Type : Time ("hh:mm" or "hh:mm:ss") or Integer (number of minutes).

Default : not used.
Example : "null"

string

wholeVisitInTimeWindow
optional

Whole visit ends before time window end.

Use this constraint if you want that a visit ends before the end of the time window.

Default : false.

boolean

x
optional

longitude of order location

number

y
optional

latitude of order location

number

duration
optional

Duration

Type : Time ("hh:mm" or "hh:mm:ss") or Integer (number of minutes).
Example : "60"

string

end
optional

maximum end time

Type : Time ("hh:mm" or "hh:mm:ss")
Example : "14:00"

string

start
optional

minimum start time

Type : Time ("hh:mm" or "hh:mm:ss")
Example : "12:30"

string

dayId
optional

day of the stop
Example : "null"

string

resourceId
optional

Assigned resource identifier
Example : "null"

string

stopDriveDistance
optional

The drive distance from the previous to the current stop.

number

stopDriveTime
optional

The drive time from the previous to the current stop.

Type : Time ("hh:mm" or "hh:mm:ss")
Example : "null"

string

stopDuration
optional

The duration of the stop.

Type : Time ("hh:mm" or "hh:mm:ss")
Example : "null"

string

stopElapsedDistance
optional

The tour cumulated driven distance at the stop.

number

stopId
optional

the ID of the stop or order
Example : "null"

string

stopPosition
optional

The position of the stop in the resource tour.

number

stopStartTime
optional

The time the stop starts at.

Type : Time ("hh:mm" or "hh:mm:ss")
Example : "null"

string

stopStatus
optional

The status of the stop.

An order can be on time, late, waited, impossible (non compliant). It can also be a courier service delivery and not planned. See StopStatusConstants for more information about stop status.

Type : integer.

* 0 = OnTime: The stop begins into the specified visit time window.

* 1 = Late: The stop begins after the specified visit time window.

* 2 = Waited: The resource waits at the stop for the specified stop start time.

* 3 = Impossible: The stop cannot be planned.

* 4 = BadDay: The stop is planned without respect of frequency.

* NotPlanned: The courier service is in charge of a stop or the stop is not included in the planning process.

* BadPrevious : When the visits are split, the parts should follow one another. This status is that of a part following another visit instead of the previous part of the split visit.

number

stopType
optional

The stop type

A tour is composed of stops, which can be either customers visits or breaks, like reload breaks, lunch breaks, or even night breaks.

StopTypeConstants are

* 0 = Visit: The stop is an element of the Orders object.

* 1 = Start: The stop is the initial stage (departure) of the tour, occurring at the resource’s start location.

* 2 = End: The stop is the the last stage (arrival) of the tour, occurring at the resource’s stop location.

* 3 = EndBeforeOvernight: The stop is the the last stage (arrival) of the tour, occurring where the resource stopped for the night.

* 4 = ReloadBreak: The stop is a reload break within the tour, occurring at a depot location.

* 5 = LunchBreak: The stop is the lunch break within the tour, occurring anywhere between two other located stops.

* 6 = RestBreak: The stop is a rest break within the tour, occurring anywhere between two located stops.

* 7 = WaitBreak: The stop is a wait break within the tour, occurring before a visit.

* 8 = StartAfterOvernight: The stop is the last stage (arrival) of the tour, it occurs where the resource stopped for the night. tsStopDriveDistance

* 9 = Briefing: The stop is a briefing break within the tour, occurring right after the departure of the tour.

* 10 = DeBriefing: The stop is a wait break within the tour, occurring right before the arrival of the tour.

number

stopX
optional

The X coordinate of the stop.

number

stopY
optional

The Y coordinate of the stop.

number

additionalCostOperator
optional

Operator used to compute additional cost (see toursResult object)

Possible values are :

* SUM : tour additional cost will be the sum of additional costs of planned orders

* MAX : tour additional cost will be the maximum value of additional costs of planned orders

* MIN : tour additional cost will be the minimum value of additional costs of planned orders

* AVERAGE : tour additional cost will be the average of additional costs of planned orders

json_CostOperator

additionalCostOrderCustomDataName
optional

Name of TSOrder customData that will contain the TSOrder type used for additional cost computation (see toursResult object)
Example : "null"

string

additionalCosts
optional

List of additional cost (cost per order type)

< json_TSAdditionalCost > array

available
optional

Indicates whether a resource is included in the planning process or not.

This constraint enables you to easily modify your optimization problem configuration without having to add nor delete original data.

* Set it to True to include a resource element in the planning process.

* Set it to False to ignore it: it will not be used in the planning.

Type : Boolean. Default : not used.
Example : true

boolean

avgConsumption
optional

Average consumption of the resource. Use this constraint to specify the average consumption of the resource. This consumption must be defined in liters per 100 distance unit (km or miles)

Default : The consumption indicated in the VehicleProfile.Consumption property.
Example : 8.0

number

briefingDuration
optional

An additional duration applied before the tour starts. Use this constraint to specify an additional duration before the resource begins the tour. For instance, to brief drivers before they leave or to simulate an initial vehicle loading time (no depot).

Type : "hh:mm:ss", DateTime. Default : "00:00:00".
Example : "00:20:00"

string

capacities
optional

The total product capacity a resource can carry. Use this constraint to specify the amount of product a resource can deliver or pick-up. It must be linked with the customers related quantity constraint. 23 more dimensions can be used in order to specify various products. They must be linked with the customers related dimensions.

Type : float (maximum of 3 significant digits after decimal separator). Default: None. Max : 2,147,483.

Example :

* Use it to store the total number of packages a resource can deliver before reloading, when working with packages.

* Use it to store the total number of litres a resource can deliver before reloading, when working with liquids.

* Use multiple capacity dimensions when working with multiple products: when delivering fuels, you will use as many capacities as types of fuels.

< number > array

customDataMap
optional

Private custom data.

Use this feature when you need to keep attributes values of your own into the optimization context. For instance if you need the address of an element, store it there.

< string, string > map

dailyWorkTime
optional

The maximum resource work duration over a day. Use this constraint to specify the maximum daily work duration (unless overtime periods have been defined). If the dailyWorkTime constraint is not set to a value, default daily work time is computed from resource time window and lunch duration (workStartTime, workEndTime and lunchDuration).

Type : "hh:mm:ss", DateTime. Default : not used.
Example : "null"

string

debriefingDuration
optional

An additional duration applied at the end of the tour. Use this constraint to specify an additional duration after the resources stops at the end location. For instance, to debrief drivers after their tour or to account an ultimate vehicle unloading time, or a parking time.

Type : "hh:mm:ss", DateTime. Default : "00:00:00".
Example : "null"

string

driveRestAtCustomer
optional

Indicates whether or not time spent at customer during deliveries can be considered as rest break.

* Set it to True if a visit can be considered as a rest break, as soon as its duration is equal or higher than the legalMinRestDuration constraint.

* Set it to False if not.

Type : Boolean. Default : False.

boolean

driveRestAtDepot
optional

Indicates whether time spent at depot during a reload break can be considered as drive break or not.

Use this constraint to take into account drive time legislation in your planning results.

* Set it to True if load breaks can be considered as drive breaks, as soon as their duration is equal or higher than the legalMinRestDuration constraint.

* Set it to False if not.

Type : Boolean. Default : False.

boolean

endX
optional

longitude of resource arrival

Specify it only if arrival and start are not the same.

number

endY
optional

latitude of resource arrival

Specify it only if arrival and start are not the same.

number

extraTravelPenalties
optional

The costs for a resource of driving for one distance unit.

< json_TSTravelPenalty > array

fixedLoadingDuration
optional

The fixed duration of the resource load break. Use this constraint to specify how long takes a resource reload at depot. You can specify an additional duration according to the quantity to reload, using loadingDurationPerUnit.

Type : "hh:mm:ss", DateTime. Default : "00:00:00".

Example :

* fixedVisitDuration = "00:30:00" indicates that 30 minutes are needed to load the resource.

* loadingDurationPerUnit = 120 indicates that 120 sec are needed to load one unit. If the quantity to reload is 8, for instance, the variable part is 120*8. 16 minutes are required to load the resource.

* Total load time = 30 minutes + 16 minutes = 46 minutes accounted for this reload break.
Example : "null"

string

fixedUnloadingDuration
optional

The fixed time needed for the resource to deliver/pick-up at the customer’s place.

This fixed resource’s unloading duration is added to the resource’s unloading duration depending on the quantity to deliver/pick-up and to the order’s unloading duration depending on the quantity to deliver/pick-up. See also tsResource unloadingDurationPerUnit and tsOrder unloadingDurationPerUnit. Example :

* Set tsOrderQuantity to 3.

* Set tsOrder unloadingDurationPerUnit to 2 mn and tsResource fixedUnloadingDuration and tsResource unloadingPerUnit to 0 or empty: the variable part of the order is 6 mn

* Set tsOrder unloadingDurationPerUnit to 2 mn and tsResource fixedUnloadingDuration to 10 mn and tsResource unloadingPerUnit to 0 or empty: the variable part of the order is 10 mn

* Set tsOrder unloadingDurationPerUnit to 2 mn and tsResource fixedUnloadingDuration empty and tsResource unloadingPerUnit to 1 mn: the variable part of the order is 3 mn

Type : "hh:mm:ss", DateTime. Default : ""

Warning : the fixed/per unit unloading duration for resource is not compatible with the orders constraints: partition and whole visit in time window. Hence if one of the constraint at least tsResource fixedUnloadingDuration and tsResource unloadingDurationPerUnit is non null, partition and whole visit in time window are disabled.
Example : "null"

string

fuelCode
optional

Vehicles fuel type. Possible values are :

* diesel

* undefined

* unleaded
Example : "null"

string

fuelType
optional

The fuel type of the resource.

Use this constraint to specify the fuel type of the resource. Available fuel types are :

* 0: Unknown fuel type

* 1: No fuel type (pedestrian)

* 2: Diesel

* 3: Unleaded fuel

* 4: LPG

Type : Integer. Default : The fuel type indicated in the VehicleProfile.FuelType property.

number

globalCapacity
optional

Global capacity for a resource. This constraint unables to set a maximum capacity on a resource, whatever product is carried. If both global capacity and capacity per product are to be used, set True for the value of useAllCapacities.

Type : Float Default : None Max : 2,147,483.

Example : Set globalCapacity = 15 and useAllCapacities = False. The global capacity only is considered: the vehicle can carry 15 quantities of products, whatever product is to be carried.

number

id
optional

The unique identifier of the resource.

This id can not contain special characters like = or :
Example : "null"

string

legalDailyDriveDuration
optional

The legal daily duration a resource can drive before having a rest break.

Use this constraint to take into account drive time legislation in your planning results. Specify the rest duration in the legalDailyRestDuration: rest breaks occur as soon as the resource has driven the legal daily driving duration or has completed its daily work time.

Type : "hh:mm:ss", DateTime. Default : not used.

Example : legalDailyDriveDuration = "09:00:00", legalDailyRestDuration = "11:00:00". The resource can cumulate a 9-hours daily drive time before having to rest during 11 hours.
Example : "null"

string

legalDailyRestDuration
optional

The legal rest duration a resource must have after the daily max drive duration.

Use this constraint to take into account drive time legislation in your planning results. Rest breaks occur as soon as the resource has driven the legal max daily duration or has complete its daily work time. The use of both legalDailyDriveDuration and legalDailyRestDuration implies that the start and end time of tours are no longer defined by the workStartTime and workEndTime constraints, but may vary as long as the legalDailyRestDuration constraint is respected.

Type : "hh:mm:ss", DateTime. Default : not used.
Example : "null"

string

legalDriveRestDuration
optional

The resource break duration after max drive duration. Use this constraint to take into account drive time legislation in your planning results.

Type : "hh:mm:ss", DateTime. Default : not used.
Example : "null"

string

legalMaxDriveDuration
optional

The legal max duration a resource can drive without a break. Use this constraint to take into account drive time legislation in your planning results.

Type : "hh:mm:ss", DateTime. Default: : not used.

Example :

* legalMaxDriveDuration = "04:30:00", legalDriveRestDuration = "00:45:00". The resource can drive for 4 hours and 30 minutes before having a 45 minutes break. Then it can start driving again for 4 hours and 30 minutes???etc.

* If added driveRestAtCustomer = True and legalMinRestDuration = "00:15:00", rest time is cumulated as soon as customer visit duration is equal or higher than the specified min rest duration. If the 45 minutes rest break has not occured when the resource has driven for 4 hours and 30 minutes, it must stop to complete the break. Otherwise, it can drive again for 4 hours and 30 minutes.
Example : "00:30:00"

string

legalMinRestDuration
optional

The minimum duration a resource breaks for it to be considered as a drive break. Use this constraint to take into account drive time legislation in your planning results. When breaks occur at customer or at depot, they are considered as drive breaks if their duration is equal or higher than the specified min rest duration.

Type : "hh:mm:ss", DateTime. Default: : not used.
Example : "null"

string

loadBeforeDeparture
optional

Indicates whether a resource must load before starting a tour or not.

* Set this constraint to True to insert a load break at depot before the tour starts.

* Set it to False to consider the vehicle loaded.

Type : Boolean. Default: : False.

boolean

loadOnReturn
optional

Indicates whether a resource must reload after a tour or not.

* Set this constraint to True to insert a load break at depot after the tour ends.

* Set it to False to not reload the vehicle.

Type : Boolean. Default: : False.

boolean

loadingDurationPerUnit
optional

The time needed to load a unit of product. This constraint is added to the fixed part of the loading duration: it depends on the total quantity to load.

Type : "hh:mm:ss", DateTime, Integer (number of seconds). Default: : 0.
Example : "null"

string

lunch
optional

The lunch break

Default: : no lunch break

json_TSPause

maxNightsOutPerJourney
optional

The number of nights a resource can spend out to perform deliveries before coming back to base.

Use this constraint to enable night breaks trip: it will store how many days a resource can drive away from depot. Unless the vehicle needs to reload, it will not come back before.

Type : integer. Default: : not used.

Example: maxNightsOutPerJourney = 4, workDays = 1=>5. The resource can perform deliveries during 5 days (and 4 nights) without coming back to depot. Starting on day 1, it must come back to depot on day 5.

number

maximumDistance
optional

The maximum distance the resource should travel per day.

Use this constraint to specify the distance the resource should not exceed in one day

Type : integer Default : -1 (no limit)

number

maximumReloads
optional

Value for maximum number of reloads per day.

number

maximumReloadsPenalty
optional

Value of the penalty if the resource exceeds the maximum number of reloads per day.

If the resource exceeds the maximum number of reloads per day, it will be penalized by the maximum reloads penalty multiplied by the number of reloads' overtaking. The default value is 1024 if the constraint maximumReloads is set. See also maximumReloads.

number

maximumVisits
optional

The maximum number of visits the resource can perform in one day.

Type : integer Default : -1 (no limit) Max : 2,147,483.

number

minDriveDuration
optional

The minimum laps of time between 2 consecutive visits.

Use this constraint to specify a minimum drive time accounted when consecutive visits are very close, in order to compute a realistic timing.

Type : "hh:mm:ss", DateTime. Default: : not used.
Example : "null"

string

minimumQuantity
optional

Value for minimum quantity to deliver.

If the resource has a non null minimum quantity to deliver constraint value, the resource can visit on order only if the quantity to be picked-up or delivered at this order is higher than the constraint value.

*Example : *

* set order quantity to 3 and resource minimumQuantity to 2 : resource might visit the order

* set order quantity to 3 and resource minimumQuantity to 5 : resource can not visit the order

Type : float

number

mobileLogin
optional

Mobile login to be specified only if you need to be able to export the optimization result to operation planning from TsCloud GUI. If you trigger operational planning export from the API, you will still need to specify the mapping between resource name and login.
Example : "null"

string

nightPenalty
optional

The night cost of a resource when planning night breaks.

Use this constrainte to specify how much a night out costs (lunch, bed, breakfeast???) for a resource when night breaks are allowed.

Type : float. Default: : 0

number

noReload
optional

Constraint providing resource to reload at depot during a tour.

If none of the constraints loadBeforeDeparture and loadOnReturn is activated, the resource is never loading at depot. If one of these constraint is activated the resource is loading once per tour, either at the beginning of the tour or at the end of it. If both constraints are activated then the resource is loading twice a tour, at the beginning and at the end.

With standard solver only : solver always works with solution cost comparison, so it may allow reloads even if you set noReload to true if the solution cost is really lower. The only way to totally prevent reloads is to set fixedLoadingDuration to a very long duration (20:00:00 for instance). The solver will warn you about this long duration but will not add reloads to the tours. Caution : Don’t do this if you are using loadOnReturn or loadBeforeDeparture

Default : False

boolean

nonUsePenalty
optional

A cost paid for NOT using a resource in the computed planning.

Use this constraint to penalize the fact that an available resource is not used in the planning. It proves usefull when you must use all the resources in the Resources collection: you will prevent the solver from optimizing the number of resources, as using them would be too expensive a solution.

Type : float. Default: : not used.

Example : Use it to specify parking taxes when a vehicle performs no tour.

number

openDistanceStart
optional

boolean

openDistanceStop
optional

boolean

openStart
optional

Indicates whether or not a tour evaluation starts from the resource start location or from the first customer’s place.

* Set it to True to begin the tour at the first customer (no cost will be computed between the resource start location and the first customer).

* Set it to False to begin the tour at the resource start location.

Type : Boolean. Default: : False.

boolean

openStop
optional

Indicates whether or not a tour evaluation ends at the last customer’s place or at the resource end location.

* Set it to True to finish the tour at the last customer location (no cost will be computed between the last customer and the resource end location).

* Set it to False to finish the tour at the resource end location.

Type : Boolean. Default: : False.

boolean

openTimeStart
optional

boolean

openTimeStop
optional

boolean

optimumStartTime
optional

Adapts the resource start time to the best solution.

* Set this constraint to False to start the tour at the time indicated by the workStartTime constraint.

* Set this constraint to True to optimize the resource start time and enable the use of the dailyWorkTime constraint.

Notice that, in both cases, the tour will not start before the time stored in the workStartTime constraint and that the use of the weeklyWorkTime constraint is enabled.

Type : Boolean. Default: : False.

boolean

otherWorkEndTimes
optional

The end time of the resource work time window for the "other working days" (see otherWorkDaysList).

If you defined other working days, use this constraint to specify the time at which the tour must end. These times can be adjusted using the optimumStartTime parameter.

You can define up to 3 different end times here, corresponding to the different "other working days" slots.

Type : List of "hh:mm:ss", DateTime. Example : ["18:00:00","19:00:00]
Example : "null"

string

otherWorkStartTimes
optional

The start time of the resource work time window for the "other working days" (see otherWorkDaysList).

If you defined other working days, use this constraint to specify the time at which the tour must start. These times can be adjusted using the optimumStartTime parameter.

You can define up to 3 different start times here, corresponding to the different "other working days" slots.

Type : List of "hh:mm:ss", DateTime. Example : ["08:00:00","09:00:00]
Example : "null"

string

otherWorkingDays
optional

Other working days (see workingDays)

You can define up to 3 different working days slots. If you do so, you can then specify distinct work start and end times with otherWorkStartTimes and otherWorkEndTimes.

Type : List of string (see workingDays format) Example : ["2","3=>5"]

< string > array

overnightMinDriving
optional

The max duration a resource can drive to go back to base at the end of a tour when working with night breaks.

Use this constraint when a resource can end a tour at base instead of having a night break on the road.

Type : "hh:mm:ss". Default: : not used.
Example : "null"

string

overtimeDurations
optional

The duration of the resource overwork periods. (max 2 periods)

Use this constraint when you need to define 2 different overwork periods with regard to daily work time and their related surcharge. No overwork period can be defined with regard to weekly work time.

Type : "hh:mm:ss", DateTime. Default: : not used (no second overtime period).

Example :

workPenalty = 10, first overtime duration = "02:00:00", first overtime penalty = 5,second overtime duration = "01:00:00", second overtime penalty = 10.

The cost of the resource during the daily working time is 10 euros per hour. The resource can work during 3 more hours and each overworked hour will cost 10 + 5 euros for 2 hours and 10 + 10 euros for the last hour.

< object > array

overtimePenalties
optional

A surcharge for a resource’s overwork period (max 2 periods).

Use this constraint to specify additional cost to workPenalty as overwork time. You can define up to 2 overwork periods with regard to daily work time and their related surcharge. No overwork period can be defined with regard to weekly work time.

Type : float. Default: : not used.

Example :

workPenalty = 10, first overtime duration = "02:00:00", first overtime penalty = 5.

The cost of the resource during the daily working time is 10 euros per hour. The resource can work during 2 hours after the daily working time and each overworked hour will cost 15 (10 + 5) euros.

< number > array

payWholeDay
optional

Indicates whether or not a whole work day cost is computed as soon as a resource works even a few hours.

* Set this constraint to True to account a whole day cost.

* Set it to False to account only effective worked hours.

Type : Boolean. Default: : False.

boolean

penaltyPerVisit
optional

An additional fixed cost applied each time the resource performs a visit.

Use this constraint when the cost of a resource may vary according to the number of visits it performs.

Type : float. Default: : 0.

number

providedProducts
optional

The list of products provided by a resource.

This constraint is linked with tsDepot requiredProducts constraint: a depot with a required product can only be visited by a resource providing it.

Type : string as a list of products separated with commas. Default : not used.

Example : Specify "Oxygen" in the resource can provide oxygen.
Example : "null"

string

providedSkills
optional

The list of characteristics provided by a resource.

This constraint is linked with the same order constraint: a customer with a required skill can only be delivered by a resource providing it.

Type : string as a list of characteristics separated with commas. Default: : not used.

Example :

* Specify "Maintenance" in the provided skills of a resource designed to perform maintenance visits type.

* Specify "Small vehicle" to the provided skills of a resource able to perform downtown visits.
Example : "null"

string

speedAdjustment
optional

A factor to increase or decrease the vehicle speed.

Whenever users observe a significant gap between estimated speeds and the real ones, they can adjust them by using this factor. It is expressed as a percentage of the used speed.

Type : float. Default: : not used.

Example :

* speedAdjustment = 110: resource speeds will be 10% higher than the used speeds.

* speedAdjustment = 80: resource speeds will be 20% lower than the used speeds.

number

startTravelTimeModifier
optional

travel time modifier associated with the start location of the resource

json_TSTravelTimeModifier

startX
optional

longitude of resource start (and arrival if no endX provided)

number

startY
optional

latitude of resource start (and arrival if no endY provided)

number

stopTravelTimeModifier
optional

travel time modifier associated with the stop location of the resource

json_TSTravelTimeModifier

tomTomWebFleetEnabled
optional

boolean

tomTomWebFleetIdentifier
optional

Example : "null"

string

travelPenalty
optional

The cost for a resource of driving for one distance unit.

Use this constraint to specify the average resource taxes (gazoline, wear,???) when driving one distance unit.

Type : float Default : 1.5

Example : if travelPenalty = 0.5 (euro per distance unit) and the driven distance is about 100 unit (km or miles), the total distance cost is 0,5 * 100 = 50 euros.

number

travelTimeModifier
optional

travel time modifiers

When reaching a location situated in a large city, one may want to take into account driving difficulties, such as narrow streets and congestion. The travel time modifier enables to increase the travel times around a location. It is describes by three values. The value by which multiply the travel times around the location travelTimeModifierValue), the portion of the travel time on which the modifier applies (travelTimeModifierLength) an offset to add to any travel duration leaving or reaching the location (travelTimeModifierOffSet).

Example :

* Set travelTimeModifierValue to 1.5, travelTimeModifierLength to 300 and travelTimeModifierOffSet to 60 for Resource 1

* Set travelTimeModifierValue to 2, travelTimeModifierLength to 420 and travelTimeModifierOffSet to 0 for Order 1 If the initial travel duration between Resource 1 and Order 1 was 1000, one obtains a travel time 360 * 1.5 + 60 + 280 + 420 * 2 + 0 = 1660

json_TSTravelTimeModifier

unloadingDurationPerUnit
optional

the time needed to the resource to deliver/pick-up one unit of product at the customer’s place.

This resource’s duration is added to the fixed resource’s unloading duration and to the order’s unloading duration depending on quantity to deliver/pick-up. See also tsResource fixedUnloadingDuration and tsOrder unloadingDurationPerUnit.

Example :

* Set tsOrderQuantity to 3.

* Set tsOrder unloadingDurationPerUnit to 2 mn and tsResource fixedUnloadingDuration and tsResource unloadingPerUnit to 0 or empty: the variable part of the order is 6 mn

* Set tsOrder unloadingDurationPerUnit to 2 mn and tsResource fixedUnloadingDuration to 10 mn and tsResource unloadingPerUnit to 0 or empty: the variable part of the order is 10 mn

* Set tsOrder unloadingDurationPerUnit to 2 mn and tsResource fixedUnloadingDuration empty and tsResource unloadingPerUnit to 1 mn: the variable part of the order is 3 mn

Type : "hh:mm:ss", DateTime.
Example : "null"

string

useAllCapacities
optional

Determines if both global capacity and capacities per product should be considered in the optimization or only global capacity.

Type : Boolean Default : False

Example : Set globalCapacity = 15 and useAllCapacities = False. The global capacity only is considered: the vehicle can carry 15 quantities of products, whatever product is to be carried.

boolean

useInPlanningPenalty
optional

Penalty value if the resource is used in the planning.

Use this constraint to specify the penalty if the resource is used at least one day in the planning

Type : float Default : 0

number

usePenalty
optional

A cost paid for using the resource in the computed planning. Use this constraint to ponderate the cost of using a resource element of the Resources collection, when working with rented vehicle for instance. You can use it as well to reduce the number of resources used to perform the deliveries.

Type : float. Default: : not used.

Example :

Add the cost of use to the distance and hourly costs when working with a service provider. The solver, aiming at cost reduction, will try to eliminate this resource first, as it is the most expensive.

number

vehicleCode
optional

Vehicles regulations.

Possible values are :

* bicycle

* bus

* car

* deliveryIntermediateVehicle

* deliveryLightCommercialVehicle

* emergencyTruck

* emergencyVehicle

* intermediateVehicle

* lightCommercialVehicle

* pedestrian

* taxi

* truck

If not specified, vehicle type defined in UI will be used

Only new solver can handle optimization with several types of vehicle. If you use standard solver, you should specify the vehicle code only in the options object.
Example : "null"

string

weeklyWorkTime
optional

The maximum resource work duration over a week.

Use this constraint to specify the maximum weekly work duration. Weeks are defined as follows:

* year’s week, from monday to sunday, if a date has been specified in the workDays constraint

* days 1 to 7 are the days of the first week and the second week start on day 8 if no date has been specified in the workDays constraint. No over work with regard to the weekly work duration is allowed.

Type : "hh:mm:ss", DateTime. Default: : "168:00:00".
Example : "null"

string

workEndTime
optional

The end time of a resource work time window.

Use this constraint to specify the time at which the tour must be over or the daily work duration.

* If the optimumStartTime parameter is set to True and the dailyWorkTime or weeklyWorkTime constraint value is set by user, the tour cannot finish later than the value of the workEndTime parameter, whatever overtime may be allowed by the overtime1_Duration and overtime2_Duration constraints.

* If the optimumStartTime parameter is set to True and the dailyWorkTime constraint value is not set, the end time of the tour can be adjusted to match the begining of the work time window. In this case, this parameter is used only to compute the resource daily work time and the tour can finish at midnight.

* If the optimumStartTime parameter is set to False, then this parameter is used to compute the resource daily work time and the tour can finish no later than the specified end time plus the values of the first overtime duration and the second overtime duration constraints. If the daily work duration is specified by the workEndTime constraint’s value, then it is equal to workEndTime minus workStartTime and lunchDuration.

Example : For a vehicle to work for 6 hours between 7PM and 7AM, set

* optimumStartTime=True

* dailyWorkTime="06:00:00"

* workStartTime="07:00:00"

* workEndTime="19:00:00"

For a vehicle to work for 8 hour between 8PM and 5AM with a one-hour break at 12:30, set

* workStartTime="08:00:00"

* workEndTime="17:00:00"

* lunchDuration="01:00:00"

* lunchTime="12:30:00"

Type : "hh:mm:ss", DateTime. Default: : "24:00:00".
Example : "null"

string

workPenalty
optional

The cost of a resource working for an hour.

Use this constraint to specify the resource wages when working for an hour.

Type : float. Default: : 9.

Example :

If workPenalty = 10 (euros per hour) and daily work time is about 8 hours, the total daily work cost is 10 * 8 = 80 euros.

number

workStartTime
optional

The start time of the resource work time window.

Use this constraint to specify the time at which the tour must start. This time can be adjusted using the optimumStartTime parameter.

Type : "hh:mm:ss", DateTime. Default: : "00:00:00".
Example : "null"

string

workingDays
optional

The resource’s work days. Use this constraint to specify the days a resource works in the planning period. This constraint is linked with the orders possible visit days constraints of Orders object elements and with the depot days of opening constraints of Depots object elements. Thus, customers and resources must have matching days for deliveries to be possible, and depots must be opened on resources working days to be used. A maximum of 64 days can be defined as work days. Working days can be written as integers (1,2???) or dates (14/05/2010, 15/05/2010, ???). If you are using dates, the oldest date in the workDays constraint defines day 1.

Type : string values containing days separated with commas (like "1, 2, 5" or "14/05/2010, 15/05/2010, 18/05/2010" to specify day 1, day 2 and day 5) or intervals (like "1-10", "2=>5" or "14/05/2010=>24/05/2010") where 1 (or 14/05/2010) is the first day of the planning period. For day intervals, prefer the "=>" separator. Be careful, if the separator of date is - then "1-5" corresponds to May 1st of the current year. If you mix integer and date formats, beware that day 1 will all the same be defined by the oldest available date.

Default: : "1".

Example :

You can define a single working day: Specify "1", "3" or "10" for the resource to work on day 1, day 3 or day 10 of the planning period. You can also define working periods. Specify "1-5" or "1=>5" or "14/05/2010=>18/05/2010" for the resource to work on a 5-days period (from day 1 to day 5 included).

You can also mix single day and periods. Specify "1, 3=>5" for the resource to work on day 1 and from day 3 to 5 of the planning period.
Example : "null"

string

depotProperties
optional

< string > array

depots
optional

< json_TSDepot > array

nbCapacities
optional

number

nbExtraTravelPenalties
optional

number

nbQuantities
optional

number

nbTimeWindows
optional

number

options
optional

json_TSOptions

orderProperties
optional

< string > array

orders
optional

< json_TSOrder > array

resourceProperties
optional

< string > array

resources
optional

< json_TSResource > array

beginTime
optional

the minimum begin time

Type : Time ("hh:mm" or "hh:mm:ss")
Example : "08:00"

string

endTime
optional

the maximum end time

Type : Time ("hh:mm" or "hh:mm:ss")
Example : "18:00"

string

additionalCost
optional

Additional cost

Additional cost depends on additional cost configuration specified on resources and orders

number

dayId
optional

day of the tour
Example : "null"

string