API Reference

Routes API

Optimize and manage service routes

The Routes API provides route optimization capabilities using Google Maps Distance Matrix. Create optimal routes for your technicians to minimize travel time and fuel costs.

Endpoints

List Routes

GET
/api/routes

Retrieve all route plans for a date

Get Route

GET
/api/routes/:id

Retrieve a specific route plan

Optimize Route

POST
/api/routes/optimize

Calculate optimal job sequence

Update Route

PATCH
/api/routes/:id

Manually update route sequence

Get ETA

GET
/api/routes/:id/eta

Get live ETA with traffic data

Route Optimization

The optimization algorithm considers multiple factors

Total distance between jobs
Real-time traffic conditions
Time slot constraints
Technician skill requirements

Optimization Response

The optimization endpoint returns detailed route data

sequenceOptimized job order
totalDistanceKmTotal route distance in km
totalTravelMinutesTotal travel time in minutes
arrivalTimesEstimated arrival at each job
departureTimesEstimated departure from each job

Best Practices

  • Optimize routes after all jobs are assigned
  • Re-optimize when adding or removing jobs
  • Use live ETA for customer notifications
  • Consider traffic patterns for departure times

More API Documentation

Authentication API

Secure API access

Jobs API

Create and manage jobs

Optimize Routes

Use the Routes API for efficient tour planning