# WooCommerce Public Catalog & Price Change API (`soilair/woocommerce-public-catalog-change-api`) Actor

Export public WooCommerce products with exact decimal prices, stock flags, stable hashes and repeat-run change labels. Explicit pagination and budget coverage.

- **URL**: https://apify.com/soilair/woocommerce-public-catalog-change-api.md
- **Developed by:** [Salih Can Kurnaz](https://apify.com/soilair) (community)
- **Categories:** E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 product observations

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 Catalog & Price Change API

Export public product observations for supplier catalogs, price monitoring and e-commerce integrations. Returns exact decimal strings, availability flags, product images/categories, stable hashes and changes against your previous observation. Uses the unauthenticated WooCommerce Store API. No admin credentials or paid upstream key.

### Quick start

```json
{"storeUrls": ["https://porterandyork.com"], "maxProductsPerStore": 5}
```

This public example was tested at publication, but a third-party store may change or restrict access. Use your own authorized store for reliable integrations. Enter the WordPress installation URL, including its subdirectory when applicable. Download the default dataset as JSON, CSV or Excel. Inspect OUTPUT for source errors, pagination and completeness.

### Repeat-run monitoring

1. Save the previousHashes object from the SNAPSHOT key-value record.
2. Include it as previousHashes in the next input.
3. Rows have NO_BASELINE when no baseline was supplied, FIRST_SEEN when absent from a supplied baseline, UNCHANGED when the hash matches, and CHANGED otherwise.

Hashes cover normalized name, SKU, type, prices, stock/purchasability/sale flags, URLs, images, categories and attributes. They exclude request page and observation timestamp. CHANGED is not exclusively a price change. FIRST_SEEN does not prove a product was newly listed. Only successfully emitted rows are included in SNAPSHOT. An incomplete snapshot cannot establish deletions. Do not interpret missing rows as removed products.

### Prices and catalog coverage

Prices are exact strings normalized using currency_minor_unit, such as 1105 -> 11.05 for a two-decimal currency. Original currency and minor-unit precision are retained. Currency may depend on store/plugin configuration; there is no exchange conversion or checkout-price guarantee. Variable products are parent observations; public price_range is preserved when present. This is not a complete variant exporter. Stock flags are not exact inventory quantities. No sales, revenue or future inventory inference is performed.

Only visible products from /wp-json/wc/store/v1/products are queried; password-protected products are skipped. At most three stores, five pages of twenty products each and 100 returned observations per store. Pagination follows ascending product ID; duplicate IDs are not charged twice. The source can change during a run. OUTPUT.complete means the observed public query ended without truncation, protected records, pagination instability or errors; it is not proof of the store's full private catalog. A cap produces PRODUCT_LIMIT or PAGE_LIMIT. Unavailable or denied sources produce errors without bypassing access restrictions. A legitimate empty catalog can succeed with zero result events.

### Pricing

$0.001 per emitted product observation ($1 per 1,000), plus a $0.005 Actor-start event for the default 256 MB run. Higher memory can multiply the start-event count according to Apify rules. Sources that fail incur no result event; startup can still apply. Inspect effective Store pricing before running. Event-only pricing includes platform usage. Budget truncation reports PARTIAL_BUDGET and complete=false. No external API, proxy or browser fees.

### Access and resource bounds

Public HTTP(S), ports 80/443 only. Embedded credentials and private DNS addresses are rejected. Validated IPs are pinned while TLS hostname checks remain enabled. Up to five redirects, a 2 MiB decoded response limit and approximately 95 seconds network budget. robots.txt is respected; unavailable or blocking robots policy is a source error. No private REST API, login, cookies, cart, order, review-text or customer endpoint is accessed. HTML fallback, proxy rotation and blocking workarounds are not used. Image and product URLs are returned without being fetched. Respect source terms and data rights.

### API and integration

POST https://api.apify.com/v2/actors/soilair~woocommerce-public-catalog-change-api/runs with your own Apify authorization header and the input JSON. Poll the returned run ID and retrieve its defaultDatasetId. OUTPUT and SNAPSHOT are in the run's default key-value store. You can configure schedules and integrations in Apify Console; this Actor creates neither. Carry previousHashes yourself; no hidden persistent baseline is used.

### Data and support

Inputs and outputs stay in your Apify run storage under its retention settings. Requests go only to your public store inputs and their redirects/robots policy URLs. No separate customer-data or analytics endpoint is used. Do not submit secrets. Developed with AI assistance. Fixtures, real public-source observations and Apify cloud runs verify documented examples, not universal compatibility. Report a run ID and expected behavior through the issue tab without credentials.

Reference: https://developer.woocommerce.com/docs/apis/store-api/resources-endpoints/products/

# Actor input Schema

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

Public installation roots, including a subdirectory if WordPress is installed there. No admin URL, API endpoint, credentials or query string.

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

A cap is not complete catalog coverage. At most five pages of twenty products per store.

## `previousHashes` (type: `object`):

Paste previousHashes from the previous SNAPSHOT. At most 2000 itemKey to lowercase SHA256 entries. No credentials or customer data.

## Actor input object example

```json
{
  "storeUrls": [
    "https://porterandyork.com"
  ],
  "maxProductsPerStore": 50,
  "previousHashes": {}
}
```

# Actor output Schema

## `results` (type: `string`):

No description

## `summary` (type: `string`):

No description

## `snapshot` (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://porterandyork.com"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("soilair/woocommerce-public-catalog-change-api").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://porterandyork.com"] }

# Run the Actor and wait for it to finish
run = client.actor("soilair/woocommerce-public-catalog-change-api").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://porterandyork.com"
  ]
}' |
apify call soilair/woocommerce-public-catalog-change-api --silent --output-dataset

```

## MCP server setup

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

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/dWu1zHzc29JKxN11d/builds/7cB5BuFXfivOe9Gcd/openapi.json
