# WooCommerce Store Report: catalogue, prices, stock, reviews (`steadydata/woocommerce-store-report`) Actor

One report per WooCommerce store, up to 200 stores per run: the exact product count, price range and average, currency, share in stock, share on sale, categories, brands, average review rating, and ranked signals such as an empty catalogue or heavy discounting. Company data only, no personal data.

- **URL**: https://apify.com/steadydata/woocommerce-store-report.md
- **Developed by:** [Steadydata Team](https://apify.com/steadydata) (community)
- **Categories:** E-commerce, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.45 / 1,000 store reporteds

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 Report: catalogue, prices, stock, reviews

One report per WooCommerce store, **up to 200 stores per run**: the **exact** number of
products, the price range and average, the currency, how much is in stock, how much is on
sale, the categories and brands it sells, the review rating over the catalogue, and a short
list of signals that say what those numbers mean. You pay per delivered report.

### Why this scraper

- **The exact catalogue size, not an estimate.** WooCommerce returns the total in the
  `X-WP-Total` header, so a report can say "1,240 products, 100 scanned" instead of guessing
  from the page you happened to read. A Shopify catalogue cannot do that.
- **It reads the store's own Store API.** `/wp-json/wc/store/v1/products` is the endpoint
  WooCommerce publishes for its own storefront blocks: no key, no login, no browser. The
  store's own `robots.txt` is checked first, and a store that forbids it is skipped free of
  charge. Measured on 14-09-2026: woocommerce.com itself forbids it, so it is skipped.
- **Prices are handled correctly.** WooCommerce writes prices in minor units, so `"195"`
  with `currency_minor_unit: 2` means 1.95 and not 195. Getting that wrong makes a report a
  hundred times off; there is a test that pins it down.
- **It ends with a conclusion.** Every report carries `signals`: `mostly-out-of-stock`,
  `heavy-discounting`, `deep-discounts`, `no-reviews-at-all`, `well-reviewed-catalogue`,
  `tiny-catalogue`, `single-category-store`, `catalogue-larger-than-scanned`. Scanning 200
  stores becomes a sort on one column.
- **Reviews as a number, never as people.** You get the review count and the rating average,
  weighted by how many reviews each product has. No reviewer names, no customer data.
- **Only delivered reports are charged.** A site that is not WooCommerce, a store with no
  public products, a typo: free error records.

### Who this is for

Competitor and market research in e-commerce. Agencies qualifying WooCommerce merchants
before a pitch. Brand owners checking which resellers stock their products, and at what
price. Anyone tracking a list of stores over time to see which ones moved.

### Who this is not for

**Read this before you buy.**

- **WooCommerce only.** Shopify, Magento, BigCommerce or a custom shop answer 400 or 404 and
  come back as `NOT_WOOCOMMERCE`, free. For Shopify stores, use the Shopify Store Report
  instead; it is the same idea on the other platform.
- **One row per store, not one row per product.** You get the catalogue summarised plus a
  small sample of product names. If you need every product with every variant, this is the
  wrong tool.
- **Some WooCommerce stores switch the Store API off,** or sit behind a firewall that
  refuses datacenter traffic. Those come back as `NOT_WOOCOMMERCE` or `BLOCKED`, both free,
  after every proxy exit has been tried.
- **Prices are list prices in the store's own currency.** No tax handling, no currency
  conversion, and a price of zero is ignored rather than counted as the cheapest product.
- **Ratings come from the shop's own reviews.** A store with few reviews has a rating that
  says little; `reviewCount` and `ratedProductShare` are there so you can see that yourself.

### Input example

```json
{
    "stores": [
        "barefootbuttons.com",
        "porterandyork.com"
    ],
    "maxProductsScanned": 100,
    "sampleSize": 3
}
```

A domain or any URL on the store both work. `maxProductsScanned` is your cost and speed
lever; the exact product count comes from the store either way.

### Output example

```json
{
    "store": "porterandyork.com",
    "isWooCommerce": true,
    "productCount": 69,
    "productsScanned": 69,
    "currency": "USD",
    "priceMin": 9.0,
    "priceMax": 675.0,
    "priceAverage": 82.12,
    "priceMedian": 59.0,
    "inStockShare": 0.87,
    "onSaleShare": 0.014,
    "averageDiscountPercent": null,
    "variableProductShare": 0.391,
    "averageRating": null,
    "reviewCount": 0,
    "ratedProductShare": 0.0,
    "topCategories": ["Beef", "Steaks", "Seafood"],
    "topBrands": [],
    "productSample": ["Dry Aged Ribeye", "Filet Mignon", "Wagyu Burgers"],
    "signals": ["no-reviews-at-all"],
    "signalCount": 1,
    "robotsRule": "no robots.txt",
    "status": "ok"
}
```

Error codes: `INVALID_STORE`, `NOT_WOOCOMMERCE`, `NO_PRODUCTS`, `ROBOTS_DISALLOWED`,
`FETCH_FAILED`, `BLOCKED`. None of them are charged. `INPUT_TRUNCATED` appears once when your input is longer than this actor accepts.

### Related actors from steadydata

- woocommerce-products-catalog (publishing soon): every product of the same store instead of a summary
- [shopify-store-report](https://apify.com/steadydata/shopify-store-report): the same report for Shopify stores
- [website-tech-stack](https://apify.com/steadydata/website-tech-stack): confirm the platform and the rest of the stack
- [google-shopping](https://apify.com/steadydata/google-shopping): how the products appear in Google Shopping

### Pricing

Pay per event: one `store-reported` event per delivered report. No start fee, no separate
platform-usage surcharge, and no charge for a store that cannot be read.

**Free Apify plan:** this actor delivers up to 25 rows per run for accounts on the Apify free
plan, and then stops with a message. That limit is set by us, not by Apify. It exists so the
actor keeps paying for itself for the people who do pay. Any paid Apify plan runs it at full
size, billed per delivered row, with failed rows never charged.

**Reviews:** if this actor saves you time, a short review on this page is the one thing that
helps most. Ratings are what other buyers look at first, and we have no other way to ask.

### FAQ

**How do I know whether a store is WooCommerce before I run this?**
You do not have to: a store that is not WooCommerce costs nothing and says so in one word.
Put your whole list in and read the error records.

**What does `variableProductShare` tell me?**
How much of the catalogue has options such as size or colour. A high share means a clothing
or configurable catalogue; a low share means simple, single-variant products.

**Why is `averageDiscountPercent` empty on a store that has items on sale?**
Because the shop marked products as on sale without a higher regular price, so there is no
discount to compute. The share on sale is still reported.

**Is personal data collected?**
No. A shop's catalogue, prices, categories, brands and review counts are company
information. No reviewer names, no customer data, and nothing about people is requested.

**What happens when a store changes?**
Stores change, and so does WooCommerce. The actor is run against real stores daily and fixed
fast, and while it is broken you are not charged, because only delivered reports cost
anything.

# Changelog

This Actor's version history is a separate document: https://apify.com/steadydata/woocommerce-store-report/changelog.md

# Actor input Schema

## `stores` (type: `array`):

Store addresses, one per row, up to 200. A domain such as barefootbuttons.com or any URL on the store; the store's own robots.txt is checked before anything is read.

## `maxProductsScanned` (type: `integer`):

Cost and speed lever, 100 products per page. The exact catalogue size comes from the store itself, so the report is honest about how much was scanned.

## `sampleSize` (type: `integer`):

How many product names to include as a sample, 0 to leave them out.

## Actor input object example

```json
{
  "stores": [
    "barefootbuttons.com",
    "porterandyork.com"
  ],
  "maxProductsScanned": 100,
  "sampleSize": 5
}
```

# 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 = {
    "stores": [
        "barefootbuttons.com",
        "porterandyork.com"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("steadydata/woocommerce-store-report").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 = { "stores": [
        "barefootbuttons.com",
        "porterandyork.com",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("steadydata/woocommerce-store-report").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 '{
  "stores": [
    "barefootbuttons.com",
    "porterandyork.com"
  ]
}' |
apify call steadydata/woocommerce-store-report --silent --output-dataset

```

## MCP server setup

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

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/FvdIipD40iR8gwcG8/builds/ZWXUfjuRa5QP8yBtV/openapi.json