# OptimoRoute — Pipedream Connect

> OptimoRoute plans and optimizes routes and schedules for delivery and field service businesses.

- API slug: `optimoroute` (use in MCP headers and tool keys)
- Auth: API key (Pipedream-managed)
- Categories: Business Management
- Website: https://optimoroute.com/
- This page (HTML): https://pipedream.com/apps/optimoroute
- Tools: 6 actions · 1 trigger

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: optimoroute`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "optimoroute",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Create Order:
const result = await mcp.callTool({
  name: "optimoroute-create-order",
  arguments: {
    type: "Type",
    date: "Date",
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a OptimoRoute endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://api.optimoroute.com/v1/get_events

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkub3B0aW1vcm91dGUuY29tL3YxL2dldF9ldmVudHM?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "optimoroute-create-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    optimoroute: { authProvisionId: "apn_xxxxxxx" },
    type: "Type",
    date: "Date",
  },
})
```

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (6)

### `optimoroute-create-order` — Create Order (Write)

Create a new order. See the documentation

Full schema: https://pipedream.com/apps/optimoroute/actions/create-order.md

### `optimoroute-get-mobile-events` — Get Mobile Events (Read-only)

Get mobile events from Optimoroute. See the documentation

Full schema: https://pipedream.com/apps/optimoroute/actions/get-mobile-events.md

### `optimoroute-get-routes` — Get Routes (Read-only)

Get routes from Optimoroute. See the documentation

Full schema: https://pipedream.com/apps/optimoroute/actions/get-routes.md

### `optimoroute-search-orders` — Search Orders (Read-only)

Search for orders in Optimoroute. See the documentation

Full schema: https://pipedream.com/apps/optimoroute/actions/search-orders.md

### `optimoroute-start-planning` — Start Planning (Write)

Start planning for a given order. See the documentation

Full schema: https://pipedream.com/apps/optimoroute/actions/start-planning.md

### `optimoroute-update-order-status` — Update Order Status (Write)

Update the status of an order. See the documentation

Full schema: https://pipedream.com/apps/optimoroute/actions/update-order-status.md

## Triggers (1)

### `optimoroute-new-mobile-event` — New Mobile Event (Polling)

Emit new event when a new mobile event is received. See the documentation

Full schema: https://pipedream.com/apps/optimoroute/triggers/new-mobile-event.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt