View as Markdown
Commerce Tools icon

Commerce Tools ACTION

Get Order by Order Number

Retrieve an Order by its orderNumber. 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 Get Order by Order Number 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-get-order-by-order-number",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    commerce_tools: { authProvisionId: "apn_xxxxxxx" },
    orderNumber: "Order Number",
    expand: ["Expand"],
  },
})

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.

Get Order by Order Number inputs
Property Type Description
orderNumber Order Number string
The orderNumber of the Order. Run the Query Orders action first to look up an Order's orderNumber.
Required
expand Expand string[]
Reference Expansion paths to expand in the response. For example, customerGroup.
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-get-order-by-order-number
Version
0.0.1
App
Commerce Tools
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes