View as Markdown
OptimoRoute icon

OptimoRoute ACTION

Search Orders

Search for orders in 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 Search Orders 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-search-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    optimoroute: { authProvisionId: "apn_xxxxxxx" },
    from: "From",
    to: "To",
  },
})

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.

Search Orders inputs
Property Type Description
from From string
From date. YYYY-MM-DD format, for example 2013-12-20. The range can span at most 35 days, i.e. 5 weeks
Required
to To string
To date. YYYY-MM-DD format, for example 2013-12-20. The range can span at most 35 days, i.e. 5 weeks
Required
includeOrderData Include Order Data boolean
Include order data in the response
Optional
includeScheduleInformation Include Schedule Information boolean
Include schedule information in the response
Optional
afterTag After Tag string
Specify the after_tag to retrieve the next page of results from a previous call to this endpoint
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-search-orders
Version
0.0.2
App
OptimoRoute
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes