View as Markdown
OptimoRoute icon

OptimoRoute ACTION

Start Planning

Start planning for a given order. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's OptimoRoute account once, then configure and run Start Planning 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-start-planning",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    optimoroute: { authProvisionId: "apn_xxxxxxx" },
    date: "Date",
    orderNumbers: ["Order Numbers"],
  },
})

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.

Start Planning inputs
Property Type Description
date Date string
Date to be planned. YYYY-MM-DD format, for example 2013-12-20
Required
orderNumbers Order Numbers string[]
Subset of orders on the planned date that should be included in the optimization
Optional
driverSerialNumbers Driver Serial Numbers string[]
Selected drivers that should be used in the optimization. By default (if useDrivers is not set or the list is empty) all available drivers for the specified date are used
Optional
balancing Balancing string
Route balancing settings
Optional
balanceBy Balance By string
Balance routes by
Optional
balancingFactor Balancing Factor string
Importance of balancing compared to route costs. Min: 0.0, Max: 1.0. Increasing the balancing factor will result in more balanced routes. Only applicable in combination with ON_FORCE (otherwise ignored).
Optional
startsWith Starts With string
Start planning from existing routes or from scratch
Optional
lockType Lock Type string
Lock type. Applicable if startsWith is set to CURRENT
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-start-planning
Version
0.0.2
App
OptimoRoute
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes