# WooCommerce Store Products Scraper (`centspy/woocommerce-products-scraper`) Actor Scrape any WooCommerce store's product catalog via the public Store API. No proxy, no browser. - **URL**: https://apify.com/centspy/woocommerce-products-scraper.md - **Developed by:** [brandon nadeau](https://apify.com/centspy) (community) - **Categories:** E-commerce, Lead generation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing $1.00 / 1,000 product scrapeds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## WooCommerce Store Products Scraper Extract the **full product catalog** from any WooCommerce store — names, prices (regular and sale), SKUs, stock status, categories, ratings, and image URLs. Ideal for competitor research, price monitoring, product discovery, and market analysis across the WooCommerce ecosystem. This scraper reads the **public WooCommerce Store API** (`/wp-json/wc/store/v1/products`), the same endpoint headless WooCommerce storefronts use. That means: - **No proxies needed** — keeps your cost low. - **No browser** — fast and lightweight. - **No broken selectors** — it reads a stable JSON API, not fragile HTML. Pair it with the **Shopify Store Products Scraper** to cover both major independent e-commerce platforms. ### What it does Give it one or more WooCommerce store URLs and it returns every product, cleanly structured and ready for a spreadsheet, database, or app. Prices are returned as normal decimals (the Store API serves them in minor units — this Actor converts them for you). ### Input | Field | Type | Description | |-------|------|-------------| | `storeUrls` | array | One or more WooCommerce store URLs. Domain alone is fine. **Required.** | | `maxProductsPerStore` | integer | Cap products per store. `0` = no limit. Default `0`. | | `onlyInStock` | boolean | Skip out-of-stock products. Default `false`. | | `includeVariations` | boolean | Include the variation count per product. Default `true`. | | `includeImages` | boolean | Include image URLs. Default `true`. | #### Example input ```json { "storeUrls": ["https://store-a.com", "https://store-b.com"], "maxProductsPerStore": 500, "onlyInStock": true } ```` ### Output ```json { "store": "https://store-a.com", "id": 1234, "name": "Organic Cotton T-Shirt", "sku": "OCT-BLK-M", "url": "https://store-a.com/product/organic-cotton-t-shirt", "price": 24.99, "regularPrice": 29.99, "salePrice": 24.99, "currency": "USD", "onSale": true, "inStock": true, "averageRating": 4.6, "reviewCount": 38, "categories": ["Apparel", "T-Shirts"], "tags": ["organic", "cotton"], "variationCount": 6, "images": ["https://store-a.com/wp-content/uploads/..."], "featuredImage": "https://store-a.com/wp-content/uploads/..." } ``` Export to **CSV, JSON, Excel, or HTML**, or pull via the Apify API. ### Pricing This Actor uses **pay-per-event** pricing — a small charge per product scraped, with platform usage included. A run scraping 1,000 products costs roughly the per-product price × 1,000. ### Notes & limitations - Some WooCommerce stores disable or restrict the public Store API. For those, the Actor logs a warning and moves on. - Returns published, customer-facing products. - `inStock` reflects each product's purchasable status at scrape time. ### Use cases - **Competitor monitoring** — track catalogs, pricing, and sales across WooCommerce rivals. - **Price intelligence** — feed regular/sale pricing into your dashboards. - **Product discovery** — find products and suppliers at scale. - **Market research** — analyze assortment, categories, and ratings. # Actor input Schema ## `storeUrls` (type: `array`): One or more WooCommerce store URLs. The domain is enough (e.g. mystore.com) — paths are ignored. ## `maxProductsPerStore` (type: `integer`): Cap the number of products scraped per store. Set 0 for no limit (scrape the whole catalog). ## `onlyInStock` (type: `boolean`): Skip products that are out of stock. ## `includeVariations` (type: `boolean`): Include the number of variations for each product. ## `includeImages` (type: `boolean`): Include image URLs for each product. ## Actor input object example ```json { "storeUrls": [ "https://store-a.com", "https://store-b.com" ], "maxProductsPerStore": 0, "onlyInStock": false, "includeVariations": true, "includeImages": true } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "storeUrls": [ "https://woocommerce.com" ] }; // Run the Actor and wait for it to finish const run = await client.actor("centspy/woocommerce-products-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "storeUrls": ["https://woocommerce.com"] } # Run the Actor and wait for it to finish run = client.actor("centspy/woocommerce-products-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "storeUrls": [ "https://woocommerce.com" ] }' | apify call centspy/woocommerce-products-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=centspy/woocommerce-products-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "WooCommerce Store Products Scraper", "description": "Scrape any WooCommerce store's product catalog via the public Store API. No proxy, no browser.", "version": "0.0", "x-build-id": "epiXqI11GYOl8i0ie" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/centspy~woocommerce-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-centspy-woocommerce-products-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/centspy~woocommerce-products-scraper/runs": { "post": { "operationId": "runs-sync-centspy-woocommerce-products-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/centspy~woocommerce-products-scraper/run-sync": { "post": { "operationId": "run-sync-centspy-woocommerce-products-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "storeUrls" ], "properties": { "storeUrls": { "title": "WooCommerce store URLs", "type": "array", "description": "One or more WooCommerce store URLs. The domain is enough (e.g. mystore.com) — paths are ignored.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Cap the number of products scraped per store. Set 0 for no limit (scrape the whole catalog).", "default": 0 }, "onlyInStock": { "title": "Only in-stock products", "type": "boolean", "description": "Skip products that are out of stock.", "default": false }, "includeVariations": { "title": "Include variation count", "type": "boolean", "description": "Include the number of variations for each product.", "default": true }, "includeImages": { "title": "Include images", "type": "boolean", "description": "Include image URLs for each product.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```