# Shopify Store Catalogue (`ikmal_suzali_atr/shopify-catalog`) Actor

Every product of any Shopify storefront — title, vendor, type, tags, prices, availability, images, variants (SKU, barcode, options) and, optionally, each product's position in every collection. Verifies the store is Shopify first. Dual-mode: the same code runs as an ATR BullMQ worker.

- **URL**: https://apify.com/ikmal\_suzali\_atr/shopify-catalog.md
- **Developed by:** [AtTheRate AI](https://apify.com/ikmal_suzali_atr) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.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

## Shopify Store Catalogue

Exports the entire product catalogue of any Shopify storefront: every product, every variant with SKU and barcode, and optionally each product's position inside every collection. It reads the public JSON that Shopify stores serve themselves, so no browser, no login and no proxy are needed. Point it at a domain such as allbirds.com and get a catalogue you can diff week over week.

### What you get

- One row per product with `title`, `vendor`, `product_type`, `tags`, `handle` and `product_url`.
- Price range from the variants: `price` (lowest), `price_max` (highest), `compare_at_price` and `currency`.
- Stock signal: `available` is true when at least one variant is buyable.
- Variant rows on request, with `sku`, `barcode`, `variant_title`, `option1` to `option3` and their own `price` and `available`.
- Collection structure on request: `collection_product` rows carry `collection`, `collection_title` and `position`, the order inside that collection.
- Catalogue freshness: `created_at`, `updated_at`, `published_at`, `image_url` and `images_count`.
- Every store is verified first, so a domain that is not Shopify is reported rather than guessed at.

### Input

Give it one or more store domains or URLs and choose how deep to go.

```json
{
  "stores": ["allbirds.com"],
  "includeCollections": true,
  "maxProducts": 500
}
```

- `stores` (required): domains or URLs such as "allbirds.com" or "gymshark.com".
- `includeCollections`: also emit one row per product per collection, with its position there.
- `collections`: optional collection handles, for example "mens-shoes", to pull only those.
- `includeVariants`: emit a row per variant with SKU, barcode and option values.
- `maxProducts` and `maxCollections`: caps per store. 0 means everything.
- `proxyConfiguration`: optional and off by default. Enable one only if a store rate-limits you.

### Output

One row per product, per variant, or per product-in-collection, tagged by `row_type`.

```json
{
  "row_type": "product",
  "store": "allbirds.com",
  "shop_name": "Allbirds",
  "product_id": "6612104773731",
  "handle": "mens-wool-runners",
  "title": "Men's Wool Runners",
  "vendor": "Allbirds",
  "product_type": "Shoes",
  "price": 98,
  "price_max": 110,
  "compare_at_price": 125,
  "currency": "USD",
  "available": true,
  "variants_count": 24,
  "images_count": 8,
  "product_url": "https://www.allbirds.com/products/mens-wool-runners",
  "updated_at": "2026-09-10T14:02:11-07:00",
  "fetched_at": "2026-09-12T10:41:02.118Z"
}
```

`currency` comes from the store's own metadata and is null when the store does not publish it. `compare_at_price` is null when nothing is on sale, and `position` is null on plain product rows: order only exists inside a collection.

### Use cases

- Competitor assortment tracking: diff today's product rows against last week's to see launches and delistings.
- Price and discount monitoring across a whole catalogue, using `price`, `price_max` and `compare_at_price`.
- Merchandising analysis: `collection`, `position` and `product_type` show what a brand pushes to the top.

### Notes and limits

- Products come 250 at a time and the actor pages through them, so several thousand products is still one run.
- A domain that is not Shopify, or whose product feed is switched off, is reported as not Shopify. Other stores continue and the run still succeeds.
- A password-protected store is reported as blocked rather than retried forever.
- The feed exposes only what the storefront publishes: no cost prices, no inventory counts, no sales figures.
- Live runs: allbirds.com returned 359 rows covering 30 products, 307 variants and 3 collections in about 70 seconds.

### FAQ

**Do I need a proxy?** No. The public Shopify JSON answers fine without one and the actor defaults to no proxy. Turn one on only if a store starts rate-limiting you.

**How many results can I get?** The whole catalogue. Products are fetched 250 per page up to 400 pages per store. Cap a run with `maxProducts` and `maxCollections`.

**Does it need a login or an API key?** No Shopify app, no admin API token and no store permissions.

**What happens if the site is not Shopify?** The store is verified first and reported as not Shopify, with the reason in the log. The rest of the run continues.

**How do I get category structure?** Set `includeCollections`. You get a `collection_product` row per product per collection with `position`, the store's own merchandised order.

# Actor input Schema

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

Shopify store URLs or domains, e.g. "allbirds.com" or "https://www.gymshark.com". Each is verified to be a Shopify storefront first; non-Shopify or password-protected stores are reported.

## `includeCollections` (type: `boolean`):

Also emit one row per product per collection with the product's position in that collection — the store's own category structure.

## `collections` (type: `array`):

Optional collection handles (e.g. "mens-shoes"). When set, only these collections are pulled.

## `includeVariants` (type: `boolean`):

Emit one row per variant (size/colour) with SKU, barcode, price and availability.

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

0 = all.

## `maxCollections` (type: `integer`):

0 = all. Large stores have hundreds of collections; cap this for a quick pull.

## `delayMs` (type: `integer`):

Pause between JSON page fetches (250 products each).

## `concurrency` (type: `integer`):

How many stores to process at once (1–4).

## `proxyConfiguration` (type: `object`):

Optional. Shopify's public JSON usually needs no proxy; enable one only if a store rate-limits you. On our own servers this is ignored.

## Actor input object example

```json
{
  "stores": [
    "allbirds.com"
  ],
  "includeCollections": false,
  "includeVariants": false,
  "maxProducts": 0,
  "maxCollections": 0,
  "delayMs": 500,
  "concurrency": 2,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}
```

# Actor output Schema

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

One row per product.

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

Counts for the run: what was requested, captured, skipped and failed.

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

// Run the Actor and wait for it to finish
const run = await client.actor("ikmal_suzali_atr/shopify-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 = { "stores": ["allbirds.com"] }

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

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,ikmal_suzali_atr/shopify-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/fGbXmWvDshBx0sErK/builds/XktsgbwxVMg0skWba/openapi.json