View as Markdown
Commerce Tools icon

Commerce Tools ACTION

Query Orders

Retrieve Orders in the Project, optionally filtered and sorted. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Commerce Tools account once, then configure and run Query 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: "commerce_tools-query-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    commerce_tools: { authProvisionId: "apn_xxxxxxx" },
    where: ["Where"],
    sort: ["Sort"],
  },
})

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.

Query Orders inputs
Property Type Description
where Where string[]
Query Predicate(s) to filter Orders. Multiple predicates are combined with a logical AND. For example, orderState="Open".
Optional
sort Sort string[]
Sort expression(s). For example, lastModifiedAt desc.
Optional
expand Expand string[]
Reference Expansion paths to expand in the response. For example, customerGroup.
Optional
limit Limit integer
The maximum number of Orders to return (max 500).
Optional
offset Offset integer
The number of results to skip (for pagination).
Optional
withTotal With Total boolean
Whether to calculate the total number of matching Orders. Set to false to improve performance when the total is not needed.
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
commerce_tools-query-orders
Version
0.0.1
App
Commerce Tools
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes