# Woocommerce Store Api Products Scraper (`real-estate-api/woocommerce-store-api-products-scraper`) Actor

WooCommerce Store API Products Scraper is a Python tool designed to extract product titles, prices, stock statuses, categories, attributes, and descriptions from WooCommerce store REST APIs. It exports structured e-commerce product datasets into clean CSV or JSON format

- **URL**: https://apify.com/real-estate-api/woocommerce-store-api-products-scraper.md
- **Developed by:** [real-estate-api](https://apify.com/real-estate-api) (community)
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.99 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

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 Store API Products Scraper — Product Catalogs, Prices, and Inventory

![WooCommerce Store API Products Scraper cover](https://images.bigibyte.com/cdn-cgi/image/width=1260,height=540,fit=cover,format=webp/apify-actors-covers/woocommerce-store-api-products-scraper-cover.png)

Collect WooCommerce product information into a structured dataset. Gather product names, descriptions, prices, categories, images, ratings, and stock information from publicly accessible store catalogs. Export your results in JSON, CSV, Excel, and other supported formats.

### Overview

WooCommerce Store API Products Scraper helps developers, analysts, and e-commerce professionals collect and organize publicly available product catalog information.

Provide one or more store URLs, optionally enter a search term, and set a maximum item count to create a dataset for product research, catalog analysis, and price comparisons.

### Features

- **Product Catalog Collection:** Gather available product records from supported WooCommerce stores.
- **Product Search:** Filter products using a search term.
- **Pricing Information:** Collect regular prices, sale prices, and currency details when available.
- **Inventory Indicators:** Capture stock availability, backorder status, and purchasing eligibility.
- **Product Details:** Retrieve names, slugs, descriptions, SKUs, and product types.
- **Categories and Attributes:** Collect available categories, tags, brands, and product attributes.
- **Images and Ratings:** Capture product image information, review counts, and average ratings when available.
- **Configurable Collection:** Set a maximum item count and request delay.
- **Structured Exports:** Export results in JSON, CSV, Excel, and other supported formats.

### Use Cases

- **Product Research:** Build structured catalogs of products from supported WooCommerce stores.
- **Price Comparison:** Compare product prices and sale prices across stores.
- **Inventory Analysis:** Review publicly available stock and backorder indicators.
- **E-commerce Analytics:** Analyze product categories, ratings, and catalog composition.
- **Catalog Management:** Create product datasets for reporting and further processing.
- **Market Research:** Organize publicly available product information for analysis.

### Input Parameters

| Parameter | Type | Description |
|---|---|---|
| `mode` | String | Collection mode. Use `products`. |
| `storeUrls` | Array | Store URLs to collect products from. |
| `search` | String | Optional search term for filtering products. |
| `maxItems` | Integer | Maximum number of products to collect. |
| `requestDelaySecs` | Number | Delay between requests, in seconds. |

### Example Input

```json id="k8s4vx"
{
  "mode": "products",
  "storeUrls": [
    "https://woocommerce.com"
  ],
  "search": "",
  "maxItems": 50,
  "requestDelaySecs": 1
}
```

### What Data Does This Actor Extract?

The available fields depend on the product and the information exposed by the store.

| Field | Description |
|---|---|
| `productId` | Product identifier. |
| `name` | Product name. |
| `slug` | URL-friendly product identifier. |
| `parent` | Parent product identifier, if applicable. |
| `productType` | Product type, such as simple or variable. |
| `variation` | Variation information when available. |
| `permalink` | Product page link. |
| `sku` | Stock keeping unit, when provided. |
| `shortDescription` | Short product description. |
| `productDescription` | Main product description. |
| `onSale` | Indicates whether the product is on sale. |
| `prices` | Available price values and currency information. |
| `priceHtml` | Formatted price information, when provided. |
| `averageRating` | Average product rating, when available. |
| `reviewCount` | Number of reviews. |
| `images` | Available product image information. |
| `categories` | Product categories. |
| `tags` | Product tags. |
| `brands` | Brand information, when available. |
| `attributes` | Product attributes. |
| `variations` | Available variation information. |
| `groupedProducts` | Associated products for grouped listings. |
| `hasOptions` | Indicates whether the product has selectable options. |
| `isPurchasable` | Indicates whether the product can be purchased. |
| `isInStock` | Indicates whether the product is in stock. |
| `isOnBackorder` | Indicates whether the product is on backorder. |
| `scrapedAt` | Timestamp when the record was collected. |

### Example Output

```json id="p3r5xm"
{
  "productId": 18734006941935,
  "name": "Daily PDF Sales Report Email",
  "slug": "daily-detail-sales-report",
  "parent": 0,
  "productType": "simple",
  "variation": "",
  "permalink": "https://woocommerce.com/products/daily-detail-sales-report/",
  "sku": "",
  "shortDescription": "Automatically email a detailed PDF sales report...",
  "productDescription": "Get a daily WooCommerce sales report delivered to your inbox as a clean, ready-to-read PDF.",
  "onSale": false,
  "prices": {
    "price": "6900",
    "regular_price": "6900",
    "sale_price": "6900",
    "currency_code": "USD"
  },
  "averageRating": "0",
  "reviewCount": 0,
  "images": [],
  "categories": [],
  "tags": [],
  "brands": [],
  "attributes": [],
  "variations": [],
  "groupedProducts": [],
  "hasOptions": false,
  "isPurchasable": true,
  "isInStock": true,
  "isOnBackorder": false,
  "scrapedAt": "2026-10-26T00:00:00+00:00"
}
```

This example illustrates the output structure. Actual values and available fields vary by store and product.

### Working with Your Dataset

After the actor finishes, open the dataset to review and export the collected product records.

You can:

- Export results as JSON, CSV, Excel, or another supported format.
- Sort products by name, price, rating, or stock availability.
- Compare catalog information across supported stores.
- Analyze categories and product attributes using spreadsheets.
- Process datasets with Python, Pandas, or other data analysis tools.

### FAQ

**Who is this actor for?**

It is designed for e-commerce professionals, developers, researchers, and analysts who need structured product catalog information from WooCommerce stores.

**Can I collect products from multiple stores?**

Yes. Provide multiple store URLs in the `storeUrls` array. Results depend on whether each store exposes accessible product information.

**Can I search for specific products?**

Yes. Enter a search term in the `search` field to filter the collection.

**What export formats are available?**

You can export the dataset in JSON, CSV, Excel, and other formats supported by Apify.

**Can I schedule recurring collections?**

Yes. Configure an Apify schedule to refresh your dataset periodically.

**Will every product include all fields?**

No. Available information varies by store and product. Optional fields such as ratings, brands, images, and attributes may be empty or unavailable.

### Disclaimer

This actor is an independent tool and is not affiliated with, endorsed by, sponsored by, or officially associated with WooCommerce or its owners. Users are responsible for complying with applicable terms of use and laws when collecting and using data.

### Is Web Scraping Legal?

Collecting information that is already public is generally legal. There is no single law that bans all forms of web scraping. The limits are the usual ones: do not break into accounts, do not take private or confidential data, and be careful with personal data and copyrighted works. A site's terms can also restrict how you access it. Facts such as a public name, price, or rating are not the same thing as republishing someone's article or photo.

This actor collects information from public pages. It does not log in and it does not bypass access controls.

For a longer explanation, see Apify's article [Is web scraping legal?](https://blog.apify.com/is-web-scraping-legal/).

# Actor input Schema

## `mode` (type: `string`):

What to scrape.

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

Store base URLs. One URL per line.

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

Optional search term passed to the Store API.

## `maxItems` (type: `integer`):

Stop after this many successful rows. Hard max is 1000.

## `requestDelaySecs` (type: `number`):

Seconds to wait between requests.

## `userAgent` (type: `string`):

User-Agent header sent with each request.

## `timeoutSecs` (type: `integer`):

Overall run budget in seconds.

## `requestTimeoutSecs` (type: `integer`):

Per-request timeout in seconds.

## `proxyConfiguration` (type: `object`):

Optional proxy. Leave off unless you need it.

## Actor input object example

```json
{
  "mode": "products",
  "storeUrls": [
    "https://woocommerce.com"
  ],
  "search": "",
  "maxItems": 100,
  "requestDelaySecs": 1,
  "userAgent": "ActorResearch/1.0",
  "timeoutSecs": 300,
  "requestTimeoutSecs": 30,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}
```

# Actor output Schema

## `overview` (type: `string`):

Dataset rows in the overview table.

## `dataset` (type: `string`):

Full dataset for this run.

## `items` (type: `string`):

Dataset items as JSON.

# 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://woocommerce.com"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("real-estate-api/woocommerce-store-api-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://woocommerce.com"] }

# Run the Actor and wait for it to finish
run = client.actor("real-estate-api/woocommerce-store-api-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://woocommerce.com"
  ]
}' |
apify call real-estate-api/woocommerce-store-api-products-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,real-estate-api/woocommerce-store-api-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/gJMghVP1aKPiBSsxe/builds/gDjHKkndR9gePLn4U/openapi.json