# WooCommerce Product Scraper (`mighty_monk/woocommerce-product-scraper`) Actor Scrape WooCommerce store products via Store REST API. Extract prices, SKUs, stock status, categories, and images for competitor and market research. - **URL**: https://apify.com/mighty\_monk/woocommerce-product-scraper.md - **Developed by:** [Harsh](https://apify.com/mighty_monk) (community) - **Categories:** E-commerce, Developer tools - **Stats:** 3 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $3.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 Product Scraper Scrape product data from WooCommerce stores for competitor research, price monitoring, and catalog analysis. This Actor uses HTTP requests only (no browser) and tries multiple data sources automatically. ### Features - **Store API first** — uses the public WooCommerce Store API (`/wp-json/wc/store/v1/products`) - **REST API fallback** — tries the WooCommerce REST API v3 (`/wp-json/wc/v3/products`) when the Store API is unavailable - **HTML fallback** — scrapes product links from `/shop/` and parses product pages when JSON APIs are blocked - **Variation support** — optionally fetches product variations for variable products - **Graceful errors** — pushes error records when a store cannot be scraped ### Input | Field | Type | Required | Default | Description | |-------|------|----------|---------|-------------| | `storeUrls` | `string[]` | Yes | — | WooCommerce store base URLs | | `maxProducts` | `integer` | No | `100` | Max products per store | | `includeVariations` | `boolean` | No | `false` | Include variable product variations | #### Example input ```json { "storeUrls": [ "https://demo.woothemes.com/storefront" ], "maxProducts": 25, "includeVariations": false } ```` ### Output Each dataset item contains: | Field | Description | |-------|-------------| | `title` | Product name | | `sku` | Stock keeping unit | | `price` | Current price | | `regularPrice` | Regular price | | `salePrice` | Sale price | | `stockStatus` | `instock`, `outofstock`, or `onbackorder` | | `categories` | Category names | | `images` | Image URLs | | `permalink` | Product page URL | | `storeUrl` | Source store URL | | `scrapedAt` | ISO timestamp | | `error` | Error message when scraping failed | ### How it works 1. For each store URL, the Actor normalizes the base URL. 2. It paginates through the Store API (`per_page=100`). 3. If that fails, it tries the WC REST API v3 endpoint. 4. If both JSON endpoints fail, it scrapes `/shop/` for product links and parses each product page. 5. Results are saved to the default dataset. ### Local development ```bash npm install apify run ``` Create `storage/key_value_stores/default/INPUT.json` with your test input, or edit the prefill values in the input schema. ### Deploy ```bash apify login apify push ``` ### Notes - Some stores disable public REST APIs and only allow HTML scraping. - WC REST API v3 often requires authentication; the Actor handles this by falling back automatically. - Respect each store's terms of service and robots.txt when scraping. # Actor input Schema ## `storeUrls` (type: `array`): WooCommerce store base URLs to scrape (e.g. https://example.com). ## `maxProducts` (type: `integer`): Maximum number of products to scrape per store. ## `includeVariations` (type: `boolean`): When enabled, also fetch product variations for variable products via the REST API. ## Actor input object example ```json { "storeUrls": [ "https://woocommerce.com" ], "maxProducts": 100, "includeVariations": false } ``` # Actor output Schema ## `products` (type: `string`): No description # 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("mighty_monk/woocommerce-product-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("mighty_monk/woocommerce-product-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 mighty_monk/woocommerce-product-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=mighty_monk/woocommerce-product-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "WooCommerce Product Scraper", "description": "Scrape WooCommerce store products via Store REST API. Extract prices, SKUs, stock status, categories, and images for competitor and market research.", "version": "0.0", "x-build-id": "cJzLwkq6q1UWIr1BK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mighty_monk~woocommerce-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mighty_monk-woocommerce-product-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/mighty_monk~woocommerce-product-scraper/runs": { "post": { "operationId": "runs-sync-mighty_monk-woocommerce-product-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/mighty_monk~woocommerce-product-scraper/run-sync": { "post": { "operationId": "run-sync-mighty_monk-woocommerce-product-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": "Store URLs", "type": "array", "description": "WooCommerce store base URLs to scrape (e.g. https://example.com).", "items": { "type": "string" } }, "maxProducts": { "title": "Max products", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of products to scrape per store.", "default": 100 }, "includeVariations": { "title": "Include variations", "type": "boolean", "description": "When enabled, also fetch product variations for variable products via the REST API.", "default": false } } }, "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 } } } } } } } } } } ```