Skip to content

WooCommerce - Get Products

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.

FieldTypeRequiredDescription
credentials_idstringYesCredentials ID
product_idnumberNoSpecific product ID
searchstringNoText search
skustringNoFilter by SKU
categorynumberNoCategory ID
tagnumberNoTag ID
statusstringNodraft, pending, private, publish
typestringNosimple, grouped, external, variable
stock_statusstringNoinstock, outofstock, onbackorder
on_salebooleanNoOnly products on sale
featuredbooleanNoOnly featured products
min_pricestringNoMinimum price
max_pricestringNoMaximum price
orderbystringNodate, id, title, slug, price, popularity
orderstringNoasc, desc
per_pagenumberNoProducts per page (max 100)
pagenumberNoPage number

Configure credentials in your WordPress: WooCommerce > Settings > Advanced > REST API.

FieldDescriptionExample
urlStore base URLhttps://my-store.com
consumer_keyAPI Consumer Keyck_xxxx...
consumer_secretAPI Consumer Secretcs_xxxx...
{
"success": true,
"products": [],
"total": 150,
"total_pages": 3,
"current_page": 1,
"per_page": 50,
"filters_applied": {}
}
{
"credentials_id": "woo_tienda",
"sku": "PROD-001"
}
{
"credentials_id": "woo_tienda",
"on_sale": true,
"status": "publish",
"per_page": 50
}
{
"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 after and before with ISO 8601 format to filter by date
  • WooCreateProduct - Create a new product
  • WooUpdateProduct - Update product data
  • WooGetOrders - Get orders that include products