{ "openapi": "3.0.1", "info": { "title": "Shopify Price & Stock Change Monitor", "description": "Watches Shopify stores and returns only what changed since the last run: price drops, price rises, out-of-stock, back-in-stock, new and removed products.", "version": "0.1", "x-build-id": "N3Jn6ibhvtgKCynrX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/duffy1990~shopify-price-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-duffy1990-shopify-price-change-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/duffy1990~shopify-price-change-monitor/runs": { "post": { "operationId": "runs-sync-duffy1990-shopify-price-change-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/duffy1990~shopify-price-change-monitor/run-sync": { "post": { "operationId": "run-sync-duffy1990-shopify-price-change-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": [ "shopUrls" ], "properties": { "shopUrls": { "title": "Shopify store URLs", "type": "array", "description": "Stores to watch. Paste the storefront URL or just the domain, e.g. https://www.deathwishcoffee.com or allbirds.com. Only real Shopify stores work — the Actor verifies this and tells you if a URL is not Shopify.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "changes", "snapshot" ], "type": "string", "description": "changes = return only what changed since the previous run (needs at least two runs). snapshot = return the full current catalog, one row per variant.", "default": "changes" }, "watch": { "title": "What to watch", "type": "array", "description": "Change types to report. Unchecking types you do not need reduces your bill, because you are charged per reported change.", "items": { "type": "string", "enum": [ "price", "availability", "new", "removed", "title" ], "enumTitles": [ "Price changes", "Stock availability", "New products", "Removed products", "Title changes" ] }, "default": [ "price", "availability", "new", "removed", "title" ] }, "minPriceChangePct": { "title": "Minimum price change (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Ignore price moves smaller than this, to filter out noise. 0 reports every change.", "default": 0 }, "direction": { "title": "Price direction", "enum": [ "any", "down", "up" ], "type": "string", "description": "Report only drops, only rises, or both.", "default": "any" }, "maxProductsPerShop": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Safety brake for very large catalogs. 0 means no limit. Note: if you set a limit, products beyond it are invisible to the Actor and are NOT reported as removed.", "default": 0 }, "maxChangesPerShop": { "title": "Max changes reported per store", "minimum": 0, "type": "integer", "description": "Safety brake against bill shock. A site-wide sale can change thousands of prices at once; this caps how many change rows one store can produce in one run. Extra changes are dropped and a note is added to the run log. 0 means no limit.", "default": 0 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store that remembers the previous catalog. Runs that should be compared to each other must use the SAME name. Use different names to watch the same store on independent schedules.", "default": "shopify-watch-state" }, "resetState": { "title": "Reset remembered state", "type": "boolean", "description": "Forget everything and start over. The next run after this one will be the first one again, so it will report no changes.", "default": false }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Pause between page requests to the same store. Polite crawling; lower values risk HTTP 429.", "default": 300 } } }, "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 } } } } } } } } } }