Request

This VRP request schema is used for solving a Vehicle Routing Problem. It consists of resources, jobs, relations, options and weights.

Name	Type	Required	Description
`resources`	[Resource]	true	List of Resources
`jobs`	[Job]	true	List of Jobs
`options`	Options	false	Options for solver configuration
`relations`	JobRelation	false	Job relations
`weights`	Weights	false	Weighting the constraints
`hook`	string(uri)	false	Webhook for getting notified after request is solved.

OnRoute Request for solving, evaluating

resources

object[]

required

List of available resources (vehicles, drivers, workers) that can be assigned to perform jobs. Each resource defines their working schedules, location constraints, capacity limits, and capabilities. At least one resource is required, with a maximum of 2000 resources per request.

Required array length: 1 - 2000 elements

Show child attributes

jobs

object[]

required

List of jobs/tasks to be assigned to resources. Each job specifies service requirements, location, time constraints, duration, and resource preferences. Jobs represent the work that needs to be scheduled and optimized. At least one job is required, with a maximum of 10,000 jobs per request.

Required array length: 1 - 10000 elements

Show child attributes

options

object

Options to tweak the routing engine

Show child attributes

Example:

{
  "euclidian": false,
  "routingEngine": "OSM",
  "partialPlanning": true,
  "minimizeResources": true,
  "traffic": 1.1,
  "polylines": true,
  "fairWorkloadPerTrip": false,
  "fairWorkloadPerResource": false,
  "workloadSensitivity": 0.1,
  "snapUnit": 300,
  "maxSuggestions": 3,
  "onlyFeasibleSuggestions": true,
  "explanation": {
    "enabled": true,
    "filterHardConstraints": true
  }
}

weights

object

OnRoute Weights

Show child attributes

Example:

{
  "priorityWeight": 100,
  "workloadSpreadWeight": 10,
  "travelTimeWeight": 1,
  "plannedWeight": 1000,
  "asapWeight": 5,
  "minimizeResourcesWeight": 3600,
  "allowedResourcesWeight": 500,
  "waitTimeWeight": 1,
  "urgencyWeight": 50,
  "driveTimeWeight": 1,
  "clusteringWeight": 1
}

hook

string<uri> | null

Optional webhook URL that will receive a POST request with the job ID when the optimization is complete. This enables asynchronous processing where you can submit a request and be notified when results are ready, rather than waiting for the synchronous response.

customDistanceMatrices

object

Custom distance matrix configuration for multi-profile and multi-slice scenarios

Show child attributes

Example:

{
  "profileMatrices": {
    "CAR": {
      "6": "matrix-car-morning-123",
      "9": "matrix-car-midday-456",
      "16": "matrix-car-evening-789"
    },
    "TRUCK": {
      "6": "matrix-truck-morning-abc",
      "9": "matrix-truck-midday-def"
    }
  },
  "matrixServiceUrl": "https://custom-matrix-service.com/api"
}

label

string | null

relations

object[] | null

Show child attributes

Solution

⌘I

