{ "openapi": "3.0.1", "info": { "title": "Shopify product scraper: price and stock monitor", "description": "Monitor public Shopify catalogs for product and variant price, availability, new-product, restock, and removal changes. Export structured catalog events for competitor tracking, dropshipping research, and price intelligence in CSV or JSON. No store login or API key.", "version": "1.0", "x-build-id": "wdKzlZ8WKPjepEIY8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~shopify-store-product-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-shopify-store-product-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/getascraper~shopify-store-product-monitor/runs": { "post": { "operationId": "runs-sync-getascraper-shopify-store-product-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/getascraper~shopify-store-product-monitor/run-sync": { "post": { "operationId": "run-sync-getascraper-shopify-store-product-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": "Public Shopify stores", "minItems": 1, "maxItems": 25, "type": "array", "description": "Public storefront URLs or domains. No API keys, Storefront tokens, OAuth, cookies, owner credentials, or pasted JSON are accepted or needed.", "items": { "type": "string" }, "default": [ "https://deathwishcoffee.com" ] }, "includeVariants": { "title": "Include variant details", "type": "boolean", "description": "Keep variant IDs, SKUs, prices, compare-at prices, options, and available flags for variant-level events.", "default": true }, "maxProductsPerStore": { "title": "Maximum products per store", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum products retained from each store. Reaching this bound makes that store scan partial for removal detection.", "default": 250 }, "maxPages": { "title": "Maximum catalog pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum products.json pages fetched per store. Reaching this bound leaves that store partial.", "default": 10 }, "outputMode": { "title": "Output mode", "enum": [ "full", "changes_only" ], "type": "string", "description": "Return every observed product or only rows with lifecycle, price, stock, or variant events.", "default": "full" }, "stateName": { "title": "State name", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$", "type": "string", "description": "Name of the saved comparison stream. Use a different name for independent store sets.", "default": "shopify-default" }, "pageSize": { "title": "Products per page", "minimum": 1, "maximum": 250, "type": "integer", "description": "Requested products per products.json page. Shopify observed a maximum of 250 on live canaries.", "default": 250 }, "requestDelayMs": { "title": "Delay between requests", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay before each public catalog request in milliseconds. Keep a respectful pace for each independent storefront.", "default": 1000 }, "requestTimeoutMs": { "title": "Request timeout", "minimum": 1000, "maximum": 120000, "type": "integer", "description": "Timeout for one public catalog request in milliseconds.", "default": 20000 }, "maxRetries": { "title": "Retry attempts", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for timeouts, rate limits, and 5xx responses. Authentication is never requested.", "default": 3 } } }, "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 } } } } } } } } } }