# WooCommerce Products Scraper - Prices, Stock & Variations (`kmscrape/woocommerce-products-scraper`) Actor

Scrape any WooCommerce store's product catalog: prices, sale prices, stock, SKUs, categories, images and variations, via the public Store API. No login. For price monitoring and competitor research.

- **URL**: https://apify.com/kmscrape/woocommerce-products-scraper.md
- **Developed by:** [kfir messika](https://apify.com/kmscrape) (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

from $1.00 / 1,000 products

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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## WooCommerce Products Scraper — Prices, Stock & Variations via Store API

Collect product catalogs from public WooCommerce stores through the unauthenticated WooCommerce Store API. No login or HTML scraping is used. Product prices are converted from the API's minor units using the currency's `currency_minor_unit` value.

### Use cases

- Price monitoring
- Competitor catalog research
- Dropshipping research
- Product feeds for AI agents

### Input

```json
{
  "storeUrls": ["https://www.bloomscape.com", "zcrave.com/"],
  "maxProductsPerStore": 1000,
  "categorySlugs": ["plants"],
  "search": "planter",
  "onSaleOnly": false,
  "inStockOnly": true,
  "includeVariations": true
}
```

`storeUrls` is required; the input form has two verified public stores prefilled. URLs can include or omit a scheme, trailing slash, and a subpath. Filters are optional. Category slugs are resolved to category IDs through the categories API.

The output `type` identifies the row (`product`, `variation`, `summary`, or `error`). A product's WooCommerce classification (`simple`, `variable`, etc.) is returned as `productType`.

### Output examples

Trimmed product row from Bloomscape's live Store API response:

```json
{"type":"product","store":"https://www.bloomscape.com","productId":1101317,"name":"String of Bananas","slug":"string-of-bananas","url":"https://bloomscape.com/product/string-of-bananas/","sku":"PA04849","productType":"variable","price":49,"regularPrice":49,"salePrice":49,"currency":{"code":"USD","symbol":"$"},"onSale":false,"inStock":false,"stockStatus":"outofstock","isPurchasable":true,"averageRating":0,"reviewCount":0,"categories":[],"tags":[],"images":["https://bloomscape.com/wp-content/uploads/2026/04/IMG_0445-scaled.jpeg?ver=1101323"],"shortDescription":"The String of Bananas is a low-maintenance, fast growing succulent.","description":"The String of Bananas brings a playful, cascading look to any space.","attributes":[{"id":2,"name":"Pot Color","taxonomy":"pa_pot","has_variations":true,"terms":[{"id":42,"name":"Charcoal","slug":"charcoal","default":false},{"id":41,"name":"Clay","slug":"clay","default":false},{"id":44,"name":"Indigo","slug":"indigo","default":false},{"id":43,"name":"Slate","slug":"slate","default":false},{"id":40,"name":"Stone","slug":"stone","default":true}]}],"scrapedAt":"2026-10-04T00:00:00.000Z"}
```

Variation rows are emitted and charged individually when requested:

```json
{"type":"variation","store":"https://www.bloomscape.com","parentId":1101317,"variationId":1101322,"attributes":[{"name":"Pot Color","value":"stone"}],"price":49,"regularPrice":49,"salePrice":49,"inStock":false,"sku":"P004854","scrapedAt":"2026-10-04T00:00:00.000Z"}
```

Each store also receives a free summary row. Failures produce free error rows; when the public API is unavailable the error is `WooCommerce Store API not available`.

### Pricing

$1.00 per 1,000 product and variation rows, configured as the `product-result` pay-per-event in Apify Console. Summary and error rows are free. Local runs work when pay-per-event pricing is not configured.

### Limits

The store must expose the public WooCommerce Store API, which is enabled by default on WooCommerce 6 and later. Site owners can disable it or block requests. The scraper retries HTTP 429 and 5xx responses with backoff, times requests out after 20 seconds, and tries the `rest_route` URL form if pretty permalinks are unavailable. There is no HTML scraping fallback. A maximum of 100 products is fetched per API page; up to three stores run concurrently, with one page request at a time per store.

### FAQ

**Do I need credentials?** No. This actor reads the public Store API only.

**Why is a store missing?** Its Store API may be disabled, blocked, or unavailable. An error row reports this without charging.

**Are variations included automatically?** No. Set `includeVariations` to `true`; each variation is a separate charged result row.

**How are prices converted?** The Store API returns integer minor units. Prices are divided by 10 to the power of `currency_minor_unit`, including zero-decimal and three-decimal currencies.

**Does it scrape rendered web pages?** No. Version 1 uses the public Store API and has no HTML fallback.

# Actor input Schema

## `storeUrls` (type: `array`):

Public WooCommerce storefront URLs. The public WooCommerce Store API must be enabled.

## `maxProductsPerStore` (type: `integer`):

Maximum number of products to collect from each store.

## `categorySlugs` (type: `array`):

Optional category slugs; matched to IDs through the categories endpoint.

## `search` (type: `string`):

Optional Store API product search term.

## `onSaleOnly` (type: `boolean`):

Only return products that are currently on sale.

## `inStockOnly` (type: `boolean`):

Only return products that are currently in stock.

## `includeVariations` (type: `boolean`):

Also fetch each variation (size, color, etc.) of variable products with its own price and stock.

## Actor input object example

```json
{
  "storeUrls": [
    "https://www.bloomscape.com",
    "https://zcrave.com"
  ],
  "maxProductsPerStore": 50,
  "onSaleOnly": false,
  "inStockOnly": false,
  "includeVariations": false
}
```

# Actor output Schema

## `results` (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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "storeUrls": [
        "https://www.bloomscape.com",
        "https://zcrave.com"
    ],
    "maxProductsPerStore": 50
};

// Run the Actor and wait for it to finish
const run = await client.actor("kmscrape/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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "storeUrls": [
        "https://www.bloomscape.com",
        "https://zcrave.com",
    ],
    "maxProductsPerStore": 50,
}

# Run the Actor and wait for it to finish
run = client.actor("kmscrape/woocommerce-products-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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://www.bloomscape.com",
    "https://zcrave.com"
  ],
  "maxProductsPerStore": 50
}' |
apify call kmscrape/woocommerce-products-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,kmscrape/woocommerce-products-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/oMrzgsBHDLl3yhfM4/builds/VsSA92wEOekAJNdFe/openapi.json