# Optimoroute

```json
{
  "name": "Optimoroute",
  "slug": "optimoroute",
  "url": "https://composio.dev/toolkits/optimoroute",
  "markdown_url": "https://composio.dev/toolkits/optimoroute.md",
  "logo_url": "https://logos.composio.dev/api/optimoroute",
  "categories": [
    "productivity & project management"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:21:00.158Z"
}
```

![Optimoroute logo](https://logos.composio.dev/api/optimoroute)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Optimoroute MCP or direct API to optimize delivery routes, schedule jobs, assign drivers, and track order statuses through natural language.

## Summary

OptimoRoute is an online route optimization and planning solution for logistics, delivery, and field service companies. It helps businesses save time and resources by optimizing routes, schedules, and workloads for drivers.

## Categories

- productivity & project management

## Toolkit Details

- Tools: 17

## Images

- Logo: https://logos.composio.dev/api/optimoroute

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for OptimoRoute.
  - Setup:
    - Configure Api Key credentials for OptimoRoute.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- List all active drivers on duty today
- Show planned delivery routes for tomorrow
- Find unassigned orders for this week
- Get contact details for available drivers

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `OPTIMOROUTE_CREATE_ORDER` | Create Order | Tool to create a new order or update an existing order in OptimoRoute. Use when you need to add delivery, pickup, or task orders to the system with location, time windows, and other constraints. |
| `OPTIMOROUTE_CREATE_OR_UPDATE_ORDERS` | Create or Update Orders | Tool to bulk create, update, or replace multiple orders at once without geocoding. Use when you need to add new orders or modify existing ones efficiently. Supports up to 500 orders per request. |
| `OPTIMOROUTE_DELETE_ALL_ORDERS` | Delete All Orders | Tool to remove all orders and planned routes for a specified date. Use when you need to clear orders for a specific date or delete all orders system-wide if no date is provided. |
| `OPTIMOROUTE_DELETE_ORDER` | Delete Order | Tool to remove a single order from the OptimoRoute system. Use when you need to delete a specific order by its orderNo. |
| `OPTIMOROUTE_DELETE_ORDERS` | Delete Orders | Tool to delete one or more orders from the system in bulk (max 500 per request). Use when you need to remove orders, either individually or in batch operations. |
| `OPTIMOROUTE_GET_COMPLETION_DETAILS` | Get Order Completion Details | Tool to retrieve completion details for one or more orders including proof of delivery data. Use when you need to check order completion status, timing details, and form data. |
| `OPTIMOROUTE_GET_DRIVERS` | Get Drivers | Tool to retrieve all drivers in the system. Use when you need up-to-date driver data including status and contact information. |
| `OPTIMOROUTE_GET_EVENTS` | Get Mobile Events | Tool to retrieve mobile events from drivers' field operations. Use when you need to track order completions, status changes (success, failed, on_duty, off_duty), and other field events for the currently active plan. |
| `OPTIMOROUTE_GET_ORDERS` | Get Orders | Tool to retrieve one or more orders from OptimoRoute. Use when you need detailed order information including location, time windows, and assignment details. |
| `OPTIMOROUTE_GET_PLANNING_STATUS` | Get Planning Status | Tool to retrieve the status of an active planning/optimization process. Use when you need to check the progress of a planning job by providing its ID. |
| `OPTIMOROUTE_GET_ROUTES` | Get Planned Routes | Tool to retrieve all planned routes for a given date. Use when you need a detailed view of routes including optional stops, route parameters, and unassigned orders. |
| `OPTIMOROUTE_GET_SCHEDULING_INFO` | Get Order Scheduling Info | Tool to retrieve scheduling information for a specific order. Use when you need to check if an order is scheduled and get details like driver assignment, timing, and position. |
| `OPTIMOROUTE_SEARCH_ORDERS` | Search Orders | Tool to search for orders in OptimoRoute based on criteria. Use when you need to find orders by date range, order identifiers, or order status. At least one of 'orders' or 'date_range' must be provided. |
| `OPTIMOROUTE_START_PLANNING` | Start Planning | Tool to start the planning/optimization process for a specified date or date range. Use when you need to generate optimized routes for orders and drivers. Requires orders to be created before planning can begin. |
| `OPTIMOROUTE_STOP_PLANNING` | Stop Planning | Tool to stop an active planning/optimization process. Use when you need to halt a running planning job by providing its ID. |
| `OPTIMOROUTE_UPDATE_DRIVER_PARAMETERS` | Update Driver Parameters | Tool to update driver parameters for a specific date including work times, vehicle assignment, and start/end locations. Use when you need to modify driver availability or routing constraints. Note that this unschedules existing routes for the driver on the specified date. |
| `OPTIMOROUTE_UPDATE_DRIVERS_PARAMETERS` | Update Drivers Parameters | Tool to update parameters of multiple drivers for specified dates in bulk (max 500 per request). Use when you need to modify driver configuration including work hours, vehicle assignments, and location settings. Note: Existing routes for the specified drivers and dates will be unscheduled. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Optimoroute Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Optimoroute actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'List all drivers available for delivery today'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'List all drivers available for delivery today'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Optimoroute tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Get all drivers with their contact info')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Get all drivers with their contact info' }],
  stopWhen: stepCountIs(5)
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Optimoroute Integration

