View as Markdown
WooCommerce icon

WooCommerce ACTION

List Orders

Retrieve a list of orders. See the docs
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's WooCommerce 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: "woocommerce-list-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    woocommerce: { authProvisionId: "apn_xxxxxxx" },
    search: "Search",
    orderStatus: "Status",
  },
})

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 Search string
Limit results to those matching a string
Optional
orderStatus Status string
Order Status
Optional
customer Customer integer
User ID who owns the order. 0 for guests
Optional Dynamic
after After string
Limit response to resources published after a given ISO8601 compliant date (e.g., 2023-01-01T00:00:00)
Optional
before Before string
Limit response to resources published before a given ISO8601 compliant date (e.g., 2023-12-31T23:59:59)
Optional
maxResults Max Results integer
Maximum number of results to return
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
woocommerce-list-orders
Version
0.0.1
App
WooCommerce
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes