WooCommerce - Get Products
Description
Section titled “Description”This module allows querying products from your WooCommerce store, either a specific product by ID or a list filtered by category, SKU, status, price, stock, and more.
Configuration
Section titled “Configuration”| Field | Type | Required | Description |
|---|---|---|---|
credentials_id | string | Yes | Credentials ID |
product_id | number | No | Specific product ID |
search | string | No | Text search |
sku | string | No | Filter by SKU |
category | number | No | Category ID |
tag | number | No | Tag ID |
status | string | No | draft, pending, private, publish |
type | string | No | simple, grouped, external, variable |
stock_status | string | No | instock, outofstock, onbackorder |
on_sale | boolean | No | Only products on sale |
featured | boolean | No | Only featured products |
min_price | string | No | Minimum price |
max_price | string | No | Maximum price |
orderby | string | No | date, id, title, slug, price, popularity |
order | string | No | asc, desc |
per_page | number | No | Products per page (max 100) |
page | number | No | Page number |
Credentials
Section titled “Credentials”Configure credentials in your WordPress: WooCommerce > Settings > Advanced > REST API.
| Field | Description | Example |
|---|---|---|
url | Store base URL | https://my-store.com |
consumer_key | API Consumer Key | ck_xxxx... |
consumer_secret | API Consumer Secret | cs_xxxx... |
Output
Section titled “Output”{ "success": true, "products": [], "total": 150, "total_pages": 3, "current_page": 1, "per_page": 50, "filters_applied": {}}Usage Example
Section titled “Usage Example”Search by SKU
Section titled “Search by SKU”{ "credentials_id": "woo_tienda", "sku": "PROD-001"}Products on sale
Section titled “Products on sale”{ "credentials_id": "woo_tienda", "on_sale": true, "status": "publish", "per_page": 50}Out of stock products
Section titled “Out of stock products”{ "credentials_id": "woo_tienda", "stock_status": "outofstock", "per_page": 100}- The maximum limit per request is 100 products
- Response headers include pagination information
- SKU search is exact, not partial
- Use
afterandbeforewith ISO 8601 format to filter by date
Related Nodes
Section titled “Related Nodes”- WooCreateProduct - Create a new product
- WooUpdateProduct - Update product data
- WooGetOrders - Get orders that include products