View as Markdown
Order Desk icon

Order Desk ACTION

List Orders

List Orders based on a search criteria See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Order Desk account once, then configure and run List 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: "order_desk-list-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    order_desk: { authProvisionId: "apn_xxxxxxx" },
    search_start_date_local: "Search Start Date Local",
    search_end_date_local: "Search End Date Local",
  },
})

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.

List Orders inputs
Property Type Description
search_start_date_local Search Start Date Local string
Start date from when an order was added. Search in local store time.
Optional
search_end_date_local Search End Date Local string
End date from when an order was added. Search in local store time.
Optional
search_start_date Search Start Date string
Start date from when an order was added. Search in UTC time.
Optional
search_end_date Search End Date string
End date from when an order was added. Search in UTC time.
Optional
modified_start_date Modified Start Date string
Start date from when an order was last modified. Search in UTC time.
Optional
modified_end_date Modified End Date string
End date from when an order was last modified. Search in UTC time.
Optional
order_by Order By string
Order the query by an order field. Defaults to date_added
Optional
order Order string
Order the query by asc or desc. Defaults to desc
Optional
folder_id Folder ID string
Search for orders from a particular folder. For multiple folders, enter multiple ID's separated by a comma: 1004,1009,1010
Optional
folder_name Folder Name string
Search for orders from a particular folder. Enter the folder's exact name instead of its ID.
Optional
source_id Source ID string
The Source Id
Optional
source_name Source Name string
The Source Name
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
order_desk-list-orders
Version
0.0.2
App
Order Desk
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes