# Shopify Reviews - Public Product Reviews (`bin_ai_tools/shopify-reviews`) Actor

Extract publicly visible Shopify product reviews from Judge.me-style widgets and Product JSON-LD. Pay only for successfully delivered review rows.

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

## Pricing

$1.00 / 1,000 shopify review 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 Reviews — Judge.me & Product JSON-LD (APIFY-032)

Collect **publicly displayed product-specific reviews** from supported Shopify product pages. No Shopify Admin API, customer account, cookies, CAPTCHA solving, or private review archive required.

### Quick start (one product, one minute)

1. Paste a **direct, current Shopify product URL**, for example:
   `https://sundaysproject.com/products/a5-journal-desk-edition`
2. Start with **one** URL; default maximum 100 visible reviews per product. For a slower public store, adjust `requestTimeoutSecs` up to 60.
3. Open **Output → Public review rows** (Dataset) or **Output → Run summary** (key-value record). Export rows as JSON or CSV.
4. A healthy page **without supported public reviews** reports `outcome=NO_SUPPORTED_PUBLIC_REVIEWS`, `skippedProducts>0`, `delivered=0`, `billed=0` and an explanation in `notices`. No review event is charged.
5. A fetch error or actual billing mismatch is reported distinctly as failure. A paid result is counted only after a successful Dataset write and a verified PPE charge receipt.

### Supported public sources

- Judge.me reviews **present in the returned product-page HTML**.
- `Product` / `ProductGroup` `Review` JSON-LD attached to the **requested product**.
- The page can redirect between its `www` and apex domain for **the same product**. Redirects to different products, websites, HTTP URLs, or private hosts are rejected.
- If Judge.me still uses an **old handle** after a merchant renames the product, the Actor accepts those reviews **only** when an extra public HEAD request verifies that handle redirects to the exact requested product, and the historical review title matches the current product's JSON-LD title. Otherwise those rows are excluded without charge.

**Not supported in this version:** store-wide testimonials not tied to a requested product, reviews rendered only after running JavaScript (including dynamically loaded Loox/Yotpo/Stamped pages without usable product JSON-LD), reviews behind pagination/login, and private or historical exports. Shopify is a platform, not a single review provider. Some valid Shopify products will return zero supported reviews.

### Input

- `productUrls` — 1–20 direct public Shopify `/products/<handle>` URLs; examples must point to the intended product, not a renamed product's old redirected URL.
- `maxReviewsPerProduct` — 1–1000, default 100, limited to reviews publicly present in the HTML.
- `includeImages` — default true.
- `requestTimeoutSecs` — 5–60 seconds, default 30, **per product**, including the full HTML body. For large/slow sites, 45–60 seconds may be required.
- Maximum HTML size: 8 MB; many stores expose only the first few reviews in their HTML.

### Output

One Dataset row per supported review: `storeDomain`, `productUrl`, `productHandle`, `productTitle`, `reviewId`, `rating`, `title`, `body`, `reviewerName`, `reviewDate`, `verifiedBuyer`, `helpfulVotes`, `images`, `sourceProvider`.

Run summary contains `outcome`, `processedProducts`, `succeededProducts`, `skippedProducts`, `failedProducts`, `delivered`, `billed`, `billingFailures`, `notices` and `failures`. Missing/unsupported public reviews are **not invented**.

### Pay-per-event billing

Event: `review-result`, one event for each delivered review row when the corresponding monetization configuration is active. `delivered` must equal the confirmed SDK `chargedCount`; a mismatch causes the Run to fail instead of billing misleading results. Empty, unsupported and unsuccessful inputs create no review charge. Compute usage can still incur platform costs.

### Data and usage boundary

Only publicly presented Shopify product-page material. Never bypass a store login, robots restrictions, rate limits, WAF or other access controls. No checkout/payment automation. This Actor is not a full-store review export and cannot guarantee review coverage across all Shopify review apps.

# Actor input Schema

## `productUrls` (type: `array`):

1–20 direct public Shopify product URLs. Only reviews exposed in Judge.me page HTML or product-linked JSON-LD are supported; dynamic widgets may return zero rows.

## `maxReviewsPerProduct` (type: `integer`):

Maximum public review rows emitted from each supplied product page.

## `includeImages` (type: `boolean`):

Include publicly exposed review image URLs when present.

## `requestTimeoutSecs` (type: `integer`):

Complete HTML request timeout per product (including body). Slow stores may need 45–60 seconds; start with one URL.

## Actor input object example

```json
{
  "productUrls": [
    "https://sundaysproject.com/products/a5-journal-desk-edition"
  ],
  "maxReviewsPerProduct": 100,
  "includeImages": true,
  "requestTimeoutSecs": 30
}
```

# Actor output Schema

## `reviews` (type: `string`):

Reviews collected from public Shopify product pages in the default Dataset.

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

Delivered, billed, and failed public review counts in the default key-value store.

# 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("bin_ai_tools/shopify-reviews").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("bin_ai_tools/shopify-reviews").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 bin_ai_tools/shopify-reviews --silent --output-dataset

```

## MCP server setup

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

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/a8OKdSva2vG94ghBz/builds/Wd3bpqxxT0q73ijkR/openapi.json