{
"openapi": "3.0.1",
"info": {
"title": "Shopify Scraper - Products & Price Monitor",
"description": "Scrape any Shopify store's products (prices, compare-at and discount %, variants, SKUs, stock, images, tags, dates) from its public JSON feed. Monitor mode compares with the previous run and returns only new, removed, price-changed and stock-changed products.",
"version": "1.0",
"x-build-id": "9y0wCUSucFQutuEfr"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/wrenfield-data~shopify-store-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-wrenfield-data-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/wrenfield-data~shopify-store-scraper/runs": {
"post": {
"operationId": "runs-sync-wrenfield-data-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/wrenfield-data~shopify-store-scraper/run-sync": {
"post": {
"operationId": "run-sync-wrenfield-data-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",
"required": [
"stores"
],
"properties": {
"stores": {
"title": "Shopify stores (domains or URLs)",
"type": "array",
"description": "Store domains or URLs, one per line, e.g. allbirds.com, https://www.gymshark.com. You can also paste a collection URL (/collections/mens) or a product URL (/products/handle) to scrape just that collection or product. Domains that are not Shopify stores get a free error row.",
"items": {
"type": "string"
}
},
"collections": {
"title": "Collection handles (optional)",
"type": "array",
"description": "Only scrape these collections in every store, e.g. mens-shoes (the part after /collections/ in the URL). Leave empty for the whole catalog.",
"items": {
"type": "string"
}
},
"keywords": {
"title": "Keyword filter (optional)",
"type": "array",
"description": "Keep only products whose title, handle, vendor, product type or tags contain at least one of these words (case-insensitive).",
"items": {
"type": "string"
}
},
"maxProductsPerStore": {
"title": "Max products per store",
"minimum": 1,
"maximum": 1000000,
"type": "integer",
"description": "Maximum products per store (after the keyword filter). Shopify returns up to 250 products per request. In monitor mode, use a limit above the store's catalog size so removed products can be detected.",
"default": 1000
},
"monitorMode": {
"title": "Monitor mode (only output changes)",
"type": "boolean",
"description": "Compare each store with the previous run and output only new, removed, price-changed and stock-changed products, with previous and current values. Snapshots are kept in a named key-value store, one record per store. Schedule the Actor (e.g. daily) to get a change feed.",
"default": false
},
"outputProductsOnFirstRun": {
"title": "Output full products on the first monitor run",
"type": "boolean",
"description": "On the first monitor run for a store there is nothing to compare with. When on, the full product list is output (billed as products); when off, the first run only saves the baseline.",
"default": true
},
"monitorStoreName": {
"title": "Snapshot key-value store name",
"type": "string",
"description": "Named key-value store in your account that keeps the snapshots. Use a different name to keep separate monitors.",
"default": "shopify-store-monitor"
},
"monitorId": {
"title": "Monitor ID (optional)",
"type": "string",
"description": "Optional label that separates snapshots when you monitor the same store with different tasks. Collections and keyword filters already get their own snapshot."
},
"includeInventory": {
"title": "Inventory quantities & barcodes (slower)",
"type": "boolean",
"description": "Fetch each product's /products/<handle>.js to add variant barcodes and inventoryQuantity when the store exposes it. Checked once per store; skipped automatically if the store hides quantities. Adds one request per product.",
"default": false
},
"trackQuantityChanges": {
"title": "Report inventory quantity changes",
"type": "boolean",
"description": "Monitor mode with inventory on: also output a stock_changed row when a variant's inventory quantity changes (not only when it goes in or out of stock). Useful for sales-velocity tracking, but produces many more change rows.",
"default": false
},
"includeDescription": {
"title": "Include description (plain text)",
"type": "boolean",
"description": "Add the product description as plain text (HTML removed, max 5,000 characters).",
"default": true
},
"proxyConfiguration": {
"title": "Proxy (fallback only)",
"type": "object",
"description": "Requests go directly to the store first. The proxy is used only for a store that rate-limits the Actor (HTTP 429/430). Default: Apify datacenter proxy.",
"default": {
"useApifyProxy": true
}
},
"requestDelaySecs": {
"title": "Delay between requests to one store (seconds)",
"minimum": 0.2,
"maximum": 10,
"type": "number",
"description": "Minimum pause between requests to the same store (with jitter). The default of 1 second matches the Crawl-delay most Shopify stores publish in robots.txt. The delay grows automatically if a store rate-limits.",
"default": 1
},
"maxConcurrency": {
"title": "Stores in parallel",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many different stores are scraped at the same time. Each store is always fetched one page at a time.",
"default": 5
},
"maxRetries": {
"title": "Max attempts per request",
"minimum": 1,
"maximum": 15,
"type": "integer",
"description": "Retries with backoff for rate limits, timeouts and server errors.",
"default": 6
}
}
},
"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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}