{ "openapi": "3.0.1", "info": { "title": "Shopify Price & Stock Delta Monitor", "description": "Monitor Shopify stores via products.json for MAP compliance, repricing, competitor price drops, stock changes, and clean delta feeds with optional Slack/Discord alerts.", "version": "0.3", "x-build-id": "qcgsMYYFYAmfJzXqR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stellar_ballet_0bu~shopify-delta-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stellar_ballet_0bu-shopify-delta-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/stellar_ballet_0bu~shopify-delta-monitor/runs": { "post": { "operationId": "runs-sync-stellar_ballet_0bu-shopify-delta-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/stellar_ballet_0bu~shopify-delta-monitor/run-sync": { "post": { "operationId": "run-sync-stellar_ballet_0bu-shopify-delta-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 store URLs", "type": "array", "description": "Shopify store home/category/product URLs. The Actor will try /products.json on each host.", "items": { "type": "string" } }, "previousItems": { "title": "Previous items", "type": "array", "description": "Optional previous dataset items from an earlier run. Used to compute deltas.", "default": [] }, "maxPagesPerStore": { "title": "Max products.json pages per store", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of /products.json pages to fetch per store. Each page can contain up to 250 products.", "default": 3 }, "onlyChanged": { "title": "Only output changed items", "type": "boolean", "description": "If enabled, rows with status unchanged are skipped. New, changed, removed, and error rows are still emitted.", "default": true }, "persistState": { "title": "Persist state between runs", "type": "boolean", "description": "Store the latest snapshot in a named key-value store so scheduled runs automatically emit only deltas next time.", "default": true }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store used for snapshots when persistState is enabled.", "default": "shopify-delta-monitor-state" }, "stateKey": { "title": "State key override", "type": "string", "description": "Optional snapshot key. Leave empty to use one key per Shopify store host.", "default": "" }, "minPriceChangePct": { "title": "Minimum price change %", "minimum": 0, "type": "number", "description": "Minimum absolute percentage price change needed to emit a price_change event. Set 0 to report every price change.", "default": 0 }, "alertsEnabled": { "title": "Send webhook alert summary", "type": "boolean", "description": "If enabled and a Slack or Discord webhook URL is provided, the Actor posts one summary message after the run.", "default": false }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Optional Slack incoming webhook URL. Kept secret by Apify input UI." }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Optional Discord webhook URL. Kept secret by Apify input UI." }, "alertTopLimit": { "title": "Top changes in alert", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of top delta rows included in the Slack/Discord alert summary.", "default": 5 } } }, "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 } } } } } } } } } }