View as Markdown
WooCommerce icon

WooCommerce ACTION

Search Customers

Finds a customer by searching. 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 Search Customers 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-search-customers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    woocommerce: { authProvisionId: "apn_xxxxxxx" },
    search: "Search",
    email: "Email",
  },
})

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 Customers inputs
Property Type Description
search Search string
Limit results to those matching a string
Optional
email Email string
Limit result set to resources with a specific email
Optional
role Role string
Limit result set to resources with a specific role
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-search-customers
Version
0.0.5
App
WooCommerce
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes