View as Markdown
OptimoRoute icon

OptimoRoute ACTION

Create Order

Create a new 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 Create Order 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-create-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    optimoroute: { authProvisionId: "apn_xxxxxxx" },
    type: "Type",
    date: "Date",
  },
})

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.

Create Order inputs
Property Type Description
type Type string
The type of order to create
Required
date Date string
YYYY-MM-DD format, for example 2013-12-20
Required
address Address string
The full address including the country, for example 393 Hanover St, Boston, MA 02113, US
Required
orderNo Order Number string
A user specified order identifier, also displayed in the web application
Required
priority Priority string
The priority of the order
Required
email Email string
The customer email
Optional
phone Phone string
The customer phone number
Optional
notes Notes string
A note that will accompany the driver's instructions
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-create-order
Version
0.0.1
App
OptimoRoute
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes