# Shopify Store Scraper โ Products & Prices (`blackfalcondata/shopify-store-scraper`) Actor
Extract full product catalogs from any Shopify store โ every product with its variants, SKUs, barcodes, inventory, and integer-cent prices, plus optional reviews and store contacts (email, phone). Batch multiple stores, search by keyword, and track price/stock changes over time.
- **URL**: https://apify.com/blackfalcondata/shopify-store-scraper.md
- **Developed by:** [Black Falcon Data](https://apify.com/blackfalcondata) (community)
- **Categories:** E-commerce, Lead generation, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet
## Pricing
from $0.90 / 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/platform/actors/running/actors-in-store#pay-per-event
## What's an Apify Actor?
Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
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.
In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md):
```bash
pip install apify-client
```
In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):
````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash
In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md).
If your project is in a different language, use 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
### What does Shopify Store Scraper do?
Shopify Store Scraper extracts structured product data โ products, prices, and stock levels โ from any Shopify-powered storefront such as shopify.com, including full product descriptions. It supports keyword search, multi-store batch runs, and price and stock change tracking, so you can monitor the same catalog consistently over time. Optional enrichment adds store intelligence, customer reviews, and contact details such as email and phone for lead generation.
### How to use this actor
- ๐ **Register for a free Apify account** โ no credit card required.
- ๐ Just click **[Sign up free on Apify โ](https://console.apify.com/sign-up?fpr=1h3gvi&fp_sid=ctarich)** and complete a quick signup.
- ๐ฐ A free Apify account includes $5 in monthly credits โ enough to test this actor.
- โณ Scrape during the free trial, with no commitment or upfront payment required.
### Key features
- **๐ฌ Multi-store batch scraping** โ pass a list of `domains`, crawled in one run โ full catalog by default, or scoped via `collection`/URL. Or paste `startUrls` directly.
- **๐จ Full product + variant depth** โ every product ships its variant matrix โ per-variant `sku`, `barcode`, price, stock, weight, options. `includeOutOfStock` keeps sold-out variants.
- **๐ In-store keyword search** โ set `query` to search within a store instead of crawling its full catalog for quick spot checks.
- **๐ "Customers also viewed" recommendations** โ set `maxRecommendationsPerProduct` to attach each product's "you may also like" recommendations for cross-sell analysis.
- **๐ต Structured pricing** โ every price is parsed to integer cents (`priceMin`/`priceMax`/`currency`) โ no float rounding errors; `compareAtPrice`/`onSale` flag markdowns.
- **๐ Incremental mode โ price & stock change tracking** โ turn on `emitOnlyChanges` for new/removed/changed products since the last run โ each variant carries `previousPrice`, `priceChanged`, `stockChanged`.
- **๐ Notifications** โ telegram / Slack / Discord / WhatsApp / webhook alerts on each run. Combine with incremental to ping only when prices or inventory actually move.
- **๐ค Export anywhere** โ Download the dataset as JSON, CSV, or Excel from the Apify Console, or stream live via the Apify API and integrations (Make, Zapier, Google Sheets, n8n, โฆ).
- **๐ง Store intelligence summary** โ turn on `includeStoreIntelligence` for a store summary: theme, apps, catalog stats, review coverage, and a labeled order-volume estimate (not a sales figure).
- **๐ Store contact & lead enrichment** โ turn on `includeContacts` for each store's published contact details โ email, phone, address, social links (coverage varies).
- **โญ Per-product customer reviews** โ turn on `includeReviews` to attach customer reviews (rating, title, text, author, date) per product; `maxReviewsPerProduct` caps depth (coverage varies).
### What data can you extract from shopify.com?
Each result includes Core product fields (`productId`, `handle`, `canonicalUrl`, `storeDomain`, `title`, `vendor`, `productType`, and `tags`, and more) and detail fields when enrichment is enabled (`description`). All fields are always present โ unavailable data points are returned as `null`, never omitted.
### Input
The main inputs are a search keyword. Additional filters and options are available in the input schema.
Key parameters:
- **`domains`** โ Store domains to scrape (e.g. allbirds.com). Each domain crawls the store's full catalog (or a single collection/product โ see below). (default: `[]`)
- **`startUrls`** โ Paste store, collection, or product page URLs. Each URL becomes its own crawl target โ home page (full catalog), a collection page (that collection only), or a product page (single product). Merged with Store Domains. (default: `[]`)
- **`query`** โ Optional. Search within the given store(s) instead of crawling the full catalog/collection.
- **`collection`** โ Optional. Limit the crawl to one collection (its handle, e.g. "mens-shoes"). Leave empty to crawl the whole store. A collection scope on a start URL overrides this. (default: `""`)
- **`maxProducts`** โ Maximum products per store (0 = unlimited). (default: `0`)
- **`maxRecommendationsPerProduct`** โ How many "you may also like" recommendations to attach per product (0 = none, max 20). (default: `0`)
- **`includeVariants`** โ Include per-variant details (size/color options, price, stock, SKU) for each product. (default: `true`)
- **`includeOutOfStock`** โ Include products/variants that are currently sold out. (default: `true`)
- **`excludeEmptyFields`** โ Drop null, empty-string, and empty-array fields from each record before it is pushed. Smaller payloads for AI agents and dashboards. (default: `false`)
- **`emitOnlyChanges`** โ Only output products that are new, price/stock-changed, or removed since the last run (compares against saved state). Off by default (every run emits the full catalog). (default: `false`)
- **`includeStoreIntelligence`** โ Add a store-level summary: theme, installed apps, catalog metrics and an order-volume estimate. (default: `false`)
- **`includeContacts`** โ Add store contact details (email, phone, address, social profiles) where published. (default: `false`)
- ...and 16 more parameters
### Input examples
**Full catalog for one or more stores** โ Point it at any Shopify storefront domain and get the complete product catalog with per-variant SKU, barcode, inventory, and pricing.
โ Every product across the listed stores
```json
{
"domains": [
"allbirds.com",
"gymshark.com"
],
"includeVariants": true,
"maxProducts": 500
}
````
**A single collection from a store URL** โ Paste a collection URL straight from your browser to scrape just that collection.
โ Products in the pasted collection only
```json
{
"startUrls": [
"https://www.allbirds.com/collections/mens"
],
"includeVariants": true
}
```
**In-store keyword search** โ Search within a store instead of crawling its whole catalog.
โ Products matching the query in that store
```json
{
"domains": [
"gymshark.com"
],
"query": "shorts",
"maxProducts": 100
}
```
**Price & stock change monitoring** โ Re-run on a schedule with the same stateKey to get back only products that are new, removed, or changed in price/stock since the last run.
โ Only changed / new / removed products
```json
{
"domains": [
"allbirds.com"
],
"emitOnlyChanges": true,
"stateKey": "allbirds-daily"
}
```
### Output
Each run produces a dataset of structured product records. Results can be downloaded as JSON, CSV, or Excel from the Dataset tab in Apify Console.
### Example product record
```json
{
"productId": "7292464955472",
"handle": "mens-cruiser-shadow-blue-natural-white-sole",
"canonicalUrl": "https://allbirds.com/products/mens-cruiser-shadow-blue-natural-white-sole",
"storeDomain": "allbirds.com",
"title": "Men's Cruiser - Shadow Blue (Natural White Sole)",
"description": "Inspired by a classic court style, this signature shoe delivers the right balance of style and comfort. Its lightweight build and supple softness make this your new pick for life on the go.
",
"vendor": "Allbirds",
"productType": "Shoes",
"tags": [
"allbirds::cfId => color-8d8c461eb0f65396c57fcd7467def939",
"DNAM BRANDS",
"EC STOCK"
],
"currency": "USD",
"priceMin": 10500,
"priceMax": 10500,
"onSale": false,
"images": [
{
"src": "https://cdn.shopify.com/s/files/1/1104/4168/files/All-birds_0010.png?v=1783535519",
"width": 1512,
"height": 1512
},
{
"src": "https://cdn.shopify.com/s/files/1/1104/4168/files/All-birds_0017.png?v=1783535524",
"width": 1512,
"height": 1512
},
{
"src": "https://cdn.shopify.com/s/files/1/1104/4168/files/All-birds_0029.png?v=1783535534",
"width": 1512,
"height": 1512
},
{
"src": "https://cdn.shopify.com/s/files/1/1104/4168/files/All-birds_0014_e70e39f1-8894-4050-bd34-c34dd5348523.png?v=1783535552",
"width": 1512,
"height": 1512
},
{
"src": "https://cdn.shopify.com/s/files/1/1104/4168/files/All-birds_0028.png?v=1783535556",
"width": 1512,
"height": 1512
}
],
"featuredImage": "https://cdn.shopify.com/s/files/1/1104/4168/files/All-birds_0010.png?v=1783535519",
"imageCount": 5,
"options": [
{
"name": "Size",
"values": [
"8",
"8.5",
"9",
"9.5",
"10",
"... 8 more items"
]
}
],
"variants": [
{
"variantId": "41990816759888",
"title": "8",
"sku": "A12856M080",
"price": 10500,
"available": true,
"weight": 1000,
"weightUnit": "g",
"requiresShipping": true,
"options": [
"8"
],
"priceChanged": false,
"stockChanged": false
},
{
"variantId": "41990816792656",
"title": "8.5",
"sku": "A12856M085",
"price": 10500,
"available": true,
"weight": 1000,
"weightUnit": "g",
"requiresShipping": true,
"options": [
"8.5"
],
"priceChanged": false,
"stockChanged": false
},
{
"variantId": "41990816825424",
"title": "9",
"sku": "A12856M090",
"price": 10500,
"available": true,
"weight": 1000,
"weightUnit": "g",
"requiresShipping": true,
"options": [
"9"
],
"priceChanged": false,
"stockChanged": false
},
{
"variantId": "41990816858192",
"title": "9.5",
"sku": "A12856M095",
"price": 10500,
"available": true,
"weight": 1000,
"weightUnit": "g",
"requiresShipping": true,
"options": [
"9.5"
],
"priceChanged": false,
"stockChanged": false
},
{
"variantId": "41990816890960",
"title": "10",
"sku": "A12856M100",
"price": 10500,
"available": true,
"weight": 1000,
"weightUnit": "g",
"requiresShipping": true,
"options": [
"10"
],
"priceChanged": false,
"stockChanged": false
},
"... 8 more items"
],
"variantCount": 13,
"createdAt": "2026-02-05T02:38:18+01:00",
"updatedAt": "2026-07-17T12:29:30+02:00",
"publishedAt": "2026-07-08T20:32:23+02:00",
"available": true,
"isNew": false,
"isRemoved": false,
"scrapedAt": "2026-07-17T10:29:13.755Z",
"source": "shopify"
}
```
### Incremental fields
When incremental mode is on, each record also carries:
- `changeType` โ one of `NEW`, `UPDATED`, `UNCHANGED`, `REAPPEARED`, `EXPIRED`.
### How to scrape shopify.com
1. Go to [Shopify Store Scraper](https://apify.com/blackfalcondata/shopify-store-scraper?fpr=1h3gvi) in Apify Console.
2. Enter a search keyword.
3. Set `maxProducts` to control how many results you need.
4. Click **Start** and wait for the run to finish.
5. Export the dataset as JSON, CSV, or Excel.
### Use cases
- Extract product data from shopify.com for market research and competitive analysis.
- Track pricing trends across regions and categories over time.
- Monitor new and changed products on scheduled runs without processing the full dataset every time.
- Export clean, structured data to dashboards, spreadsheets, or data warehouses.
### How much does it cost to scrape shopify.com?
Shopify Store Scraper uses [pay-per-event](https://docs.apify.com/platform/actors/paid-actors/pay-per-event) pricing. You pay a small fee when the run starts and then for each result that is actually produced.
- **Run start:** $0.01 per run
- **Per result:** $0.0009 per product record
Example costs:
- 10 results: **$0.019**
- 25 results: **$0.033**
- 100 results: **$0.1**
- 200 results: **$0.19**
- 500 results: **$0.46**
#### Example: recurring monitoring savings
These examples compare full re-scrapes with incremental runs at different churn rates. Churn is the share of products that are new or whose tracked content changed since the previous run. Actual churn depends on your query breadth, source activity, and polling frequency โ the scenarios below are examples, not predictions.
Example setup: 250 results per run, daily polling (30 runs/month). Event-pricing examples scale linearly with result count.
| Churn rate | Full re-scrape run cost | Incremental run cost | Savings vs full re-scrape | Monthly cost after baseline |
|---|---:|---:|---:|---:|
| 5% โ stable niche query | $0.24 | $0.02 | $0.21 (91%) | $0.64 |
| 15% โ moderate broad query | $0.24 | $0.04 | $0.19 (81%) | $1.31 |
| 30% โ high-volume aggregator | $0.24 | $0.08 | $0.16 (67%) | $2.33 |
Full re-scrape monthly cost at daily polling: $7.05. First month with incremental costs $0.85 / $1.50 / $2.48 for the 5% / 15% / 30% scenarios because the first run builds baseline state at full cost before incremental savings apply.
Platform usage is included in the per-result fee shown above.
### FAQ
#### How many results can I get from shopify.com?
The number of results depends on the search query and available products on shopify.com. Use the `maxProducts` parameter to control how many results are returned per run.
#### Does Shopify Store Scraper support recurring monitoring?
Yes. Enable incremental mode to only receive new or changed products on subsequent runs. This is ideal for scheduled monitoring where you want to track changes over time without re-processing the full dataset.
#### Can I integrate Shopify Store Scraper with other apps?
Yes. Shopify Store Scraper works with Apify's [integrations](https://apify.com/integrations?fpr=1h3gvi) to connect with tools like Zapier, Make, Google Sheets, Slack, and more. You can also use webhooks to trigger actions when a run completes.
#### Can I use Shopify Store Scraper with the Apify API?
Yes. You can start runs, manage inputs, and retrieve results programmatically through the [Apify API](https://docs.apify.com/api/v2). Client libraries are available for JavaScript, Python, and other languages.
#### Can I use Shopify Store Scraper through an MCP Server?
Yes. Apify provides an [MCP Server](https://apify.com/apify/actors-mcp-server?fpr=1h3gvi) that lets AI assistants and agents call this actor directly. Use `excludeEmptyFields` to keep payloads manageable for LLM context windows.
#### Is it legal to scrape shopify.com?
This actor extracts publicly available data from shopify.com. Web scraping of public information is generally considered legal, but you should always review the target site's terms of service and ensure your use case complies with applicable laws and regulations, including GDPR where relevant.
#### Your feedback
If you have questions, need a feature, or found a bug, please [open an issue](https://apify.com/blackfalcondata/shopify-store-scraper/issues?fpr=1h3gvi) on the actor's page in Apify Console. Your feedback helps us improve.
### You might also like
- [Trade Me Scraper โ NZ Marketplace, Motors, Property & Jobs](https://apify.com/blackfalcondata/trademe-scraper?fpr=1h3gvi) โ Scrape Trade Me across goods, used cars, property, rentals and jobs in a single run. Vehicle.
### Getting started with Apify
New to Apify? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctarich) โ no credit card required.
1. Sign up โ $5 platform credit included
2. Open this actor and configure your input
3. Click **Start** โ export results as JSON, CSV, or Excel
Need more later? [See Apify pricing](https://apify.com/pricing?fpr=1h3gvi).
# Actor input Schema
## `domains` (type: `array`):
Store domains to scrape (e.g. allbirds.com). Each domain crawls the store's full catalog (or a single collection/product โ see below).
## `startUrls` (type: `array`):
Paste store, collection, or product page URLs. Each URL becomes its own crawl target โ home page (full catalog), a collection page (that collection only), or a product page (single product). Merged with Store Domains.
## `query` (type: `string`):
Optional. Search within the given store(s) instead of crawling the full catalog/collection.
## `collection` (type: `string`):
Optional. Limit the crawl to one collection (its handle, e.g. "mens-shoes"). Leave empty to crawl the whole store. A collection scope on a start URL overrides this.
## `maxProducts` (type: `integer`):
Maximum products per store (0 = unlimited).
## `maxRecommendationsPerProduct` (type: `integer`):
How many "you may also like" recommendations to attach per product (0 = none, max 20).
## `includeVariants` (type: `boolean`):
Include per-variant details (size/color options, price, stock, SKU) for each product.
## `includeOutOfStock` (type: `boolean`):
Include products/variants that are currently sold out.
## `excludeEmptyFields` (type: `boolean`):
Drop null, empty-string, and empty-array fields from each record before it is pushed. Smaller payloads for AI agents and dashboards.
## `emitOnlyChanges` (type: `boolean`):
Only output products that are new, price/stock-changed, or removed since the last run (compares against saved state). Off by default (every run emits the full catalog).
## `includeStoreIntelligence` (type: `boolean`):
Add a store-level summary: theme, installed apps, catalog metrics and an order-volume estimate.
## `includeContacts` (type: `boolean`):
Add store contact details (email, phone, address, social profiles) where published.
## `includeReviews` (type: `boolean`):
Add individual customer reviews per product (rating, title, text, author, date) where available.
## `maxReviewsPerProduct` (type: `integer`):
Maximum reviews to fetch per product when reviews are enabled.
## `stateKey` (type: `string`):
Advanced. Stable identifier for the tracked store set, used to compare runs. Leave empty to auto-generate from the given stores.
## `datasetId` (type: `string`):
Advanced. Also push results to this existing dataset ID, in addition to the default output.
## `runId` (type: `string`):
Advanced. Stamp each output record with this run identifier (useful for correlating across orchestrated runs).
## `proxyConfiguration` (type: `object`):
Defaults to Apify's recommended configuration for reliable access.
## `telegramToken` (type: `string`):
Telegram bot token (from @BotFather). Required for Telegram notifications.
## `telegramChatId` (type: `string`):
Telegram chat or channel ID (e.g. "-100123456789"). Required when telegramToken is set.
## `discordWebhookUrl` (type: `string`):
Discord incoming webhook URL. Server Settings โ Integrations โ Webhooks โ New Webhook.
## `slackWebhookUrl` (type: `string`):
Slack incoming webhook URL. api.slack.com/messaging/webhooks.
## `notificationLimit` (type: `integer`):
Maximum number of products included in each notification message (1โ20).
## `notifyOnlyChanges` (type: `boolean`):
When Emit Only Changes is on, only send notifications for NEW and UPDATED products. Has no effect otherwise.
## `whatsappAccessToken` (type: `string`):
WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h (service-conversation window โ free since Nov 2024).
## `whatsappPhoneNumberId` (type: `string`):
Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set.
## `whatsappTo` (type: `string`):
Recipient phone in E.164 format without + (e.g. "436641234567"). Recipient must have messaged your business number within last 24h.
## `webhookUrl` (type: `string`):
Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends.
## `webhookHeaders` (type: `object`):
Optional JSON object of custom headers (e.g. {"Authorization":"Bearer ..."}).
## Actor input object example
```json
{
"domains": [
"allbirds.com"
],
"startUrls": [],
"collection": "",
"maxProducts": 0,
"maxRecommendationsPerProduct": 0,
"includeVariants": true,
"includeOutOfStock": true,
"excludeEmptyFields": false,
"emitOnlyChanges": false,
"includeStoreIntelligence": false,
"includeContacts": false,
"includeReviews": false,
"maxReviewsPerProduct": 20,
"proxyConfiguration": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
},
"notificationLimit": 5,
"notifyOnlyChanges": false
}
```
# Actor output Schema
## `results` (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 '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {
"domains": [
"allbirds.com"
],
"excludeEmptyFields": false,
"emitOnlyChanges": false,
"includeStoreIntelligence": false,
"includeContacts": false,
"includeReviews": false
};
// Run the Actor and wait for it to finish
const run = await client.actor("blackfalcondata/shopify-store-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 '' with your token.
client = ApifyClient("")
# Prepare the Actor input
run_input = {
"domains": ["allbirds.com"],
"excludeEmptyFields": False,
"emitOnlyChanges": False,
"includeStoreIntelligence": False,
"includeContacts": False,
"includeReviews": False,
}
# Run the Actor and wait for it to finish
run = client.actor("blackfalcondata/shopify-store-scraper").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print("๐พ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
print(item)
# ๐ Want to learn more ๐? Go to โ https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{
"domains": [
"allbirds.com"
],
"excludeEmptyFields": false,
"emitOnlyChanges": false,
"includeStoreIntelligence": false,
"includeContacts": false,
"includeReviews": false
}' |
apify call blackfalcondata/shopify-store-scraper --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=blackfalcondata/shopify-store-scraper",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "Shopify Store Scraper โ Products & Prices",
"description": "Extract full product catalogs from any Shopify store โ every product with its variants, SKUs, barcodes, inventory, and integer-cent prices, plus optional reviews and store contacts (email, phone). Batch multiple stores, search by keyword, and track price/stock changes over time.",
"version": "0.1",
"x-build-id": "A9bsxMahMVyyquA4u"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/blackfalcondata~shopify-store-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-blackfalcondata-shopify-store-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/blackfalcondata~shopify-store-scraper/runs": {
"post": {
"operationId": "runs-sync-blackfalcondata-shopify-store-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/blackfalcondata~shopify-store-scraper/run-sync": {
"post": {
"operationId": "run-sync-blackfalcondata-shopify-store-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"domains": {
"title": "๐ฌ Store Domains",
"type": "array",
"description": "Store domains to scrape (e.g. allbirds.com). Each domain crawls the store's full catalog (or a single collection/product โ see below).",
"items": {
"type": "string"
},
"default": []
},
"startUrls": {
"title": "๐ Start URLs",
"type": "array",
"description": "Paste store, collection, or product page URLs. Each URL becomes its own crawl target โ home page (full catalog), a collection page (that collection only), or a product page (single product). Merged with Store Domains.",
"default": [],
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"query": {
"title": "๐ Search Term",
"type": "string",
"description": "Optional. Search within the given store(s) instead of crawling the full catalog/collection."
},
"collection": {
"title": "๐ Collection Handle",
"type": "string",
"description": "Optional. Limit the crawl to one collection (its handle, e.g. \"mens-shoes\"). Leave empty to crawl the whole store. A collection scope on a start URL overrides this.",
"default": ""
},
"maxProducts": {
"title": "๐ฏ Max Products",
"minimum": 0,
"type": "integer",
"description": "Maximum products per store (0 = unlimited).",
"default": 0
},
"maxRecommendationsPerProduct": {
"title": "๐ Related Products Per Item",
"minimum": 0,
"maximum": 20,
"type": "integer",
"description": "How many \"you may also like\" recommendations to attach per product (0 = none, max 20).",
"default": 0
},
"includeVariants": {
"title": "๐จ Include Variants",
"type": "boolean",
"description": "Include per-variant details (size/color options, price, stock, SKU) for each product.",
"default": true
},
"includeOutOfStock": {
"title": "๐ฆ Include Out-of-Stock Products",
"type": "boolean",
"description": "Include products/variants that are currently sold out.",
"default": true
},
"excludeEmptyFields": {
"title": "๐งน Exclude Empty Fields",
"type": "boolean",
"description": "Drop null, empty-string, and empty-array fields from each record before it is pushed. Smaller payloads for AI agents and dashboards.",
"default": false
},
"emitOnlyChanges": {
"title": "๐ Emit Only Changes",
"type": "boolean",
"description": "Only output products that are new, price/stock-changed, or removed since the last run (compares against saved state). Off by default (every run emits the full catalog).",
"default": false
},
"includeStoreIntelligence": {
"title": "๐ง Include Store Intelligence",
"type": "boolean",
"description": "Add a store-level summary: theme, installed apps, catalog metrics and an order-volume estimate.",
"default": false
},
"includeContacts": {
"title": "๐ Include Contacts",
"type": "boolean",
"description": "Add store contact details (email, phone, address, social profiles) where published.",
"default": false
},
"includeReviews": {
"title": "โญ Include Reviews",
"type": "boolean",
"description": "Add individual customer reviews per product (rating, title, text, author, date) where available.",
"default": false
},
"maxReviewsPerProduct": {
"title": "๐ฌ Max Reviews Per Product",
"minimum": 0,
"type": "integer",
"description": "Maximum reviews to fetch per product when reviews are enabled.",
"default": 20
},
"stateKey": {
"title": "๐ State Key",
"type": "string",
"description": "Advanced. Stable identifier for the tracked store set, used to compare runs. Leave empty to auto-generate from the given stores."
},
"datasetId": {
"title": "๐ค Extra Dataset ID",
"type": "string",
"description": "Advanced. Also push results to this existing dataset ID, in addition to the default output."
},
"runId": {
"title": "๐ท๏ธ Source Run ID Tag",
"type": "string",
"description": "Advanced. Stamp each output record with this run identifier (useful for correlating across orchestrated runs)."
},
"proxyConfiguration": {
"title": "๐ Proxy Configuration",
"type": "object",
"description": "Defaults to Apify's recommended configuration for reliable access.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
},
"telegramToken": {
"title": "๐ Telegram Bot Token",
"type": "string",
"description": "Telegram bot token (from @BotFather). Required for Telegram notifications."
},
"telegramChatId": {
"title": "๐ฌ Telegram Chat ID",
"type": "string",
"description": "Telegram chat or channel ID (e.g. \"-100123456789\"). Required when telegramToken is set."
},
"discordWebhookUrl": {
"title": "๐ฎ Discord Webhook URL",
"type": "string",
"description": "Discord incoming webhook URL. Server Settings โ Integrations โ Webhooks โ New Webhook."
},
"slackWebhookUrl": {
"title": "๐ผ Slack Webhook URL",
"type": "string",
"description": "Slack incoming webhook URL. api.slack.com/messaging/webhooks."
},
"notificationLimit": {
"title": "๐ Max Products Per Notification",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "Maximum number of products included in each notification message (1โ20).",
"default": 5
},
"notifyOnlyChanges": {
"title": "๐ Notify Only New/Updated",
"type": "boolean",
"description": "When Emit Only Changes is on, only send notifications for NEW and UPDATED products. Has no effect otherwise.",
"default": false
},
"whatsappAccessToken": {
"title": "๐ฑ WhatsApp Access Token",
"type": "string",
"description": "WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h (service-conversation window โ free since Nov 2024)."
},
"whatsappPhoneNumberId": {
"title": "๐ WhatsApp Phone Number ID",
"type": "string",
"description": "Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set."
},
"whatsappTo": {
"title": "๐ฒ WhatsApp Recipient",
"type": "string",
"description": "Recipient phone in E.164 format without + (e.g. \"436641234567\"). Recipient must have messaged your business number within last 24h."
},
"webhookUrl": {
"title": "๐ช Generic Webhook URL",
"type": "string",
"description": "Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends."
},
"webhookHeaders": {
"title": "๐ Webhook Headers",
"type": "object",
"description": "Optional JSON object of custom headers (e.g. {\"Authorization\":\"Bearer ...\"})."
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}
```