Developer API

Build with RouteMate

Connect your platform via our REST API. Import stops from your e-commerce store, trigger route optimization, and track deliveries programmatically.

Authentication

Client Credentials Flow

The RouteMate API uses a client credentials OAuth2 flow. Exchange your client ID and secret for a short-lived bearer token, then include it in the Authorization header of subsequent requests.

1. Get Credentials

Generate your client ID and secret from the RouteMate dashboard Settings page.

2. Exchange for Token

POST to /integration-token to receive a bearer token valid for 1 hour.

3. Make Requests

Include the token in the Authorization header of all API calls.

Endpoints

API Reference

Core endpoints for integrating your delivery workflow with RouteMate.

POST/integration-token

Get Access Token

Exchange your client credentials for a short-lived access token. Tokens are valid for 1 hour.

Request Body

{
  "client_id": "your-client-id",
  "client_secret": "your-client-secret"
}

Response

{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_type": "bearer",
  "expires_in": 3600
}

POST/integration-import

Import Stops

Import a batch of stops into a route. Addresses are geocoded and validated automatically. Returns a job ID for tracking progress.

Request Body

{
  "route_id": "route_abc123",
  "stops": [
    {
      "address": "350 5th Ave, New York NY 10118",
      "name": "John Smith",
      "phone": "+12125551234",
      "notes": "Leave at front door"
    }
  ]
}

Response

{
  "job_id": "job_xyz789",
  "status": "processing",
  "stops_count": 1
}

GET/integration-jobs/:id

Get Job Status

Check the status of an import job. Returns the current status, progress, and any errors encountered during processing.

Response

{
  "job_id": "job_xyz789",
  "status": "completed",
  "stops_imported": 1,
  "stops_failed": 0,
  "errors": []
}

Examples

Quick Start Code

Copy and paste these examples to get started in minutes.

# Get an access token
curl -X POST https://api.routemate.app/integration-token \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "your-client-id",
    "client_secret": "your-client-secret"
  }'

# Import stops
curl -X POST https://api.routemate.app/integration-import \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "route_id": "route_abc123",
    "stops": [
      {
        "address": "350 5th Ave, New York NY 10118",
        "name": "John Smith"
      }
    ]
  }'

Limits

Rate Limits

API rate limits are applied per organisation and reset on a rolling 1-minute window.

Plan	Requests/min	Requests/month
Free	10	1,000
Solo AI / Pro Driver	30	10,000
Team	120	50,000
Enterprise	Custom	Custom

Request API Access

Get your API credentials and start building integrations with RouteMate today.