ExplorePricingDocsCommunityBlogCareers
  Star
Sign InSign Up Free!
← WooCommerce

Search Customers with WooCommerce API

Pipedream makes it easy to connect APIs for WooCommerce and 1000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Search Customers with the WooCommerce API
No credit card required
Into to Pipedream
▶
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers ♥ Pipedream

Getting Started

Create a workflow to Search Customers with the WooCommerce API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Search Customers action
    1. Connect your WooCommerce account
    2. Optional- Configure Search
    3. Optional- Configure Email
    4. Optional- Select a Role
    5. Optional- Configure Max Results
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Search Customers with WooCommerce API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + WooCommerce
 
Try it
Search Customers with WooCommerce API on New Item in Feed from RSS API
RSS + WooCommerce
 
Try it
Search Customers with WooCommerce API on New Message from Discord API
Discord + WooCommerce
 
Try it
Search Customers with WooCommerce API on New Message In Channels from Slack API
Slack + WooCommerce
 
Try it
Search Customers with WooCommerce API on New Message in Channel from Discord Bot API
Discord Bot + WooCommerce
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Search Customers on WooCommerce
Description:Finds a customer by searching. [See the docs](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-customers)
Version:0.0.2
Key:woocommerce-search-customers

Code

import woocommerce from "../../woocommerce.app.mjs";
import pick from "lodash.pick";
import pickBy from "lodash.pickby";

export default {
  key: "woocommerce-search-customers",
  name: "Search Customers",
  description: "Finds a customer by searching. [See the docs](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-customers)",
  version: "0.0.2",
  type: "action",
  props: {
    woocommerce,
    search: {
      propDefinition: [
        woocommerce,
        "search",
      ],
    },
    email: {
      propDefinition: [
        woocommerce,
        "email",
      ],
    },
    role: {
      propDefinition: [
        woocommerce,
        "role",
      ],
    },
    maxResults: {
      propDefinition: [
        woocommerce,
        "maxResults",
      ],
    },
  },
  async run({ $ }) {
    const { maxResults } = this;
    const params = {
      page: 1,
      per_page: 10,
      ...pickBy(pick(this, [
        "search",
        "email",
        "role",
      ])),
    };

    const customers = [];
    let results;
    do {
      results = await this.woocommerce.listCustomers(params);
      customers.push(...results);
      params.page += 1;
    } while (results.length === params.per_page && customers.length < maxResults);
    if (customers.length > maxResults) {
      customers.length = maxResults;
    }
    $.export("$summary", `Found ${customers.length} results`);
    return customers;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
WooCommercewoocommerceappThis component uses the WooCommerce app.
Searchsearchstring

Limit results to those matching a string

Emailemailstring

Limit result set to resources with a specific email

RolerolestringSelect a value from the drop down menu:alladministratoreditorauthorcontributorsubscribercustomer
Max ResultsmaxResultsinteger

Maximum number of results to return

Authentication

WooCommerce uses API keys for authentication. When you connect your WooCommerce account, Pipedream securely stores the keys so you can easily authenticate to WooCommerce APIs in both code and no-code steps.

  1. Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

  2. Enter the domain of your store as the URL below. For example, if you run a store at https://mystore.com/wp-json/wc/v2/orders, enter https://mystore.com below.

About WooCommerce

Open source eCommerce platform built for WordPress

More Ways to Use WooCommerce

Triggers

New Coupon Event (Instant) from the WooCommerce API

Emit new event each time the specified coupon event(s) occur

 
Try it
New Customer Event (Instant) from the WooCommerce API

Emit new event each time the specified customer event(s) occur

 
Try it
New Order Event (Instant) from the WooCommerce API

Emit new event each time the specified order event(s) occur

 
Try it
New Product Event (Instant) from the WooCommerce API

Emit new event each time the specified product event(s) occur

 
Try it

Actions

Create Customer with the WooCommerce API

Creates a new customer. See the docs

 
Try it
Create Order with the WooCommerce API

Creates a new order. See the docs

 
Try it
Create Product with the WooCommerce API

Creates a new product. See the docs

 
Try it
Get Customer with the WooCommerce API

Retrieve a specific customer. See the docs

 
Try it
Get Order with the WooCommerce API

Retrieve a specific order. See the docs

 
Try it

Explore Other Apps

1
-
12
of
1000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Airtable
Airtable
Looks like a spreadsheet, acts like a database.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Filter
Filter
Specify a condition that your workflow must meet and whether you'd like to proceed or end workflow execution.
abcdefghijklmnopqrstuvwxyz#
Pipedream, Inc. — San Francisco, CA
AboutTwitterDocsCommunityTermsPrivacy