# Shopify Catalog Auditor – Product & Variant QA (`afkdigital/shopify-public-catalog-auditor`) Actor

Audit product and variant data quality on Shopify stores you own or are authorized to assess. Find missing fields and document catalog coverage without bypassing access restrictions.

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

## Pricing

$2.00 / 1,000 product auditeds

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 Public Catalog Auditor

Permission-first catalog QA. Authorized merchant use only. See Shopify terms: https://www.shopify.com/legal/api-terms

### Purpose

For the operator's own store or a store with express permission, audit public product titles, product/variant IDs, options, source-exposed SKU, price, currency, compare-at price, and image links. No price-change alerts, stock inference, image files, personal profiles, login, proxy, or CAPTCHA.

### Source modes

- mock_shop: Shopify's official fictional test catalogs on \*.mock.shop, without a token.
- storefront_api: Shopify official Storefront API 2026-07 with a merchant-provided scoped token.
- public_json: permitted store's /products.json best-effort only; robots.txt and access restrictions are checked. Never a guaranteed complete export.

### User input

storeUrl (HTTPS origin), sourceMode, maxProducts (1-250), maxPages (1-30), authorizationConfirmed (required for live stores), storefrontToken (secret input for the Storefront API).

### Legal and operational restrictions

Shopify API terms updated on October 7, 2026 prohibit systematic or unauthorized scraping and limit data use. Live-store operators must verify current Shopify terms, merchant terms, and authorization before running. Checkbox attestation is not legal proof; robots.txt is a technical policy check, not a legal license. Denied, rate-limited, and restricted shops produce a coverage/error summary; no access-bypass method is used.

### Example demo

Use storeUrl https://candles.mock.shop, sourceMode mock_shop, maxProducts 4, maxPages 2.

### Dataset

Each variant row contains recordType, storeUrl, sourceUrl, catalogUrl, productId, variantId, title, variantTitle, options, optionSummary, sku (when exposed), price, currency (when exposed), compareAtPrice, imageUrl (link only), warnings, warningCount, and retrievedAt. No image binaries are downloaded.

The final audit_summary row reports status (complete, partial, blocked), coverageStatus, product/variant counts, pages, bytes, duration, errors, and limitations. GraphQL can expose a maximum of 50 variants per product in the initial page; further variants are flagged as a partial result, not silently omitted.

### Tests

Official Shopify demo catalogs at candles.mock.shop and coffee.mock.shop were queried: 4 products and 24 variants each. Product caps correctly gave partial coverage. An offline simulated 403 response was blocked with zero products. Run npm test or npm run probe.

### Pricing

Proposed $0.002 per successfully delivered product, not per variant. Apify actor-start event may add $0.00005 per run. Billing must be configured and tested before activation. See PRICING.md.

References: https://shopify.dev/docs/storefronts/headless/mock-shop ; https://shopify.dev/docs/api/storefront/2026-07 ; https://docs.apify.com/actors/publishing/monetize/pay-per-event

### Source and scope warning

Shopify's API terms may prohibit systematic automated extraction even with a merchant's permission; merchant consent and robots.txt alone do not override platform restrictions. Obtain appropriate Shopify authorization for any audit that would otherwise be restricted. This Actor is not a generalized scrape-any-Shopify-store product index. The synthetic demo mode is available without merchant credentials; real-shop usage remains permission and terms constrained.

A successful end-of-page indication proves completeness only within the published products returned by the chosen API and current credentials. Out-of-channel items, unexposed metadata, and variant pages beyond the initial supported variant connection are explicitly outside the guaranteed scope. Duplicate source products and invalid responses receive partial-coverage warnings.

# Actor input Schema

## `storeUrl` (type: `string`):

Origin only, e.g. https://candles.mock.shop or a shop's own authorized domain.

## `sourceMode` (type: `string`):

Public JSON mode is not a universal API, and must only be used where the merchant and applicable terms expressly allow automation.

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

Upper bound on unique products for this run. The real catalog may be larger.

## `maxPages` (type: `integer`):

Stops after this many product result pages, potentially with partial coverage.

## `authorizationConfirmed` (type: `boolean`):

Required for live Shopify sources. You own/administer the shop or hold express permission to automate its catalog and comply with Shopify and merchant terms.

## `storefrontToken` (type: `string`):

Required only for the live Storefront API mode; never printed to logs or results. Prefer a public Storefront access token with minimum permissions.

## Actor input object example

```json
{
  "storeUrl": "https://candles.mock.shop",
  "sourceMode": "mock_shop",
  "maxProducts": 20,
  "maxPages": 4,
  "authorizationConfirmed": false
}
```

# Actor output Schema

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

Variant records followed by a coverage record that states whether the catalog was only partially accessible.

# 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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("afkdigital/shopify-public-catalog-auditor").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 = {}

# Run the Actor and wait for it to finish
run = client.actor("afkdigital/shopify-public-catalog-auditor").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 '{}' |
apify call afkdigital/shopify-public-catalog-auditor --silent --output-dataset

```

## MCP server setup

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

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/6REc4iPOh6zBu36ON/builds/tmLVRgQAXmfkmI87V/openapi.json