API docs by Redocly

Multi-Stop API (v1)

Download OpenAPI specification:Download

AHOY AMS Team: ams@theahoyapp.com URL: https://docs.ahoy.technology/

Plan Multi Stop Route

Request Body schema: application/json

request with the points and vehicles definition to plan routes for

Array of objects

the list of points (locations) the trips needs to be generated for

Array of objects

list of vehicles that will be servicing and traveling to the points

object

start location for the trips

object

end location for the trips (optional)

startDateTime
integer <int64>

start time for the trips

optimization
string
Enum: "time" "distance" "cost"

optimization mode for the trips

adjustStartDateTime
boolean

optimize the start time of the trip

avoidToll
boolean

avoid toll gates (optional)

Responses

Request samples

Content type
application/json
{
  • "points": [
    ],
  • "vehicles": [
    ],
  • "startLocation": {
    },
  • "endLocation": {
    },
  • "startDateTime": 1652731200000,
  • "optimization": "time",
  • "adjustStartDateTime": true,
  • "avoidToll": true
}

Response samples

Content type
application/json
{
  • "planId": "21296b17-9700-489e-b6fb-91c13d04712b",
  • "datetime": 1654188679204,
  • "trips": [
    ],
  • "unservedNodes": [
    ]
}