API Reference
API Reference

This endpoint allows you to submit an optimization request that contains a set of orders and routes. We will acknowledge the request and return an actionUuid as part of the response that can be used to fetch the solution once it is ready.

This is an asynchronous endpoint, similar to /vrp-long or /pdp-long endpoints from previous versions of our API.

📘

Vehicle Routing Problems only

This version of our API currently does not support pickup-delivery type problems, or problems that have a precedence constraint between orders. If you need to solve for pickup-delivery type problems, then please check out our v1 docs that outlines how these problems can be solved via pdp-long endpoint.

This is the basic schematic of what the request payload looks like:

{
  "routeScenario": {
    "stops": [
      {...},
      {...}
    ],
    "routes": [
      {...},
      {...}
    ],
    "options": {...}
  }
}

routeScenario is the main object that describes the job to done by Routific. As part of the routeScenario object, you can provide an array of stops that need to scheduled onto routes, along with any optimization preferences that you would like us to take into consideration while searching for a solution.

Learn more about the anatomy of the stops, routes , and options objects, so that you can construct the request in a way that meets your business needs.

Language
Credentials
Header
Click Try It! to start a request and see the response here!