woo_list_products

Pack: woocommerce · Endpoint: https://gateway.pipeworx.io/woocommerce/mcp

List products from a WooCommerce store.

Parameters

NameTypeRequiredDescription
_apiKeystringyesWooCommerce consumer key
_apiSecretstringyesWooCommerce consumer secret
_storeUrlstringyesStore URL (e.g., https://mystore.com)
per_pagenumbernoResults per page (max 100, default 20)
pagenumbernoPage number (default 1)

Example call

Arguments

{
  "_apiKey": "your-woocommerce-api-key",
  "_apiSecret": "your-woocommerce-api-secret",
  "_storeUrl": "https://mystore.com"
}

curl

curl -X POST https://gateway.pipeworx.io/woocommerce/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"woo_list_products","arguments":{"_apiKey":"your-woocommerce-api-key","_apiSecret":"your-woocommerce-api-secret","_storeUrl":"https://mystore.com"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('woo_list_products', {
  "_apiKey": "your-woocommerce-api-key",
  "_apiSecret": "your-woocommerce-api-secret",
  "_storeUrl": "https://mystore.com"
});

More examples

{
  "_apiKey": "your-woocommerce-api-key",
  "_apiSecret": "your-woocommerce-api-secret",
  "_storeUrl": "https://mystore.com",
  "per_page": 50,
  "page": 2
}

Response shape

Always returns: items, count

FieldTypeDescription
itemsarrayArray of products from WooCommerce store
countintegerNumber of items returned.
Full JSON Schema
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "Array of products from WooCommerce store",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Product ID"
          },
          "name": {
            "type": "string",
            "description": "Product name"
          },
          "slug": {
            "type": "string",
            "description": "Product slug"
          },
          "permalink": {
            "type": "string",
            "description": "Product permalink"
          },
          "date_created": {
            "type": "string",
            "description": "Creation date in ISO format"
          },
          "date_modified": {
            "type": "string",
            "description": "Last modified date in ISO format"
          },
          "type": {
            "type": "string",
            "description": "Product type"
          },
          "status": {
            "type": "string",
            "description": "Product status"
          },
          "featured": {
            "type": "boolean",
            "description": "Whether product is featured"
          },
          "catalog_visibility": {
            "type": "string",
            "description": "Catalog visibility"
          },
          "description": {
            "type": "string",
            "description": "Product description"
          },
          "short_description": {
            "type": "string",
            "description": "Short product description"
          },
          "sku": {
            "type": "string",
            "description": "Product SKU"
          },
          "price": {
            "type": "string",
            "description": "Product price"
          },
          "regular_price": {
            "type": "string",
            "description": "Regular price"
          },
          "sale_price": {
            "type": "string",
            "description": "Sale price"
          },
          "total_sales": {
            "type": "number",
            "description": "Total sales count"
          },
          "tax_status": {
            "type": "string",
            "description": "Tax status"
          },
          "tax_class": {
            "type": "string",
            "description": "Tax class"
          },
          "stock_quantity": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Stock quantity"
          },
          "stock_status": {
            "type": "string",
            "description": "Stock status"
          }
        }
      }
    },
    "count": {
      "type": "integer",
      "description": "Number of items returned."
    }
  },
  "required": [
    "items",
    "count"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "woocommerce": {
      "url": "https://gateway.pipeworx.io/woocommerce/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build June 24, 2026