{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper & Price Monitor", "description": "Scrape every product from any Shopify store, custom domains included: prices, compare-at prices, discounts, SKUs, variants, stock status and images. One row per product or per variant. Price monitor mode returns only new, changed and removed products. $1 per 1,000 products.", "version": "0.1", "x-build-id": "6PZJu7ypvJG69WzfX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/oldjard~shopify-products-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-oldjard-shopify-products-price-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/oldjard~shopify-products-price-monitor/runs": { "post": { "operationId": "runs-sync-oldjard-shopify-products-price-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/oldjard~shopify-products-price-monitor/run-sync": { "post": { "operationId": "run-sync-oldjard-shopify-products-price-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": "Shopify store URLs", "type": "array", "description": "Shopify stores, one per line. A bare domain (allbirds.com) or any page of the store reads the whole catalog. A collection URL (https://colourpop.com/collections/lips) reads just that collection. A product URL (https://www.allbirds.com/products/mens-tree-runners) reads just that product. Custom domains work; the actor checks that each site is a Shopify store.", "items": { "type": "string" } }, "outputMode": { "title": "Output", "enum": [ "products", "variants" ], "type": "string", "description": "One row per product (variants listed inside each row), or one flat row per variant (size, color…) with its own price, compare-at price, SKU and availability. Per-variant is easier in a spreadsheet. Either way you pay per product.", "default": "products" }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Stop after this many products from each store. 0 or empty means no limit (the whole catalog).", "default": 0 }, "collections": { "title": "Collections", "type": "array", "description": "Only read these collections of each store, by handle (the part after /collections/ in the URL, e.g. 'mens-shoes') or full collection URL. Empty reads the whole store. A product in several collections is returned once.", "items": { "type": "string" } }, "includeDescription": { "title": "Include description HTML", "type": "boolean", "description": "Add the product description as HTML (descriptionHtml). The plain-text description (descriptionText) is always included.", "default": true }, "includeInventory": { "title": "Include stock levels and barcodes", "type": "boolean", "description": "Add each variant's stock quantity and barcode, when the store exposes them (many do, some hide them). Needs one extra request per product, so runs take longer (about 2 products per second per store).", "default": false }, "onlyAvailable": { "title": "Only in-stock products", "type": "boolean", "description": "Keep only products (or, per variant, variants) that can be bought now. Ignored in monitor mode.", "default": false }, "onlyOnSale": { "title": "Only discounted products", "type": "boolean", "description": "Keep only products (or variants) priced below their compare-at price. Ignored in monitor mode.", "default": false }, "onlyChanges": { "title": "Monitor: only new, changed and removed products", "type": "boolean", "description": "Price-change monitor. Compare each store with the previous run (same state key) and output only products that are new, removed, or whose price, compare-at price or availability changed, with the old and new values. Schedule it daily to track competitors' prices. You pay only for changes.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Name of the monitor's memory. Use a different key for each separate monitor (for example 'competitors-daily'). Runs with the same key and the same store URLs share memory.", "default": "default" }, "outputOnFirstRun": { "title": "Output the whole catalog on the first run", "type": "boolean", "description": "On a monitor's first run every product is new. On: output them all (as 'new'). Off: only remember them, output nothing and pay nothing; changes start from the next run.", "default": true }, "trackAvailability": { "title": "Report stock-status changes", "type": "boolean", "description": "Also report a product when a variant goes in or out of stock. Off: only price and compare-at price changes count.", "default": true }, "failOnSiteError": { "title": "Fail the run if any store fails", "type": "boolean", "description": "Strict mode for pipelines and health checks: fail the run when any store fails or lists no products. Off: failed stores are reported in the OUTPUT record and the run still succeeds.", "default": 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 } } } } } } } } } }