# Shopify Scraper (GraphQL) (`runexes/actor-shopify-scraper`) Actor

An Apify actor that crawls Shopify stores via `sitemap.xml` and fetches product data using the Storefront GraphQL API. Optimized for speed and cost with per-host batching, incremental processing, and buffered dataset writes.

- **URL**: https://apify.com/runexes/actor-shopify-scraper.md
- **Developed by:** [Alex](https://apify.com/runexes) (community)
- **Categories:** E-commerce, Automation, Open source
- **Stats:** 16 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## 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 Scraper (GraphQL)

An Apify actor that crawls Shopify stores via `sitemap.xml` and fetches product data using the Storefront GraphQL API. Optimized for speed and cost with per-host batching, incremental processing, and buffered dataset writes.

#### Features

- Reads `sitemap.xml`, filters product URLs (`/products/<handle>`)
- Batches GraphQL requests per store using aliases (fewer round-trips)
- Optional incremental runs (skips already processed product IDs)
- Optional lastmod cutoff to skip old products
- Outputs a single record per product; all variants are available under `additional.variants`
- Extensible via `extendScraperFunction` and `extendOutputFunction`

#### Input parameters (core)

- `startUrls`: array of `sitemap.xml` URLs
- `storefrontApiVersion`: Storefront API version (e.g., `2024-07`)
- `storefrontAccessToken`: your Storefront access token
- `maxRequestsPerCrawl`, `maxConcurrency`, `maxRequestRetries`, `proxyConfig`, `debugLog`

#### Performance inputs

- `updatedSince`: ISO date; skips products with `<lastmod>` older than this
- `batchSize`: product handles per GraphQL request (default 10)
- `flushIntervalMs`: max delay before sending a partial batch (default 300)
- `perHostConcurrency`: parallel GraphQL requests per store (default 2)
- `bufferWrites`: buffer dataset writes (default true)
- `bufferSize`: items per dataset push (default 100)

#### Run locally

1. Install dependencies:

```bash
npm install
```

2. Create local input at `apify_storage/key_value_stores/default/INPUT.json`, for example:

```json
{
  "startUrls": [{ "url": "https://example.com/sitemap.xml" }],
  "storefrontApiVersion": "2024-07",
  "storefrontAccessToken": "<YOUR_STOREFRONT_TOKEN>",
  "maxRequestsPerCrawl": 50,
  "maxConcurrency": 10,
  "debugLog": true
}
```

3. Start the actor:

```bash
npm start
```

Or development mode with auto-restart:

```bash
npm run dev
```

#### GitHub integration

Workflows in `.github/workflows/`:

- `ci.yml`: install, lint, and syntax check on push/PR to `main`.
- `codeql.yml`: CodeQL security analysis on push/PR and weekly.

#### Docker quick start

```bash
make init   # creates .env and INPUT.json from templates
make run    # docker compose up --build actor
```

Outputs will be in `apify_storage/datasets/default`.

#### Extensibility

- `extendScraperFunction`: lifecycle hooks (`SETUP`, `FILTER_SITEMAP_URL`, `PRENAVIGATION`, `POSTNAVIGATION`, `RUN`, `FINISHED`)
- `extendOutputFunction`: transform/filter final records before they are saved to the Dataset

#### License

This project is licensed under the Apache License 2.0. See `LICENSE` and `NOTICE`.

# Actor input Schema

## `startUrls` (type: `array`):

Provide sitemap.xml URLs as the starting point

## `maxRequestsPerCrawl` (type: `integer`):

Maximum number of items to scrape. Set it to 0 to scrape everything.

## `proxyConfig` (type: `object`):

Use either automatic Apify proxies, Residentials or your own.

## `extendOutputFunction` (type: `string`):

Add or remove properties on the output object or omit the output returning null

## `extendScraperFunction` (type: `string`):

Advanced function that allows you to extend the default scraper functionality, allowing you to manually perform actions on the page

## `customData` (type: `object`):

Any data that you want to have available inside the Extend Output/Scraper Function

## `maxConcurrency` (type: `integer`):

Max concurrency to use

## `maxRequestRetries` (type: `integer`):

Set the max request retries

## `updatedSince` (type: `string`):

Skip products older than this date based on sitemap <lastmod>.

## `batchSize` (type: `integer`):

Number of product handles to fetch per GraphQL request (per store)

## `flushIntervalMs` (type: `integer`):

Maximum time to wait before sending a partial batch

## `perHostConcurrency` (type: `integer`):

Parallel GraphQL requests per store

## `bufferWrites` (type: `boolean`):

Accumulate items in memory and push in batches

## `bufferSize` (type: `integer`):

Number of items to accumulate before pushing

## `storefrontApiVersion` (type: `string`):

Version of Shopify Storefront API (e.g. 2024-07)

## `storefrontShopDomain` (type: `string`):

Full origin for Storefront API calls, e.g. https://your-shop.myshopify.com. If empty, the scraper will use the product site origin.

## `storefrontAccessToken` (type: `string`):

Shopify Storefront API access token

## `debugLog` (type: `boolean`):

Enable a more verbose logging to be able to understand what's happening during the scraping

## Actor input object example

```json
{
  "startUrls": [
    {
      "url": "https://www.decathlon.com/sitemap.xml"
    }
  ],
  "maxRequestsPerCrawl": 10,
  "proxyConfig": {
    "useApifyProxy": true
  },
  "extendOutputFunction": "async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => {\n  return item;\n}",
  "extendScraperFunction": "async ({ fns, customData, Apify, label }) => {\n \n}",
  "customData": {},
  "maxConcurrency": 10,
  "maxRequestRetries": 3,
  "updatedSince": "",
  "batchSize": 10,
  "flushIntervalMs": 300,
  "perHostConcurrency": 2,
  "bufferWrites": true,
  "bufferSize": 100,
  "storefrontApiVersion": "2024-07",
  "storefrontShopDomain": "",
  "storefrontAccessToken": "",
  "debugLog": false
}
```

# 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 = {
    "startUrls": [
        {
            "url": "https://www.decathlon.com/sitemap.xml"
        }
    ],
    "maxRequestsPerCrawl": 10,
    "proxyConfig": {
        "useApifyProxy": true
    },
    "extendOutputFunction": async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => {
      return item;
    },
    "extendScraperFunction": async ({ fns, customData, Apify, label }) => {
     
    },
    "customData": {},
    "maxConcurrency": 10,
    "maxRequestRetries": 3,
    "updatedSince": "",
    "batchSize": 10,
    "flushIntervalMs": 300,
    "perHostConcurrency": 2,
    "bufferSize": 100,
    "storefrontApiVersion": "2024-07",
    "storefrontShopDomain": "",
    "storefrontAccessToken": ""
};

