Developers

Connect your software to your dispatch operation.

Turn incoming orders into delivery jobs, send status updates back to your system, and build an AI assistant that can read the work in RouteIQ Dispatch Software.

API documentation Explore the REST workflow See the MCP example

Two ways to connect

REST API

Build your own integration

Your server calls RouteIQ Dispatch Software directly. Create jobs from orders and receive delivery updates through webhooks.

Explore the REST workflow → MCP

Connect an AI assistant

The local connector lets an MCP client discover API operations and call them with your integration key.

See the MCP example →

REST API + webhooks

From an order to an assigned delivery.

An order comes in from your store or booking system. Your integration creates the work in RouteIQ Dispatch Software and keeps the original order updated.

Receive the order
Your system supplies the customer, service, pickup, and drop-off.
Create the job
Send the job to RouteIQ Dispatch Software and save the returned job ID.
Assign a driver
Choose an eligible driver and vehicle, then submit the assignment.
Keep status in sync
Receive job events through a webhook and update your order system.

Run the create-and-dispatch example Add delivery updates

MCP

Ask about a job. Get an answer from RouteIQ Dispatch Software.

Start with a question that reads existing work. The assistant uses the connector to retrieve the job, then explains the returned data.

Illustrative conversation · Sample data

You

Show me the pickup, drop-off, and assigned driver for job-demo.

Your assistant

Pickup: 18 Market Street. Drop-off: 42 Harbor Avenue. Assigned driver ID: driver-demo.

This example reads one job. It does not create or assign work.

What happens behind the answer

Discover
search_api finds the job-read operation.
Inspect and read
describe_api supplies its input schema; call_api sends the job ID to RouteIQ Dispatch Software.
Explain the result
The assistant summarizes the returned stops and driver ID. Your API key’s permissions still apply.

See the tool call and sample data

MCP tools/call parameters

{
  "name": "call_api",
  "arguments": {
    "operation": "GET /job/{id}",
    "path": {
      "id": "job-demo"
    }
  }
}

Selected API data fields · sample

{
  "id": "job-demo",
  "driver_user_id": "driver-demo",
  "stops": [
    {
      "order": 0,
      "type": "pickup",
      "address": {
        "street_address": "18 Market Street"
      }
    },
    {
      "order": 1,
      "type": "dropoff",
      "address": {
        "street_address": "42 Harbor Avenue"
      }
    }
  ]
}

Configure the local connector

An MCP client with local process support launches the connector on your machine or server. Supply your site URL and a dedicated integration key through the client’s secret settings. Replace the command with the installed binary’s absolute path.

Configuration shape · client support varies

{
  "mcpServers": {
    "routeiq": {
      "command": "/absolute/path/to/routeiq-mcp",
      "env": {
        "ROUTEIQ_API_URL": "https://YOUR-SITE.routeiq.app/api",
        "ROUTEIQ_API_KEY": "YOUR-INTEGRATION-KEY"
      }
    }
  }
}

For assignment workflows, configure any required confirmation in your client. The connector executes writes immediately and does not provide an approval screen.

Read the MCP and REST walkthrough

Build the workflow you need

Orders → dispatch

Create two stops, assign a driver, and read back the job.

Run the example →

Assistant → job details

Explore MCP setup and tool calls, or connect through REST.

Read the guide →

Delivery → order update

Verify webhook signatures and process status changes.

Read the guide →

Use the live API reference

Create an integration key in Settings → API keys and choose the role your workflow needs. Keep it on your server or in your MCP client’s secret settings. Find current schemas and authentication details in the backend reference.

Open API reference