# WooCommerce Scraper (`crawlerbros/woocommerce-scraper`) Actor Scrape products, categories, tags, attributes, and reviews from any WooCommerce store. - **URL**: https://apify.com/crawlerbros/woocommerce-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** E-commerce, Other, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 15 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing from $1.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. 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 Scraper Extract products, categories, tags, attributes, and reviews from any WooCommerce-powered online store. Get structured product data including prices, images, stock status, ratings, and more. ### What can this scraper do? - **Scrape product data** from any WooCommerce store — names, prices, descriptions, images, SKUs, stock status, ratings, and reviews - **Extract categories, tags, and attributes** to map the store's product catalog structure - **Collect customer reviews** with ratings, reviewer names, and verification status - **Handle multiple stores** in a single run — scrape products from several WooCommerce stores at once - **Search and filter** products by keyword and sort by date, price, popularity, rating, or title - **Automatic fallback** — uses the WooCommerce Store API when available, with HTML scraping as a backup for maximum compatibility ### Input | Field | Type | Required | Default | Description | |-------|------|----------|---------|-------------| | `storeUrls` | Array of strings | Yes | — | WooCommerce store URLs to scrape (e.g., `https://example.com`) | | `maxProductsPerStore` | Integer | No | `100` | Maximum products to extract per store. Set to `0` for unlimited (up to 10,000) | | `resources` | Array | No | `["products"]` | What to scrape: `products`, `categories`, `tags`, `attributes`, `reviews` | | `searchQuery` | String | No | — | Filter products by keyword | | `sortBy` | String | No | Default | Sort products: `date`, `price`, `popularity`, `rating`, `title` | | `proxyConfiguration` | Object | No | — | Proxy settings (usually not needed) | #### Example input ```json { "storeUrls": ["https://example-store.com"], "maxProductsPerStore": 50, "resources": ["products", "categories", "reviews"], "searchQuery": "organic" } ```` ### Output #### Products | Field | Type | Description | |-------|------|-------------| | `id` | Integer | Product ID | | `name` | String | Product name | | `slug` | String | URL-friendly slug | | `type` | String | Product type: `simple`, `variable`, `grouped`, or `external` | | `url` | String | Full product page URL | | `sku` | String | Stock Keeping Unit | | `description` | String | Full product description (plain text) | | `shortDescription` | String | Short product description | | `price` | String | Current price | | `regularPrice` | String | Regular price (before any discount) | | `salePrice` | String | Sale price (empty if not on sale) | | `currency` | String | ISO 4217 currency code (e.g., `USD`, `EUR`, `GBP`) | | `currencySymbol` | String | Currency symbol (e.g., `$`, `€`, `£`) | | `onSale` | Boolean | Whether the product is currently on sale | | `priceHtml` | String | Formatted price with currency | | `averageRating` | String | Average customer rating (0-5) | | `reviewCount` | Integer | Number of customer reviews | | `images` | Array | Product images with `src` and `alt` fields | | `mainImageUrl` | String | URL of the main product image | | `categories` | Array | Product categories with `id`, `name`, `slug` | | `tags` | Array | Product tags with `id`, `name`, `slug` | | `attributes` | Array | Product attributes (e.g., Size, Color) with terms | | `variationCount` | Integer | Number of product variations | | `inStock` | Boolean | Whether the product is in stock | | `isPurchasable` | Boolean | Whether the product can be purchased | | `storeUrl` | String | The store URL that was scraped | | `scrapedAt` | String | ISO 8601 timestamp of when data was collected | #### Categories | Field | Type | Description | |-------|------|-------------| | `id` | Integer | Category ID | | `name` | String | Category name | | `slug` | String | URL-friendly slug | | `parent` | Integer | Parent category ID (0 if top-level) | | `count` | Integer | Number of products in this category | | `description` | String | Category description | | `image` | String | Category image URL | #### Tags | Field | Type | Description | |-------|------|-------------| | `id` | Integer | Tag ID | | `name` | String | Tag name | | `slug` | String | URL-friendly slug | | `count` | Integer | Number of products with this tag | #### Attributes | Field | Type | Description | |-------|------|-------------| | `id` | Integer | Attribute ID | | `name` | String | Attribute name (e.g., Color, Size) | | `slug` | String | URL-friendly slug | | `type` | String | Attribute type | | `terms` | Array | Available terms/values for this attribute | #### Reviews | Field | Type | Description | |-------|------|-------------| | `id` | Integer | Review ID | | `productId` | Integer | ID of the reviewed product | | `productName` | String | Name of the reviewed product | | `reviewer` | String | Reviewer name | | `rating` | Integer | Star rating (1-5) | | `review` | String | Review text (plain text) | | `dateCreated` | String | Review date | | `verified` | Boolean | Whether the reviewer is a verified buyer | #### Sample product output ```json { "resourceType": "product", "id": 63344, "name": "Beef Fajita Meat – 2LB", "slug": "beef-fajita-meat-2lb", "type": "simple", "url": "https://porterandyork.com/product/beef-fajita-meat-2lb/", "sku": "PY0775", "description": "Elevate your next meal with our premium Beef Fajita Meat...", "shortDescription": "", "price": "15", "regularPrice": "15", "salePrice": "", "currency": "USD", "currencySymbol": "$", "onSale": false, "priceHtml": "$15", "averageRating": "0", "reviewCount": 0, "images": [ { "src": "https://porterandyork.com/wp-content/uploads/Beef-Fajita-Meat-scaled.jpg", "alt": "Beef Fajita Meat" } ], "mainImageUrl": "https://porterandyork.com/wp-content/uploads/Beef-Fajita-Meat-scaled.jpg", "categories": [ { "id": 591, "name": "Poultry", "slug": "poultry" }, { "id": 17, "name": "Chicken", "slug": "buy-chicken-online" } ], "tags": [], "attributes": [], "variationCount": 0, "inStock": true, "isPurchasable": true, "storeUrl": "https://porterandyork.com", "scrapedAt": "2026-04-06T16:49:59.137187+00:00" } ``` ### Supported stores This scraper works with any online store powered by WooCommerce, including stores using: - Default WooCommerce themes (Storefront, etc.) - Custom themes built on WooCommerce - Page builders (Elementor, Divi, etc.) with WooCommerce integration - WooCommerce with multi-currency plugins ### Tips for best results - **Start small**: Set `maxProductsPerStore` to 10-20 for your first run to test compatibility with the target store - **Use the Store API path**: Most WooCommerce stores have the public Store API enabled by default. The scraper automatically detects and uses it — no configuration needed - **Proxy is optional**: The API path usually works without proxies. Only enable a proxy if the store blocks direct requests - **Multiple resource types**: Scrape products, categories, tags, and attributes in a single run to build a complete catalog picture - **Search feature**: Use `searchQuery` to find specific products instead of scraping the entire catalog ### Limitations - **Reviews**: Some stores restrict the WordPress comments API (used for reviews). If reviews return empty, the store has this endpoint locked down - **HTML fallback**: When the Store API is unavailable, the HTML scraper provides fewer data fields. Some fields like `sku` and detailed attributes may be limited - **Private stores**: Stores behind login walls or password protection cannot be scraped - **Custom endpoints**: Stores with heavily customized REST API routes may need manual URL adjustment ### FAQ **Does this scraper work with all WooCommerce stores?** Yes, it works with any publicly accessible WooCommerce store. It automatically detects the best scraping method (API or HTML) for each store. **Do I need a proxy?** Usually no. The WooCommerce Store API is a public endpoint designed for storefront use, so most stores allow direct access. Enable a proxy only if you experience blocking. **How many products can I scrape?** Set `maxProductsPerStore` to `0` to scrape up to 10,000 products per store. For larger catalogs, consider running multiple times with different search queries. **Can I scrape product variations?** The scraper reports the number of variations (`variationCount`) and the available attributes. Individual variation details (specific prices, SKUs per variant) are included in the attributes field. **What currencies are supported?** All currencies supported by WooCommerce are handled automatically. The `currency` field contains the ISO 4217 code (e.g., USD, EUR, GBP, AED) and `currencySymbol` contains the display symbol. **How do I scrape only specific categories?** Use the `searchQuery` field to filter products by keyword. For category-specific scraping, you can combine search terms that match the category names. **What happens if a store URL is invalid?** Invalid URLs are handled gracefully — the scraper logs a warning and continues to the next store. It will not crash or fail the entire run. **Can I export the data?** Yes, results can be exported as JSON, CSV, Excel, or XML directly from the Apify platform. **How often is the data updated?** Each run extracts fresh data. You can schedule recurring runs on Apify to keep your data current. **Is there a limit on the number of stores per run?** There is no hard limit. You can scrape multiple stores in a single run by adding them to the `storeUrls` array. # Actor input Schema ## `storeUrls` (type: `array`): Enter the homepage URL of each WooCommerce store you want to scrape. The scraper automatically detects the WooCommerce Store API and extracts product data. Supports any WooCommerce-powered site — custom themes, page builders (Elementor, Divi), multi-currency stores, etc. Example: https://my-store.com ## `maxProductsPerStore` (type: `integer`): Maximum number of products to extract from each store. The scraper paginates through the store catalog automatically. Set to 0 to scrape all available products (up to 10,000). Lower values reduce run time and cost. ## `resources` (type: `array`): Choose which types of data to extract. Products include full details (name, price, images, stock, ratings). Categories and tags map the store's catalog structure. Attributes list product options (Size, Color, etc.). Reviews include customer ratings and feedback. ## `searchQuery` (type: `string`): Filter products by keyword. Searches product names and descriptions. Leave empty to scrape all products. Examples: 'organic', 'cotton t-shirt', 'wireless headphones'. ## `sortBy` (type: `string`): Control the order in which products are scraped. Useful for getting cheapest items first (Price), newest arrivals (Date), or best sellers (Popularity). Default uses the store's native ordering. ## `proxyConfiguration` (type: `object`): Most WooCommerce stores work without a proxy since the scraper uses public APIs. Only enable this if a store blocks direct requests or returns CAPTCHAs. Datacenter proxies are usually sufficient — residential proxies are rarely needed. ## Actor input object example ```json { "storeUrls": [ "https://porterandyork.com" ], "maxProductsPerStore": 50, "resources": [ "products" ], "sortBy": "" } ``` # Actor output Schema ## `data` (type: `string`): Dataset containing scraped WooCommerce store data including products, categories, tags, attributes, and reviews. # 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://porterandyork.com" ], "maxProductsPerStore": 10, "resources": [ "products" ] }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/woocommerce-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://porterandyork.com"], "maxProductsPerStore": 10, "resources": ["products"], } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/woocommerce-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://porterandyork.com" ], "maxProductsPerStore": 10, "resources": [ "products" ] }' | apify call crawlerbros/woocommerce-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/woocommerce-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "WooCommerce Scraper", "description": "Scrape products, categories, tags, attributes, and reviews from any WooCommerce store.", "version": "1.0", "x-build-id": "OGZeoXBFraBhQzVnW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~woocommerce-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-woocommerce-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/crawlerbros~woocommerce-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-woocommerce-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/crawlerbros~woocommerce-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-woocommerce-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", "minItems": 1, "type": "array", "description": "Enter the homepage URL of each WooCommerce store you want to scrape. The scraper automatically detects the WooCommerce Store API and extracts product data. Supports any WooCommerce-powered site — custom themes, page builders (Elementor, Divi), multi-currency stores, etc. Example: https://my-store.com", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max Products Per Store", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum number of products to extract from each store. The scraper paginates through the store catalog automatically. Set to 0 to scrape all available products (up to 10,000). Lower values reduce run time and cost.", "default": 100 }, "resources": { "title": "Resources to Scrape", "type": "array", "description": "Choose which types of data to extract. Products include full details (name, price, images, stock, ratings). Categories and tags map the store's catalog structure. Attributes list product options (Size, Color, etc.). Reviews include customer ratings and feedback.", "items": { "type": "string", "enum": [ "products", "categories", "tags", "attributes", "reviews" ], "enumTitles": [ "Products — name, price, images, stock, SKU, description, ratings", "Categories — catalog hierarchy with product counts", "Tags — product labels and groupings", "Attributes — product options like Size, Color with all terms", "Reviews — customer ratings, review text, verified buyer status" ] }, "default": [ "products" ] }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Filter products by keyword. Searches product names and descriptions. Leave empty to scrape all products. Examples: 'organic', 'cotton t-shirt', 'wireless headphones'." }, "sortBy": { "title": "Sort Products By", "enum": [ "", "date", "price", "popularity", "rating", "title" ], "type": "string", "description": "Control the order in which products are scraped. Useful for getting cheapest items first (Price), newest arrivals (Date), or best sellers (Popularity). Default uses the store's native ordering.", "default": "" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Most WooCommerce stores work without a proxy since the scraper uses public APIs. Only enable this if a store blocks direct requests or returns CAPTCHAs. Datacenter proxies are usually sufficient — residential proxies are rarely needed." } } }, "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 } } } } } } } } } } ```