Start an optimization

post

https://api.geoconcept.com/tsapi/optimize

Use this method to plan tours. The process consists in assigning Orders
object elements to Resources object on a way that respects the
constraints and minimizes the cost of the computed planning. This method
is composed of 2 processes: a data checking and optimizing process.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Optimization request

beginDate

date-time

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

Format: YYYY-MM-DD

Default: day+1.

beginLocalDate

date

countryCode

string

Main country code used to route the optimization to the good optimization
server farm.

depots

array of objects

list of depots (for reloading or starting tours)

depots

language

string

Language to use for message localization

options

object

Options for optimization request

orders

array of objects

list of orders (visits to do)

orders

organization

string

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.

Organization is also used to determine time zone, if not organization is provided,
server will guess the time zone from first visit coordinates.

resources

array of objects

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

resources

simulationName

string

Simulation name

Optional : generated automatically if not provided

userLogin

string

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

defaultOptimizeResult with task id