View as Markdown
OptimoRoute icon

OptimoRoute ACTION

Get Routes

Get routes from Optimoroute. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's OptimoRoute account once, then configure and run Get Routes from your backend or agent.

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-get-routes",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    optimoroute: { authProvisionId: "apn_xxxxxxx" },
    date: "Date",
    driverExternalId: "Driver External ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Routes inputs
Property Type Description
date Date string
Queried date. YYYY-MM-DD format, for example 2013-12-20
Required
driverExternalId Driver External ID string
Optionally filter by drivers external identifier
Optional
driverSerial Driver Serial string
Optionally filter by Serial number of the Driver
Optional
vehicleRegistration Vehicle Registration string
Optionally filter by Vehicle registration
Optional
includeRoutePolyline Include Route Polyline boolean
Optional property to include route polyline in the output
Optional
includeRouteStartEnd Include Route Start End boolean
Optional property to include the route's start and end locations in the output
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
optimoroute-get-routes
Version
0.0.1
App
OptimoRoute
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes