{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper & Price Monitor", "description": "Scrape all products from any Shopify store: prices, sale prices, stock, variants, SKUs and images. Monitor mode returns only what changed since the last run: new products, price drops, price increases, back in stock, sold out, removed. One row per product or per variant. Export to CSV, Excel, JSON.", "version": "0.0", "x-build-id": "bvUyaa4G38LWuyDhk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cancap~shopify-products-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cancap-shopify-products-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/cancap~shopify-products-monitor/runs": { "post": { "operationId": "runs-sync-cancap-shopify-products-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/cancap~shopify-products-monitor/run-sync": { "post": { "operationId": "run-sync-cancap-shopify-products-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": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Shopify stores (or collections)", "type": "array", "description": "One store per line, e.g. \"https://www.allbirds.com\" or just \"gymshark.com\". To scrape only one collection, paste its URL, e.g. \"https://www.allbirds.com/collections/mens\".", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "How many products to read from each store. Use 0 for the whole catalog (recommended for monitoring, so removed products can be detected).", "default": 0 }, "rowPerVariant": { "title": "One row per variant (size, color, SKU)", "type": "boolean", "description": "Off: one row per product with all variants inside. On: one row per variant with its own SKU, price and stock, best for spreadsheets and SKU-level price tracking.", "default": false }, "onlyChanges": { "title": "Monitor mode: return only what changed since the last run", "type": "boolean", "description": "Returns only new products, price drops, price increases, back in stock, sold out and removed products. Unchanged products are not returned, so you pay only the small checking fee. The first run returns the full catalog as the baseline. Schedule the Actor daily to get a change feed.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Changes are compared with the last run that used the same monitor name. Use different names if you track the same store in separate schedules.", "default": "default" }, "keywords": { "title": "Keywords", "type": "array", "description": "Only return products whose title, tags, type, vendor or SKU contain any of these words. Leave empty for all products.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only return products that cost at least this much (in the store's currency). Leave empty for no limit." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only return products that cost at most this much (in the store's currency). Leave empty for no limit." }, "onlyOnSale": { "title": "Only products on sale", "type": "boolean", "description": "Only return products with a crossed-out \"compare at\" price higher than the current price.", "default": false }, "onlyInStock": { "title": "Only products in stock", "type": "boolean", "description": "Skip sold-out products.", "default": false }, "includeDescription": { "title": "Include product description", "type": "boolean", "description": "Adds the product description as plain text. Turn off for smaller, faster exports.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Stores are requested directly first and through Apify Proxy only when needed. Switch to RESIDENTIAL only if a store keeps blocking requests.", "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 } } } } } } } } } }