# ShopWSS Product Scraper (`daftvader/shopwss-scraper`) Actor

Export complete ShopWSS product catalog records to a dataset.

- **URL**: https://apify.com/daftvader/shopwss-scraper.md
- **Developed by:** [Sam Towers](https://apify.com/daftvader) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$2.00 / 1,000 product_dataset_items

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

## ShopWSS Product Scraper

Export ShopWSS's product catalog as structured records ready for catalog analysis, merchandising research, inventory workflows, or your own data pipeline. Each result is one complete product with its variants, images, options, tags, vendor, product type, and Shopify timestamps.

Use the Actor to:

- collect the full current ShopWSS catalog;
- export a specific collection by its URL handle;
- sample or regularly monitor a fixed number of products; and
- download product data as JSON, CSV, Excel, XML, or another Apify dataset format.

### How to use it

1. Set **Maximum products**. To export the available catalog without a product cap, remove this field from an API input.
2. Optionally enter a **Collection handle**. For a URL ending in `/collections/mens-shoes`, enter `mens-shoes`.
3. Click **Start**.
4. Open the **ShopWSS products** dataset to preview or download the results.

The default input exports up to 250 products, so it also provides a useful quick test:

```json
{
  "maxProducts": 250
}
```

To export a collection:

```json
{
  "collection": "mens-shoes",
  "maxProducts": 1000
}
```

Advanced controls let you choose the starting catalog page, page size, retry count, and request timeout. Most runs can keep their defaults.

### Results

Every default-dataset item is one complete, unique ShopWSS product. The Actor preserves ShopWSS's source product structure, including nested variant and image data. A typical item has this shape:

```json
{
  "id": 123456789,
  "title": "Product title",
  "handle": "product-title",
  "vendor": "Brand",
  "product_type": "Shoes",
  "tags": ["New"],
  "variants": [{"id": 987654321, "title": "Default Title", "price": "79.99"}],
  "images": [{"id": 456789123, "src": "https://cdn.shopify.com/..."}],
  "options": [{"name": "Size", "values": ["8", "9"]}],
  "updated_at": "2026-08-28T00:00:00-04:00"
}
```

Exact fields and values depend on ShopWSS's current catalog. Records missing an ID, title, handle, or variants are not included. Product IDs are deduplicated across pages.

### Pricing and spend control

This Actor uses pay per event with platform usage included. A completed product written to the default dataset costs **$0.0009**—$0.90 per 1,000 products—plus the **$0.00005** Actor start event. You can set a maximum total charge in the Apify run options; the Actor stops adding results when the live charge limit is reached.

### Limits and reliability

The Actor reads ShopWSS's current public catalog and retries temporary request or response failures. If retries are exhausted, the run fails visibly while retaining products already stored. Website changes can affect available fields, catalog size, pagination, or access.

For recurring exports, use an Apify schedule. Results can also flow to webhooks and Apify integrations through the standard dataset interface.

# Actor input Schema

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

Stop after this many complete unique products. Leave empty to export all available products.

## `collection` (type: `string`):

Optional ShopWSS collection handle, such as mens-shoes. Use the final path segment from a collection URL.

## `startPage` (type: `integer`):

Shopify catalog page at which to begin.

## `pageSize` (type: `integer`):

Number of products requested per catalog page.

## `maxRetries` (type: `integer`):

Retries after a temporary request or response failure.

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

Maximum wait for each ShopWSS catalog request.

## `maxTotalChargeUsd` (type: `number`):

Optional compatibility cap. Prefer the run option for maximum total charge in Apify Console or API.

## Actor input object example

```json
{
  "maxProducts": 1,
  "startPage": 1,
  "pageSize": 250,
  "maxRetries": 3,
  "requestTimeoutSecs": 30
}
```

# Actor output Schema

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

No description

# 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 = {
    "maxProducts": 1
};

// Run the Actor and wait for it to finish
const run = await client.actor("daftvader/shopwss-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 = { "maxProducts": 1 }

# Run the Actor and wait for it to finish
run = client.actor("daftvader/shopwss-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 '{
  "maxProducts": 1
}' |
apify call daftvader/shopwss-scraper --silent --output-dataset

```

## MCP server setup

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