Skip to content

Developer portal

Routing guide

Documented payload shape for delivery and field-service routing. Live solver path coming soon.

Pilot

When to use routing

Dispatch scenarios where stop order, vehicle capacity, and customer windows dominate the objective.

Request fields

FieldTypeRequiredDescription
stops[].idstringYes

Stop identifier.

e.g. hospital

stops[].serviceWindowstringNo

Time window the stop must respect.

e.g. 08:30-10:00

vehicles[].idstringNo

Fleet unit identifier.

constraints[]string[]No

Ordering and timing rules.

Example payload

{
  "type": "routing",
  "stops": [
    {
      "id": "depot",
      "serviceWindow": "08:00-08:15"
    },
    {
      "id": "hospital",
      "serviceWindow": "08:30-10:00"
    },
    {
      "id": "office-park",
      "serviceWindow": "09:00-11:00"
    },
    {
      "id": "retail-hub",
      "serviceWindow": "11:30-13:00"
    }
  ],
  "vehicles": [
    {
      "id": "van-03",
      "capacity": 12
    }
  ],
  "constraints": [
    "hospital before office-park",
    "retail-hub after 11:30"
  ]
}