# Woocommerce Public Categories (`eichan/woocommerce-public-categories`) Actor

- **URL**: https://apify.com/eichan/woocommerce-public-categories.md
- **Developed by:** [Eichan Jolly](https://apify.com/eichan) (community)
- **Features:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$2.00 / 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.

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 Public Categories

Collect **up to 20 public product categories** from one WooCommerce store's open **Store API**: `/wp-json/wc/store/v1/products/categories`. For store owners, catalog auditors and analysts who want a small category inventory without a login or API key.

### Input

The prefilled example was publicly checked on **2026-11-01**: the endpoint returned a nonempty JSON category list with category ID, name, slug, count and parent ID.

```json
{"storeUrl":"https://www.cancork.com","limit":1}
```

The actor makes one request to `https://www.cancork.com/wp-json/wc/store/v1/products/categories?per_page=1`. `limit` is an integer from 1 through 20 (default 1). No pagination.

### Output (one item per category)

```json
{
  "storeUrl": "https://www.cancork.com",
  "categoryId": 3757,
  "name": "3D CompMold Cork Wall & Ceiling Panels",
  "slug": "3d-acoustic-wall-panels",
  "productCount": 12,
  "parentId": 3584,
  "status": "ok",
  "error": null
}
```

Each row contains `storeUrl`, `categoryId`, `name`, `slug`, `productCount`, `parentId`, `status`, and `error`. `productCount` is **the count reported by the API**, not a separately audited count; `parentId` is the API's `parent` field (0 may represent no parent). Errors produce one `status: "error"` row with null category-specific fields and a plain-language message.

### Limits and behavior

- Public HTTPS store base URL only; one same-host request to the open Store API; no login, keys, pagination, hidden taxonomy, or crawling. If installed under a WordPress subdirectory, include that base subpath.
- Not every WooCommerce store exposes Store API routes. A missing/blocked/empty response becomes an honest error item. No auth bypass or cross-host redirects.
- The endpoint may return a subset by store configuration, visibility and limit; categories or counts may change at any time. 15-second timeout and 2-MB response cap.
- The prefill was checked by a public web retrieval tool; **live execution from this Python environment was not possible** due to DNS restriction. Reproducible `python src/main.py` smoke runs use recorded fixture responses, not live HTTP, as documented in `tests/smoke_evidence.txt`.

### Running

On Apify, `INPUT` is fetched via the default key-value store REST API using `APIFY_DEFAULT_KEY_VALUE_STORE_ID` and `APIFY_TOKEN`; dataset items are posted through REST using `APIFY_DEFAULT_DATASET_ID`. Input priority: `ACTOR_INPUT_JSON`, then platform `INPUT`, then local `storage/key_value_stores/default/INPUT.json`. No Apify SDK.

Local: `ACTOR_INPUT_JSON='{"storeUrl":"https://www.cancork.com","limit":1}' python src/main.py` (requires internet). Offline replay: `python tests/run_smoke.py`. Unit tests: `python -m unittest discover -s tests -p 'test_*.py' -v`.

### Suggested Apify Store settings

Category `ECOMMERCE`; **$2 / 1,000 results** ($0.002 per result), proposed only. No publishing or billing is configured.

# Actor input Schema

## `storeUrl` (type: `string`):

Public WooCommerce store base URL. The Actor requests its /wp-json/wc/store/v1/products/categories endpoint.

## `limit` (type: `integer`):

Maximum number of categories requested from the public Store API (1–20).

## Actor input object example

```json
{
  "storeUrl": "https://woocommerce.com",
  "limit": 1
}
```

# Actor output Schema

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

Dataset containing the Actor's result items

# 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 = {
    "storeUrl": "https://woocommerce.com",
    "limit": 1
};

// Run the Actor and wait for it to finish
const run = await client.actor("eichan/woocommerce-public-categories").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 = {
    "storeUrl": "https://woocommerce.com",
    "limit": 1,
}

# Run the Actor and wait for it to finish
run = client.actor("eichan/woocommerce-public-categories").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 '{
  "storeUrl": "https://woocommerce.com",
  "limit": 1
}' |
apify call eichan/woocommerce-public-categories --silent --output-dataset

```

## MCP server setup

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

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/A8tHXsRDYrEMjne9m/builds/x8EvuydgwylCEVFcK/openapi.json
