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)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "order_desk-list-orders",
"configured_props": {
"order_desk": { "authProvisionId": "apn_xxxxxxx" },
"search_start_date_local": "Search Start Date Local",
"search_end_date_local": "Search End Date Local"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "order_desk",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "order_desk-list-orders",
arguments: {
search_start_date_local: "Search Start Date Local",
search_end_date_local: "Search End Date Local",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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
- Source
- View on GitHub ↗