# Shopify Public Variants (`eichan/shopify-public-variants`) Actor

- **URL**: https://apify.com/eichan/shopify-public-variants.md
- **Developed by:** [Eichan Jolly](https://apify.com/eichan) (community)
- **Features:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 33.3% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$3.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 Public Variants

Read **one public Shopify product page URL** and obtain the variants directly from its public `<product>.js` JSON representation. No Shopify account, private token, or Admin API is required. Designed for merchants, catalog QA teams, and product-data researchers checking one known item.

### Input

The prefilled working example was publicly checked on **2026-11-01**: the `.js` endpoint responded with a nonempty variants list.

```json
{"productUrl":"https://www.allbirds.com/products/mens-wool-runners"}
```

The actor requests `https://www.allbirds.com/products/mens-wool-runners.js` once. A `?variant=` selection on the page URL is ignored because this Actor reports **all** variants in the published representation, not just one selected variant.

### Output (one item per variant)

```json
{
  "productTitle": "Men's Wool Runner - Natural Grey (Light Grey Sole)",
  "productUrl": "https://www.allbirds.com/products/mens-wool-runners",
  "variantId": 31338073981072,
  "variantTitle": "8",
  "price": 11000,
  "compareAtPrice": null,
  "available": false,
  "sku": "WR3MNCW080",
  "status": "ok",
  "error": null
}
```

Each row has `productTitle`, `productUrl`, `variantId`, `variantTitle`, `price`, `compareAtPrice`, `available`, `sku`, `status`, and `error`. A failure produces a single `status: "error"` dataset item with an understandable `error` string and null variant-specific fields.

**Price units:** `price` and `compareAtPrice` are returned **exactly as published in the Shopify `.js` JSON**. Shopify commonly returns integer minor units (e.g. `11000` for 110.00 in a two-decimal currency). This Actor does **not** convert the value or infer/display a currency. Availability is the published boolean, **not** an inventory count; no stock quantity is inferred. `compareAtPrice`/`sku` may be null.

### Limits and behavior

- One public HTTPS product URL with `/products/HANDLE`; one same-host JSON request; no login, scraping search results, pagination or other store URLs.
- Some Shopify stores disable `.js`, change their storefront paths, require geo-validation, or block automated requests. A missing/malformed response becomes an honest error item. No browser automation, authentication, bypasses or cross-host redirects.
- Publishes every variant in the response (no invented variants). Each result reflects the store **at request time**, not historical stock. Responses are limited to 4 MB and 15 seconds.
- The prefill was checked by a public web retrieval tool; **live execution from this Python environment was not possible** due to DNS restriction. Reproducible `python src/main.py` smoke runs use recorded fixture responses, not live HTTP, as documented in `tests/smoke_evidence.txt`.

### Running

On Apify, `INPUT` is fetched through its default key-value store REST API using `APIFY_DEFAULT_KEY_VALUE_STORE_ID` and `APIFY_TOKEN`; results are posted to the default dataset via REST (`APIFY_DEFAULT_DATASET_ID`). `ACTOR_INPUT_JSON` takes precedence, then platform input, then local `storage/key_value_stores/default/INPUT.json`. No Apify SDK is needed.

Local: `ACTOR_INPUT_JSON='{"productUrl":"https://www.allbirds.com/products/mens-wool-runners"}' python src/main.py` (requires internet). Offline replay: `python tests/run_smoke.py`. Unit tests: `python -m unittest discover -s tests -p 'test_*.py' -v`.

### Suggested Apify Store settings

Category `ECOMMERCE`; **$3 / 1,000 results** ($0.003 per result), proposed only. No publishing or billing is configured.

# Actor input Schema

## `productUrl` (type: `string`):

Public Shopify product page URL, including /products/HANDLE. The Actor requests the same-host .js representation.

## Actor input object example

```json
{
  "productUrl": "https://www.allbirds.com/products/mens-wool-runners"
}
```

# Actor output Schema

## `dataset` (type: `string`):

Dataset containing the Actor's result items

# 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 = {
    "productUrl": "https://www.allbirds.com/products/mens-wool-runners"
};

// Run the Actor and wait for it to finish
const run = await client.actor("eichan/shopify-public-variants").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 = { "productUrl": "https://www.allbirds.com/products/mens-wool-runners" }

# Run the Actor and wait for it to finish
run = client.actor("eichan/shopify-public-variants").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 '{
  "productUrl": "https://www.allbirds.com/products/mens-wool-runners"
}' |
apify call eichan/shopify-public-variants --silent --output-dataset

```

## MCP server setup

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

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/M3daWmoTarXZ8wqdw/builds/Sf4eDNbFA6iFMGidt/openapi.json
