{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper + Price & Stock Change Monitor", "description": "Full product catalogs from any Shopify store via its public products.json, plus a changes mode that reports new, removed, price-dropped and back-in-stock items since the last run. Blocked or non-Shopify stores are reported, never charged.", "version": "0.1", "x-build-id": "3lksKpZJ6EAy9FhHv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/signalclear~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-signalclear-shopify-products-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/signalclear~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-signalclear-shopify-products-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/signalclear~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-signalclear-shopify-products-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": "Stores", "type": "array", "description": "One per line: a store domain (example-store.com), a store URL, a collection URL (https://example-store.com/collections/sale) or a product URL (https://example-store.com/products/blue-shirt). Collection and product inputs scrape only that collection or product.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "snapshot", "changes" ], "type": "string", "description": "Snapshot pushes the catalog. Changes compares the catalog with the snapshot saved by the previous changes-mode run and pushes only change rows (new, removed, price_drop, price_increase, back_in_stock, out_of_stock), then saves the new snapshot. The first changes-mode run for a store only saves the snapshot and pushes nothing.", "default": "snapshot" }, "maxProductsPerStore": { "title": "Maximum products per store", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop after this many matching products for each store. 0 = the whole catalog. In changes mode, removals are only reported when both runs read the whole catalog, so use 0 there for complete tracking.", "default": 1000 }, "includeVariants": { "title": "Variants", "enum": [ "nested", "rows" ], "type": "string", "description": "Nested: one row per product with a variants array. Rows: one row per variant (size, color...) with the product fields repeated. Applies to snapshot mode; change rows are always per variant.", "default": "nested" }, "onlyAvailable": { "title": "Only products in stock", "type": "boolean", "description": "Keep only products with at least one available variant (in variant rows: only available variants). Snapshot mode only; changes mode always tracks stock.", "default": false }, "updatedSince": { "title": "Updated since", "type": "string", "description": "ISO date or date-time, such as 2026-11-01. Keeps products whose updated_at is on or after it. Snapshot mode only. The store is still read page by page; this filters, it does not skip requests." }, "tags": { "title": "Tags", "type": "array", "description": "Keep products that have at least one of these tags (case-insensitive). Leave empty for all.", "items": { "type": "string" } }, "vendor": { "title": "Vendors", "type": "array", "description": "Keep products whose vendor (brand) is one of these (case-insensitive exact match). Leave empty for all.", "items": { "type": "string" } }, "includeDescription": { "title": "Include description HTML", "type": "boolean", "description": "Adds the product description as bodyHtml. Off by default because it makes rows several times larger.", "default": false }, "snapshotStoreName": { "title": "Snapshot store name (changes mode)", "type": "string", "description": "Named key-value store that keeps one snapshot per store between runs. Use the same name on every run you want compared. Lowercase letters, digits and hyphens.", "default": "shopify-snapshots" }, "includeStoreStatus": { "title": "Add a status row per store", "type": "boolean", "description": "Also push one row per store with type store_status: status ok, empty, blocked, not_shopify or unreachable, product count and pages read. These rows are dataset items like any other. Failed stores are always listed in the FAILED_STORES record regardless of this setting.", "default": false }, "maxItems": { "title": "Maximum rows in total", "minimum": 1, "type": "integer", "description": "Stop the whole run after this many dataset rows. Leave empty for no limit." }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "Stores fetched at the same time. Pages of one store are always fetched one after another.", "default": 4 }, "maxAttempts": { "title": "Attempts per store", "minimum": 1, "maximum": 5, "type": "integer", "description": "Each attempt uses a fresh proxy session and resumes at the page where the last one stopped. Stores that still fail are listed in FAILED_STORES and are not charged. Non-Shopify stores fail immediately.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait for a single HTTP response before the attempt counts as failed and is retried on a fresh session.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Shopify's catalog JSON works from datacenter IPs, so the default Apify proxy is usually enough. You can pick proxy groups or a country here.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }