# Shopify product API: prices and variants (`hadi.kanj/shopify-catalog-proof`) Actor

Extract products, variants, prices, stated stock and image URLs from public Shopify catalogs. Start with one store and inspect completeness. Demo: https://market-data-gateway-production-2084.up.railway.app/launch/shopify-catalog-proof

- **URL**: https://apify.com/hadi.kanj/shopify-catalog-proof.md
- **Developed by:** [Hadi Kanj](https://apify.com/hadi.kanj) (community)
- **Categories:** E-commerce
- **Security:** 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 observed 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

## Shopify Catalog Proof — Products & Change Monitor

Export public Shopify catalogues with variants, prices, sale discounts, stock availability, descriptions and image URLs. Schedule repeat runs to detect restocks, sold-out variants, price changes, new products and confirmed removals.

### Quick start

1. Enter one or more Shopify store homepage URLs.
2. Set a maximum product count and maximum run cost.
3. Run and download the dataset as JSON, CSV or Excel.
4. Open **Scan completeness** to check whether each catalogue was fully scanned.

```json
{"stores":["https://www.allbirds.com"],"maxProducts":1000,"stateKey":"competitors","onlyChanges":false}
```

### What makes the change monitor useful

Product and variant IDs drive comparisons. A short page does not prove completeness: the scanner continues until an empty page. Failed, blocked, repeated or capped pagination is explicitly incomplete. Incomplete scans never mark products removed or replace a complete baseline. A budget-limited run also preserves the previous baseline. History is kept separately for every Apify user and monitor name.

The first run returns `BASELINE` records. Repeat the same input with the same `stateKey` to compare. Set `onlyChanges` to suppress unchanged output; **every observed product is still charged**, including unchanged products. A complete scan of an empty catalogue may confirm removals from a prior complete baseline. Changing the maximum product count can prevent baseline updates if the scan becomes capped.

### Output

Each product includes `id`, `store`, `url`, `title`, `vendor`, `productType`, `tags`, plain-text `description`, `images`, publication/update timestamps, `variants`, `evidenceUrl`, `observedAt`, `baselineAt` and `changes`.

Variants include stable IDs, SKU, barcode, option values, numeric `price`, `compareAtPrice`, discount percentage and `available` (true, false or null). No inventory quantity is inferred from availability. Images are original URLs; this Actor does not download or license image files.

Change types include `BASELINE`, `NEW_PRODUCT`, `NEW_VARIANT`, `REMOVED_VARIANT`, `PRICE_CHANGED`, `RESTOCK`, `SOLD_OUT`, `CONTENT_CHANGED`, `VARIANT_CHANGED` and `REMOVED_PRODUCT`. Removal rows have `recordType: "REMOVAL"`.

`SUMMARY` contains each store's status, completeness, pages fetched, observed products, baseline update state and error, plus output count and budget-stop status. Read this even if the dataset is empty. A successful Actor run does not guarantee that every store was accessible.

### API integration

Use your own Apify token. Never share it in public code.

```bash
curl -X POST 'https://api.apify.com/v2/acts/hadi.kanj~shopify-catalog-proof/run-sync-get-dataset-items' \
  -H "Authorization: Bearer $APIFY_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"stores":["https://www.allbirds.com"],"maxProducts":1000}'
```

For larger catalogues, start an asynchronous run with `/runs`, poll its status and retrieve its `defaultDatasetId` and `defaultKeyValueStoreId`. Schedule daily runs in Apify with an unchanged monitor name to build history.

### Limits and honest data handling

Up to 20 stores and 10,000 products per store. Only public, unauthenticated feeds are supported. Headless stores, password-protected shops, robots restrictions or merchant firewalls may prevent extraction. No login, proxies, browser rendering or bypass is included. HTTP failures and invalid feeds are reported in the summary.

The public products feed does not establish currency; `currency` is null rather than guessed. Prices use the store's denomination. Stock means the feed's advertised availability, not exact inventory. This is a snapshot, not a reservation or checkout quote. Source timestamps may change while pagination runs; no public feed provides transactional consistency across pages. Recheck the store before a purchasing decision.

### Pricing

The Store pricing panel is authoritative. Billing is per observed product, including unchanged checks; variant rows are included within that product. Confirmed removal rows and unsuccessful fetches do not trigger product charges. Use **Maximum cost per run** to control spending. Platform usage is included when the pricing panel specifies it.

### Support

Open an issue on this Actor with the store URL, run ID and unexpected result. Do not include API tokens or private credentials.

# Actor input Schema

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

HTTPS homepage URLs, without collection or product paths. Up to 20 stores.

## `maxProducts` (type: `integer`):

A capped scan is marked incomplete and cannot replace a monitoring baseline.

## `stateKey` (type: `string`):

Use the same name for scheduled runs. History is isolated per Apify user.

## `onlyChanges` (type: `boolean`):

Suppress unchanged rows. Every observed product is still charged because it is checked. First complete run establishes a baseline.

## Actor input object example

```json
{
  "stores": [
    "https://www.allbirds.com"
  ],
  "maxProducts": 1000,
  "stateKey": "default",
  "onlyChanges": false
}
```

# Actor output Schema

## `products` (type: `string`):

Product records and confirmed removals, exportable as JSON, CSV or Excel.

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

Per-store status, observed counts, errors and baseline update state.

# 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": [
        "https://www.allbirds.com"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("hadi.kanj/shopify-catalog-proof").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": ["https://www.allbirds.com"] }

# Run the Actor and wait for it to finish
run = client.actor("hadi.kanj/shopify-catalog-proof").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": [
    "https://www.allbirds.com"
  ]
}' |
apify call hadi.kanj/shopify-catalog-proof --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,hadi.kanj/shopify-catalog-proof"
        }
    }
}
```

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/QateIcC0rgK5d3T0c/builds/SK8fdDHPY80mRGceP/openapi.json