GuidesAPI Reference
API Reference

Submit a Vehicle Routing Problem to solve it synchronously

Solve a vehicle routing problem synchronously by optimizing vehicle routes and schedules for jobs (deliveries or pickups) from a depot, including constraints like vehicle capacity, job demand, time windows, and required skills.

Body Params

Detailed information necessary to compute optimized routes, encompassing fleet configuration, including vehicle types, profiles, costs, shifts, and capacity, as well as a plan detailing the jobs to be completed.

configuration
object

Provides a way to define various additional settings and constraints for solving vehicle routing problems or permit the use of experimental features.

For more information, see Configuration.

fleet
object
required

Represents the collection of vehicles used for completing the planned tours. Each vehicle in the fleet can have specific attributes, such as:

  • Vehicle type (for example, truck, van, scooter)
  • Capacity (for example, volume, weight)
  • Operational costs
  • Time shifts (availability times)
  • Start and end locations
  • Special features (for example, refrigeration, hazmat compliance)
  • Routing profiles (for example, car, truck, bicycle)
plan
object
required

Set of jobs that need to be completed as part of a tour. This includes details such as job locations for pickups and deliveries, time windows for when these tasks should be performed, and any specific requirements or constraints related to completing each job according to specific business requirements.

objectives
array of objects
length between 1 and 6

Objectives that guide tour optimization by setting goals like minimizing distance, duration, costs, or unassigned jobs, and can be combined hierarchically to meet specific criteria.

objectives
advancedObjectives
array of objects
length between 1 and 8

ALPHA Extended objectives that allow for more complex and tailored optimization strategies beyond basic goals like minimizing tour distance or cost.

Note: This is an experimental feature under development. To enable this feature, add the advancedObjectives flag to the experimentalFeatures configuration in the problem.

advancedObjectives
Headers
string

User-provided token that can be used to trace a request or a group of requests sent to the service.

Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json