{
  "resources": [
    {
      "name": "<string>",
      "shifts": [
        {
          "from": "<string>",
          "to": "<string>",
          "start": {
            "latitude": 123,
            "longitude": 123,
            "h3Index": 617700169958293500
          },
          "end": {
            "latitude": 123,
            "longitude": 123,
            "h3Index": 617700169958293500
          },
          "ignoreTravelTimeToFirstJob": true,
          "ignoreTravelTimeFromLastJob": true,
          "overtime": "<unknown>",
          "overtimeEnd": "2022-03-10T12:15:50-04:00",
          "breaks": [
            {
              "type": "WINDOWED"
            }
          ],
          "tags": [
            "<string>"
          ],
          "jobTypeLimitations": {
            "Initial Appointment": 2,
            "Wound Care": 1
          }
        }
      ],
      "start": {
        "latitude": 123,
        "longitude": 123,
        "h3Index": 617700169958293500
      },
      "end": {
        "latitude": 123,
        "longitude": 123,
        "h3Index": 617700169958293500
      },
      "maxDriveTimeInSeconds": "<unknown>",
      "maxDriveDistance": 123,
      "region": {
        "latitude": 123,
        "longitude": 123,
        "h3Index": 617700169958293500
      },
      "tags": [
        "<string>"
      ],
      "category": "CAR",
      "rules": [
        {
          "period": {
            "from": "2024-01-01T08:00:00Z",
            "to": "2024-01-07T17:00:00Z"
          },
          "minWorkTime": 123,
          "maxWorkTime": 123,
          "minServiceTime": 123,
          "maxServiceTime": 123,
          "minDriveTime": 123,
          "maxDriveTime": 123,
          "minJobComplexity": 123,
          "maxJobComplexity": 123,
          "jobTypeLimitations": {
            "Initial Appointment": 10,
            "Wound Care": 5
          }
        }
      ],
      "capacity": [
        500,
        200
      ],
      "hourlyCost": 60,
      "compatibleResources": [
        "driver2",
        "driver3"
      ],
      "maxDriveTime": 123,
      "maxDriveTimeJob": 123
    }
  ],
  "jobs": [
    {
      "name": "<string>",
      "duration": 5,
      "location": {
        "latitude": 123,
        "longitude": 123,
        "h3Index": 617700169958293500
      },
      "priority": 100,
      "urgency": 100,
      "tags": [
        {
          "name": "<string>",
          "hard": false,
          "weight": 300
        }
      ],
      "rankings": [
        {
          "name": "<string>",
          "ranking": 5
        }
      ],
      "windows": [
        {
          "from": "<string>",
          "to": "<string>",
          "weight": 1,
          "hard": true
        }
      ],
      "durationSquash": 30,
      "plannedDate": "2022-03-10",
      "plannedResource": "<string>",
      "plannedArrival": "2023-01-13T09:00:00Z",
      "hard": true,
      "hardWeight": 1,
      "padding": 300,
      "load": [
        5,
        10
      ],
      "allowedResources": [
        "<string>"
      ],
      "initialResource": "<string>",
      "initialArrival": "2023-01-13T09:00",
      "disallowedResources": [
        "<string>"
      ],
      "complexity": 1,
      "resumable": true,
      "jobTypes": [
        "Initial Appointment",
        "Wound Care"
      ]
    }
  ],
  "options": {
    "euclidian": false,
    "routingEngine": "OSM",
    "partialPlanning": true,
    "minimizeResources": true,
    "traffic": 1.1,
    "polylines": true,
    "fairWorkloadPerTrip": false,
    "fairWorkloadPerResource": false,
    "workloadSensitivity": 0.1,
    "snapUnit": 300,
    "maxSuggestions": 3,
    "onlyFeasibleSuggestions": true,
    "explanation": {
      "enabled": true,
      "filterHardConstraints": true
    }
  },
  "weights": {
    "priorityWeight": 100,
    "workloadSpreadWeight": 10,
    "travelTimeWeight": 1,
    "plannedWeight": 1000,
    "asapWeight": 5,
    "minimizeResourcesWeight": 3600,
    "allowedResourcesWeight": 500,
    "waitTimeWeight": 1,
    "urgencyWeight": 50,
    "driveTimeWeight": 1,
    "clusteringWeight": 1
  },
  "hook": "<string>",
  "customDistanceMatrices": {
    "profileMatrices": {
      "CAR": {
        "6": "matrix-car-morning-123",
        "9": "matrix-car-midday-456",
        "16": "matrix-car-evening-789"
      },
      "TRUCK": {
        "6": "matrix-truck-morning-abc",
        "9": "matrix-truck-midday-def"
      }
    },
    "matrixServiceUrl": "https://custom-matrix-service.com/api"
  },
  "label": "<string>",
  "relations": [
    {
      "type": "SAME_TRIP",
      "jobs": [
        "<string>"
      ],
      "timeInterval": "FROM_ARRIVAL",
      "resource": "vehicle-1",
      "minTimeInterval": 0,
      "maxTimeInterval": 3600,
      "partialPlanning": true,
      "maxWaitingTime": 1200,
      "tags": [
        "urgent",
        "morning"
      ],
      "enforceCompatibility": true,
      "hardMinWait": true,
      "weight": 1
    }
  ]
}

Platform

VRP API

Fill API