// Run the Actor and wait for it to finish
const run = await client.actor("runexes/actor-shopify-scraper").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 = {
    "startUrls": [{ "url": "https://www.decathlon.com/sitemap.xml" }],
    "maxRequestsPerCrawl": 10,
    "proxyConfig": { "useApifyProxy": True },
    "extendOutputFunction": """async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => {
  return item;
}""",
    "extendScraperFunction": """async ({ fns, customData, Apify, label }) => {
 
}""",
    "customData": {},
    "maxConcurrency": 10,
    "maxRequestRetries": 3,
    "updatedSince": "",
    "batchSize": 10,
    "flushIntervalMs": 300,
    "perHostConcurrency": 2,
    "bufferSize": 100,
    "storefrontApiVersion": "2024-07",
    "storefrontShopDomain": "",
    "storefrontAccessToken": "",
}

# Run the Actor and wait for it to finish
run = client.actor("runexes/actor-shopify-scraper").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 '{
  "startUrls": [
    {
      "url": "https://www.decathlon.com/sitemap.xml"
    }
  ],
  "maxRequestsPerCrawl": 10,
  "proxyConfig": {
    "useApifyProxy": true
  },
  "extendOutputFunction": "async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => {\\n  return item;\\n}",
  "extendScraperFunction": "async ({ fns, customData, Apify, label }) => {\\n \\n}",
  "customData": {},
  "maxConcurrency": 10,
  "maxRequestRetries": 3,
  "updatedSince": "",
  "batchSize": 10,
  "flushIntervalMs": 300,
  "perHostConcurrency": 2,
  "bufferSize": 100,
  "storefrontApiVersion": "2024-07",
  "storefrontShopDomain": "",
  "storefrontAccessToken": ""
}' |
apify call runexes/actor-shopify-scraper --silent --output-dataset

```

## MCP server setup

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

```

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/LaYgCatBrXfT8aEAD/builds/5xO0cwEorwXbj4QdI/openapi.json