{ "openapi": "3.0.1", "info": { "title": "Price Drop & Stock Monitor: Shopify & WooCommerce Alerts", "description": "Watch any Shopify or WooCommerce store and get a row for every price drop or increase, sell-out, restock, launch and removal since the last run. Schedule it and pipe changes anywhere. First run builds a free baseline; you only pay per product checked and per real change found.", "version": "0.1", "x-build-id": "2t28quOgdyx2wUxFu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/f0rty7even~price-drop-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-f0rty7even-price-drop-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/f0rty7even~price-drop-monitor/runs": { "post": { "operationId": "runs-sync-f0rty7even-price-drop-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/f0rty7even~price-drop-monitor/run-sync": { "post": { "operationId": "run-sync-f0rty7even-price-drop-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": "Stores to monitor", "type": "array", "description": "Shopify or WooCommerce store URLs, one per line. The platform is detected automatically. For a huge Shopify store, paste a /collections/... URL to monitor just that collection instead of the whole catalog.", "items": { "type": "string" } }, "platform": { "title": "Platform", "enum": [ "auto", "shopify", "woocommerce" ], "type": "string", "description": "Skip auto-detection when you already know what the stores run. Every store in one run must then be that platform.", "default": "auto" }, "trackPriceDrops": { "title": "Report price drops", "type": "boolean", "description": "A row whenever an offer got cheaper since the last run.", "default": true }, "trackPriceIncreases": { "title": "Report price increases", "type": "boolean", "description": "A row whenever an offer got more expensive since the last run.", "default": true }, "trackStockChanges": { "title": "Report sell-outs and restocks", "type": "boolean", "description": "A row whenever an offer went out of stock or came back in stock since the last run.", "default": true }, "trackNewProducts": { "title": "Report new products", "type": "boolean", "description": "A row for every offer that appeared in the catalog since the last run.", "default": true }, "trackRemovedProducts": { "title": "Report removed products", "type": "boolean", "description": "A row for every offer that disappeared from the catalog since the last run. These rows carry the last known price rather than fresh data.", "default": true }, "minPriceChangePct": { "title": "Minimum price change (%)", "minimum": 0, "maximum": 95, "type": "integer", "description": "Ignore price moves smaller than this percentage. Small moves are remembered, not discarded: once a price has drifted past the threshold in total, one change fires with the original price as the old price. 0 reports every change, however small.", "default": 0 }, "includeUnchanged": { "title": "Include unchanged offers", "type": "boolean", "description": "Also push a row for every offer that did NOT change, so each run doubles as a full catalog snapshot. Unchanged rows are never billed as changes.", "default": false }, "maxProductsPerStore": { "title": "Max products per store (spend cap)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard stop per store. IMPORTANT: a store that hits this cap is fetched partially, and a partial catalog cannot be compared against the last run, so no changes are reported or charged for it. Set it above the store's catalog size, or monitor a collection URL.", "default": 5000 }, "stateStoreName": { "title": "Baseline store", "type": "string", "description": "Name of the key-value store holding each store's baseline between runs. The default is fine. Change it only to keep two schedules from overwriting each other, for example an hourly and a daily run over the same stores.", "default": "price-monitor-state" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Both platforms throttle datacenter IPs, so Apify Proxy (residential) is on by default and recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }