{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper, Price & Stock Monitor", "description": "Shopify products scraper API for complete public catalogues, including variants, prices, SKUs, images and availability. Completes variant pagination instead of silently stopping at 100. Export snapshots or monitor verified price, sale, stock and catalogue changes. No API key or browser.", "version": "0.1", "x-build-id": "NPVLXpGsgYGsnATop" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~shopify-price-stock-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-shopify-price-stock-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/automa-flow~shopify-price-stock-monitor/runs": { "post": { "operationId": "runs-sync-automa-flow-shopify-price-stock-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/automa-flow~shopify-price-stock-monitor/run-sync": { "post": { "operationId": "run-sync-automa-flow-shopify-price-stock-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", "properties": { "storeUrls": { "title": "Store URLs", "maxItems": 200, "type": "array", "description": "Fast start: paste one to 200 public Shopify storefront URLs or domains, one per line. Use Advanced store entries below only when you need your own external IDs on the output.", "items": { "type": "string", "minLength": 1 } }, "stores": { "title": "Advanced store entries", "maxItems": 200, "type": "array", "description": "Optional JSON entries for stores that need an externalId echoed into every result. You may use this together with Store URLs; the combined limit is 200 unique input rows.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "title": "Store URL or domain", "type": "string", "editor": "textfield", "description": "Storefront URL or bare domain, for example https://www.allbirds.com or example.myshopify.com." }, "externalId": { "title": "Your external ID", "type": "string", "editor": "textfield", "maxLength": 200, "description": "Your own stable identifier. Echoed into every record and never sent to the store." } } } }, "mode": { "title": "Mode", "enum": [ "monitor", "snapshot" ], "type": "string", "description": "monitor compares each store against its last complete successful catalogue and emits change events. snapshot returns the current catalogue without reading or writing monitoring state.", "default": "monitor" }, "outputMode": { "title": "Product output", "enum": [ "changesOnly", "all" ], "type": "string", "description": "In monitor mode, changesOnly omits unchanged products but returns the first-run BASELINE, every change event and one store_check row per store. In snapshot mode, changesOnly returns store_check rows only for lightweight watchlist validation. all returns every product.", "default": "changesOnly" }, "includeImages": { "title": "Include product images", "type": "boolean", "description": "Return up to 10 image URLs per product. Image URLs are never used for change detection, because Shopify's CDN rewrites them without the picture changing.", "default": true }, "includeDescriptions": { "title": "Include product descriptions", "type": "boolean", "description": "Return plain-text descriptions and monitor them for DESCRIPTION_CHANGED. Off by default: descriptions are the largest field in the catalogue and change for reasons pricing teams rarely care about. Turning this on or off starts a new baseline.", "default": false }, "country": { "title": "Market country", "maxLength": 2, "type": "string", "description": "Optional ISO 3166-1 alpha-2 code, for example GB or DE. Pins the market prices are quoted in, so results do not move when the run's egress location does. Shopify falls back to the store's default market if it does not sell to that country; the market actually applied is reported on every record. Changing this starts a new baseline." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional, and usually not the fix. All 35 reachable stores in testing worked over direct HTTP, and the blocked ones stayed blocked through a residential proxy, because they are headless hosts that serve no API rather than IP-blocked ones. Use it if your network requires egress through a proxy, or for a specific store you know a proxy helps.", "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 } } }, "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 } } } } } } } } } }