v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Disposition|Tour

Optimize a tour.

This endpoint allows you to start a job to optimize a tour by providing an id. Upon successful request, a jobId is provided in the response. geoCapture jobs are tasks that may take some time to calculate, therefore they are executed in the background. You can to inquire about the status of the job through the Miscellaneous|Job endpoint. After optimizing the tour, the calculation is performed automatically.

During route optimization, the system considers travel times. Additionally, it incorporates team working hours and the duration of each order to determine the estimated arrival and departure times at each stop, as well as the distances to and between the stops.

For optimization purposes, it can be helpful to establish parameters for the sequence that a tour should be optimized between. For example, you may want to select a gas station to refuel your vehicle at the end of your tour. You can retrieve the sequence of stops for a tour by accessing the /tour/fetch_data endpoint.

get/tour/optimize

Query parameters

idinteger required

The internal id of the tour. This Parameter is required.

fromSequenceinteger

Optimize the tour from this stop sequence on.

toSequenceinteger

Optimize the tour until this stop sequence.

Response

Success Response:

jobIdinteger

The id of the optimization job. (The status of the job can be queried via the job API)