Overview

📘

Download OpenAPI specs:

The OnRoute API has 3 action endpoints:

  1. Solve: for optimizing RoutingRequests
  2. Evaluate: for evaluating RoutingRequests
  3. Suggest: for suggesting a single job by with RoutingRequests

And 3 endpoints for retrieving information:

  1. Status: Current state of the request: QUEUED, SOLVING, SOLVED, ERROR
  2. Solution: Solution response of the request
  3. Explanation: Explanation of the solution of the request

Actions

You can use the same request body RoutingRequest for every action.

Solve

POST /v2/vrp/solve

Evaluate

POST /v2/vrp/evaluate

Suggest

POST /v2/vrp/suggest

Info

Status

GET /v2/vrp/jobs/:job_id/status

Solution

GET /v2/vrp/jobs/:job_id/solution

Explanation

GET /v2/vrp/jobs/:job_id/explanation