{ "openapi": "3.0.1", "info": { "title": "Shopify Product Scraper & Price / Stock Monitor", "description": "Export authorized Shopify catalogs, track variant price and availability changes, and download history-aware JSON/CSV reports. Built for US ecommerce teams; no Shopify API key required.", "version": "1.3", "x-build-id": "fcwhTu3SjZffbxTy9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fascinating_lentil~shopify-store-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fascinating_lentil-shopify-store-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/fascinating_lentil~shopify-store-products-scraper/runs": { "post": { "operationId": "runs-sync-fascinating_lentil-shopify-store-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/fascinating_lentil~shopify-store-products-scraper/run-sync": { "post": { "operationId": "run-sync-fascinating_lentil-shopify-store-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": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Shopify Store URLs / Domains", "minItems": 1, "maxItems": 5, "type": "array", "description": "Store domains, clean collection URLs (/collections/handle), or product URLs (/products/handle). Unsupported paths, queries and fragments are rejected, not silently expanded to the whole store. The default is an explicitly labeled bundled Mock.Shop demo, not a live scrape.", "default": [ "demostore.mock.shop" ], "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max Products Per Store", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of products to scrape per store. The default is 1 for a low-cost first run.", "default": 1 }, "productType": { "title": "Filter by Product Type", "maxLength": 200, "type": "string", "description": "Only keep products whose product type matches this exactly (case-insensitive). Leave empty for all.", "default": "" }, "trackChanges": { "title": "Track prices, stock and variant changes", "type": "boolean", "description": "Compare successfully saved live products with private history under the same watchlist. Includes JSON, changes CSV and a readable report without additional source requests or alert events. Every saved live product is still charged, including unchanged ones. Demo rows do not advance history.", "default": false }, "watchlistName": { "title": "Watchlist name for repeat runs", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,79}$", "type": "string", "description": "Reuse the same name and scope for comparisons. Use different names for different clients. Do not overlap runs of the same watchlist. Scope, filter, product limit and declared currency changes create a separate baseline.", "default": "shopify-us-watchlist" }, "maxHistoryPoints": { "title": "Recent observations retained per product", "minimum": 2, "maximum": 30, "type": "integer", "description": "Keep 2–30 saved price/availability observations per product (default 10). First-observed time and total count remain available. Bounded history is not an unlimited archive.", "default": 10 }, "storeCurrency": { "title": "Declared currency (optional, e.g. USD)", "pattern": "^$|^[A-Za-z]{3}$", "type": "string", "description": "Only declare a three-letter code if you know all selected feeds use it. This is user-provided, not independently verified. Leave empty to keep currency unknown; raw value changes remain visible but currency-dependent deltas/percent alerts are withheld. US audience does not imply USD. Use separate runs for different currencies.", "default": "" }, "confirmAuthorizedUse": { "title": "I am authorized to monitor these stores", "type": "boolean", "description": "Required for any real store. Confirm that you own, administer, or have permission to monitor each supplied storefront. Not required for the official demo.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Leave proxy off for the official demo and normal public storefront access. A proxy does not override store permissions, robots.txt, or access restrictions.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }