WooCommerce - Get Customers
Description
Section titled “Description”This module allows querying customers from your WooCommerce store, either a specific customer by ID or a list with search by email, name, or other criteria.
Configuration
Section titled “Configuration”| Field | Type | Required | Description |
|---|---|---|---|
credentials_id | string | Yes | Credentials ID |
customer_id | number | No | Specific customer ID |
email | string | No | Filter by exact email |
search | string | No | Text search |
role | string | No | Filter by role (customer, subscriber, etc.) |
orderby | string | No | id, include, name, registered_date |
order | string | No | asc, desc |
per_page | number | No | Customers per page (max 100) |
page | number | No | Page number |
Credentials
Section titled “Credentials”| Field | Description | Example |
|---|---|---|
url | WooCommerce store base URL | https://my-store.com |
consumer_key | REST API Consumer Key | ck_xxxx... |
consumer_secret | REST API Consumer Secret | cs_xxxx... |
Output
Section titled “Output”{ "success": true, "customers": [ { "id": 123, "email": "cliente@ejemplo.com", "first_name": "Juan", "last_name": "Garcia", "role": "customer", "billing": {}, "shipping": {}, "orders_count": 5, "total_spent": "450.00" } ], "total": 150, "total_pages": 3, "current_page": 1}Usage Example
Section titled “Usage Example”Search by email
Section titled “Search by email”{ "credentials_id": "woo_tienda", "email": "cliente@ejemplo.com"}Latest registered customers
Section titled “Latest registered customers”{ "credentials_id": "woo_tienda", "orderby": "registered_date", "order": "desc", "per_page": 20}- The maximum limit per request is 100 customers
- Email search is exact
- The
searchfield searches in first name, last name, and email - Customers include aggregated order information
Related Nodes
Section titled “Related Nodes”- WooCreateCustomer - Create a new customer
- WooUpdateCustomer - Update customer data
- WooGetOrders - Get customer orders