{ "openapi": "3.0.1", "info": { "title": "Shopify Price-Drop & Restock Monitor", "description": "Monitor public Shopify product feeds for price drops, price increases, restocks, out-of-stock changes, new products, and removed variants using stateful change detection.", "version": "0.1", "x-build-id": "xTJEJ1LuGmtxdIn24" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/catalini82~shopify-price-restock-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-catalini82-shopify-price-restock-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/catalini82~shopify-price-restock-monitor/runs": { "post": { "operationId": "runs-sync-catalini82-shopify-price-restock-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/catalini82~shopify-price-restock-monitor/run-sync": { "post": { "operationId": "run-sync-catalini82-shopify-price-restock-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": { "stores": { "title": "Shopify stores", "minItems": 1, "maxItems": 100, "type": "array", "description": "Public Shopify store URLs or domains to monitor. The Actor uses only each store's public /products.json feed when available.", "items": { "type": "string", "minLength": 1 }, "default": [ "https://example-store.myshopify.com", "https://www.example-brand.com" ] }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum products to fetch and store per Shopify store. State is bounded by this value.", "default": 250 }, "maxItems": { "title": "Max output items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum change or snapshot rows to write to the default dataset.", "default": 500 }, "mode": { "title": "Mode", "enum": [ "changes", "snapshot", "both" ], "type": "string", "description": "changes compares against persistent state and emits change events. snapshot emits the current normalized feed. both emits change events plus snapshot rows.", "default": "changes" }, "stateKey": { "title": "State key", "minLength": 1, "maxLength": 80, "type": "string", "description": "State namespace for this monitoring setup. Use a unique value per saved task or monitoring workflow.", "default": "default" }, "emitInitialSnapshotAsNew": { "title": "Emit initial snapshot as new", "type": "boolean", "description": "When no previous state exists, emit current products and variants as initial_snapshot rows instead of silently saving a baseline.", "default": true }, "includeUnchanged": { "title": "Include unchanged", "type": "boolean", "description": "In changes mode, also emit unchanged product/variant rows. Usually keep this off for monitoring tasks.", "default": false }, "includeFullProductData": { "title": "Include full normalized product data", "type": "boolean", "description": "Attach compact normalized product and variant data to each row. Raw descriptions are not stored or emitted.", "default": false }, "priceDropThresholdPercent": { "title": "Price drop threshold percent", "minimum": 0, "maximum": 1000, "type": "number", "description": "Minimum percent decrease required to mark a price_drop event. Use 0 to emit every detected decrease.", "default": 0 }, "priceIncreaseThresholdPercent": { "title": "Price increase threshold percent", "minimum": 0, "maximum": 1000, "type": "number", "description": "Minimum percent increase required to mark a price_increase event. Use 0 to emit every detected increase.", "default": 0 }, "onlyProductsMatching": { "title": "Only products matching", "maxItems": 100, "type": "array", "description": "Optional terms matched against product title, handle, vendor, product type, tags, variant title, and SKU.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "excludeProductsMatching": { "title": "Exclude products matching", "maxItems": 100, "type": "array", "description": "Optional terms used to remove matching products before diffing and saving state.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "requestDelayMs": { "title": "Request delay ms", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay between paginated products.json requests for the same store.", "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 } } }, "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 } } } } } } } } } }