Search Customers with WooCommerce API

Pipedream makes it easy to connect APIs for WooCommerce and 2,400+ 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

▶

Watch us build a workflow

8 min

Watch now ➜

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

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.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
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

View on GitHub

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.

Label	Prop	Type	Description
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce app.
Search	`search`	`string`	Limit results to those matching a string
Email	`email`	`string`	Limit result set to resources with a specific email
Role	`role`	`string`	Select a value from the drop down menu:`alladministratoreditorauthorcontributorsubscribercustomer`
Max Results	`maxResults`	`integer`	Maximum number of results to return