Skip to main content

RoutePlanResponse

start_atstring<date-time>
routes object[]

One route per vehicle that has stops, ordered by vehicle id.

  • Array [
  • vehicle_idstring
    Example: van-1
    tripinteger

    Which trip this is (1, 2, …). Only for vehicles with max_trips above 1, which get one route per trip.

    modestring
    steps object[]
  • Array [
  • typestring

    Possible values: [start, job, pickup, delivery, break, end]

    idstring

    The job or shipment id, for job, pickup and delivery steps.

    location object
    latnumber<double>
    lngnumber<double>
    arrivalstring<date-time>
    service_sinteger
    waiting_sinteger
    loadinteger[]

    Load on board after this step.

    distance_minteger

    Distance travelled since the route start.

  • ]
  • distance_minteger
    duration_sinteger

    Travel time.

    service_sinteger
    waiting_sinteger

    Time spent waiting for time windows to open.

    start_timestring<date-time>
    end_timestring<date-time>
  • ]
  • unassigned object[]
  • Array [
  • idstring
    Example: order-1002
    typestring

    Possible values: [job, shipment]

    reasonstring
    Example: no vehicle has all the required skills
  • ]
  • summary object
    vehicles_usedinteger
    assignedinteger
    unassignedinteger
    distance_minteger
    duration_sinteger

    Total travel time across all routes.

    traffic_notestring
    Example: morning rush
    noticestring
    RoutePlanResponse
    {
    "start_at": "2024-07-29T15:51:28.071Z",
    "routes": [
    {
    "vehicle_id": "van-1",
    "trip": 0,
    "mode": "string",
    "steps": [
    {
    "type": "start",
    "id": "string",
    "location": {
    "lat": 0,
    "lng": 0
    },
    "arrival": "2024-07-29T15:51:28.071Z",
    "service_s": 0,
    "waiting_s": 0,
    "load": [
    0
    ],
    "distance_m": 0
    }
    ],
    "distance_m": 0,
    "duration_s": 0,
    "service_s": 0,
    "waiting_s": 0,
    "start_time": "2024-07-29T15:51:28.071Z",
    "end_time": "2024-07-29T15:51:28.071Z"
    }
    ],
    "unassigned": [
    {
    "id": "order-1002",
    "type": "job",
    "reason": "no vehicle has all the required skills"
    }
    ],
    "summary": {
    "vehicles_used": 0,
    "assigned": 0,
    "unassigned": 0,
    "distance_m": 0,
    "duration_s": 0,
    "traffic_note": "morning rush"
    },
    "notice": "string"
    }