View as Markdown
Commerce Tools icon

Commerce Tools ACTION

Search Orders

Search Orders using the Order Search API. The endpoint must be activated and indexed for your Project first - run the Change Order Search Status action to enable it, then the Reindex Orders action to build the index. 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 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: "commerce_tools-search-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    commerce_tools: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    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.

Search Orders inputs
Property Type Description
query Query object
The Order search query as a JSON object. For example: { "exact": { "field": "orderState", "value": "Open" } }.
Required
sort Sort string[]
An array of OrderSearchSorting objects, each added as a separate JSON string controlling how results are sorted. For example: { "field": "createdAt", "order": "desc" }.
Optional
limit Limit integer
The maximum number of search results to return (max 100).
Optional
offset Offset integer
The number of results to skip (for pagination).
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-search-orders
Version
0.0.2
App
Commerce Tools
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes