Routes API

Phase 2

This documentation is a preview. The API is currently in development.

Endpoints

List routes

GET /v1/routes

Query parameters:

Parameter	Type	Description
date	string	Filter by route date
status	string	not_started, in_progress, completed
driver_id	string	Filter by assigned driver
page	integer	Page number

Get route

GET /v1/routes/{route_id}

Create route

POST /v1/routes

Request body:

{
  "date": "2026-03-14",
  "driver_id": "d-001",
  "vehicle_id": "v-003",
  "order_ids": ["se-12345", "se-12346", "se-12347"],
  "optimize": true
}

Setting optimize: true reorders the stops for shortest travel distance.

Update route

PATCH /v1/routes/{route_id}

Add or remove stops, reassign driver, or reorder stops.

Delete route

DELETE /v1/routes/{route_id}

Unassigns all orders from the route. Orders return to the unassigned pool.

Route object

{
  "id": "r-001",
  "date": "2026-03-14",
  "status": "in_progress",
  "driver": {
    "id": "d-001",
    "name": "John Driver"
  },
  "vehicle": {
    "id": "v-003",
    "name": "Van #3"
  },
  "stops": [
    {
      "order_id": "se-12345",
      "sequence": 1,
      "status": "delivered",
      "address": "123 Main St",
      "eta": "2026-03-14T10:30:00Z"
    }
  ],
  "estimated_distance_km": 24.5,
  "estimated_duration_min": 85
}