- Supports both Optimoroute MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Optimoroute data

### 2. Managed Auth

- Built-in API key handling with secure credential storage
- Central place to manage, scope, and revoke Optimoroute access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Optimoroute
- Scoped, least privilege access to Optimoroute resources
- Full audit trail of agent actions to support review and compliance

## Use Optimoroute with any AI Agent Framework

Choose a framework you want to connect Optimoroute with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/optimoroute/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/optimoroute/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/optimoroute/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/optimoroute/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/optimoroute/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/optimoroute/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/optimoroute/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/optimoroute/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/optimoroute/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/optimoroute/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/optimoroute/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/optimoroute/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/optimoroute/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/optimoroute/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/optimoroute/framework/autogen)

## Related Toolkits

- [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly.
- [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place.
- [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations.
- [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals.
- [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem.
- [Linear](https://composio.dev/toolkits/linear) - Linear is a modern issue tracking and project planning tool for fast-moving teams. It helps streamline workflows, organize projects, and boost productivity.
- [Jira](https://composio.dev/toolkits/jira) - Jira is Atlassian’s platform for bug tracking, issue tracking, and agile project management. It helps teams organize work, prioritize tasks, and deliver projects efficiently.
- [Clickup](https://composio.dev/toolkits/clickup) - ClickUp is an all-in-one productivity platform for managing tasks, docs, goals, and team collaboration. It streamlines project workflows so teams can work smarter and stay organized in one place.
- [Monday](https://composio.dev/toolkits/monday) - Monday.com is a customizable work management platform for project planning and collaboration. It helps teams organize tasks, automate workflows, and track progress in real time.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [Agiled](https://composio.dev/toolkits/agiled) - Agiled is an all-in-one business management platform for CRM, projects, and finance. It helps you streamline workflows, consolidate client data, and manage business processes in one place.
- [Ascora](https://composio.dev/toolkits/ascora) - Ascora is a cloud-based field service management platform for service businesses. It streamlines scheduling, invoicing, and customer operations in one place.
- [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place.
- [Beeminder](https://composio.dev/toolkits/beeminder) - Beeminder is an online goal-tracking platform that uses monetary pledges to keep you motivated. Stay accountable and hit your targets with real financial incentives.
- [Boxhero](https://composio.dev/toolkits/boxhero) - Boxhero is a cloud-based inventory management platform for SMBs, offering real-time updates, barcode scanning, and team collaboration. It helps businesses streamline stock tracking and analytics for smarter inventory decisions.
- [Breathe HR](https://composio.dev/toolkits/breathehr) - Breathe HR is cloud-based HR software for SMEs to manage employee data, absences, and performance. It simplifies HR admin, making it easy to keep employee records accurate and up to date.
- [Breeze](https://composio.dev/toolkits/breeze) - Breeze is a project management platform designed to help teams plan, track, and collaborate on projects. It streamlines workflows and keeps everyone on the same page.
- [Bugherd](https://composio.dev/toolkits/bugherd) - Bugherd is a visual feedback and bug tracking tool for websites. It helps teams and clients report website issues directly on live sites for faster fixes.
- [Canny](https://composio.dev/toolkits/canny) - Canny is a platform for managing customer feedback and feature requests. It helps teams prioritize product decisions based on real user insights.
- [Chmeetings](https://composio.dev/toolkits/chmeetings) - Chmeetings is a church management platform for events, members, donations, and volunteers. It streamlines church operations and improves community engagement.

## Frequently Asked Questions

### Do I need my own developer credentials to use Optimoroute with Composio?

Yes, Optimoroute requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)
