{ "openapi": "3.0.1", "info": { "title": "Shopify Product Scraper & Competitor Price Monitor", "description": "Scrape any Shopify or WooCommerce store's products, variants, prices, discounts and stock. Monitor competitor price drops, restocks and new products on a schedule. No login or proxy.", "version": "0.1", "x-build-id": "dbMJ9oUdAdrWtc7s0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adastra-connect~store-product-feed-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adastra-connect-store-product-feed-monitor", "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/adastra-connect~store-product-feed-monitor/runs": { "post": { "operationId": "runs-sync-adastra-connect-store-product-feed-monitor", "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/adastra-connect~store-product-feed-monitor/run-sync": { "post": { "operationId": "run-sync-adastra-connect-store-product-feed-monitor", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Store URLs", "type": "array", "description": "Public Shopify or WooCommerce store URLs. Bare domains and Shopify collection URLs are accepted.", "items": { "type": "string" }, "default": [ "https://www.allbirds.com", "https://offermanwoodshop.com" ] }, "platform": { "title": "Platform", "enum": [ "auto", "shopify", "woocommerce" ], "type": "string", "description": "Auto checks Shopify first, then the WooCommerce public Store API.", "default": "auto" }, "mode": { "title": "Output mode", "enum": [ "products", "variants", "changes" ], "type": "string", "description": "Products: one row per product. Variants: one row per variant. Changes: compare against a persistent baseline.", "default": "products" }, "monitorKey": { "title": "Monitoring namespace", "type": "string", "description": "Use the same value across scheduled monitoring runs. Use separate namespaces for different collections or purposes.", "default": "default" }, "emitBaselineOnFirstRun": { "title": "Emit the first baseline", "type": "boolean", "description": "When enabled, emit a new_product record for every matching variant on the first changes run.", "default": false }, "minPriceChangePct": { "title": "Minimum price change (%)", "minimum": 0, "type": "number", "description": "Ignore price changes smaller than this absolute percentage. Stock changes are unaffected.", "default": 0 }, "maxProductsPerStore": { "title": "Maximum products per store", "minimum": 0, "type": "integer", "description": "Maximum parent products to read before filters, 0 means unlimited. Limited scans suppress removal alerts.", "default": 500 }, "maxResults": { "title": "Maximum output rows", "minimum": 1, "type": "integer", "description": "Hard cap on billable product, variant, or change rows across all stores.", "default": 2000 }, "includeDescription": { "title": "Include descriptions", "type": "boolean", "description": "Include plain text descriptions with HTML and contact details removed.", "default": false }, "onlyAvailable": { "title": "Only available products", "type": "boolean", "description": "Match products with at least one available variant. In changes mode either previous or current match can emit a stock change.", "default": false }, "minPrice": { "title": "Minimum product price", "minimum": 0, "type": "number", "description": "Inclusive minimum for the lowest variant price, in the store currency. No currency conversion." }, "maxPrice": { "title": "Maximum product price", "minimum": 0, "type": "number", "description": "Inclusive maximum for the lowest variant price, in the store currency." }, "keywords": { "title": "Keywords", "type": "array", "description": "Case-insensitive substring matching in title, vendor, product type and tags. Any keyword may match.", "items": { "type": "string" }, "default": [] }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "type": "integer", "description": "Minimum interval between requests to a host. A larger robots.txt Crawl-delay takes precedence.", "default": 1000 } } }, "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 } } } } } } } } } }