# Shopify Public Catalog (`hearthkit/shopify-public-catalog`) Actor

Public Shopify /products.json catalogs: titles, prices, variants, SKUs, availability. Password pages fail closed. Set maxProducts=0 for the whole catalog.

- **URL**: https://apify.com/hearthkit/shopify-public-catalog.md
- **Developed by:** [Jeramy Udy](https://apify.com/hearthkit) (community)
- **Categories:**
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per event

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?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.
Actors are written with capital "A".

## 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.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Shopify Public Catalog

Pull a public Shopify store's product catalog from `/products.json`.

### Input

- `shopUrl` — store origin or hostname (`https://www.allbirds.com`)
- `maxProducts` — optional cap. `0` or omit (in API) = entire catalog. Store auto-test default is 10 so the daily health check stays short.

### Output (one dataset item per product)

title, handle, product URL, vendor, type, tags, image, variant count, min/max price, variants (id, sku, price, compare-at, availability).

No `body_html`. Missing fields stay missing. Password pages, 401/403, and non-JSON fail closed.

### Pricing

- `product-processed` — one charge per product
- `apify-actor-start` — small per-run fee

Default dataset items are not billed separately.

### Limits

Localhost and private IPs rejected. Daily auto-test uses Allbirds with 10 products.

# Actor input Schema

## `shopUrl` (type: `string`):

Public Shopify store origin or hostname. Example: https://www.allbirds.com

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

How many products to return. 0 = entire catalog. Default 10 is only for Apify's daily auto-test.

## Actor input object example

```json
{
  "shopUrl": "https://www.allbirds.com",
  "maxProducts": 10
}
```

# 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 = {
    "shopUrl": "https://www.allbirds.com",
    "maxProducts": 0
};

// Run the Actor and wait for it to finish
const run = await client.actor("hearthkit/shopify-public-catalog").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 = {
    "shopUrl": "https://www.allbirds.com",
    "maxProducts": 0,
}

# Run the Actor and wait for it to finish
run = client.actor("hearthkit/shopify-public-catalog").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 '{
  "shopUrl": "https://www.allbirds.com",
  "maxProducts": 0
}' |
apify call hearthkit/shopify-public-catalog --silent --output-dataset

```

## MCP server setup

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

```

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/8VXavGUdhXWPUgujT/builds/fI09XPvMUbfyVdUv1/openapi.json