{ "openapi": "3.0.1", "info": { "title": "Shopify Price & Sale Monitor — Track Price Drops, Sales & Stock", "description": "Monitor any Shopify store and get only what CHANGED since the last run — price drops/rises, sales started/ended, new & removed products and variants, sell-outs and restocks. Schedule it; pay per change. Pure HTTP, no login.", "version": "0.1", "x-build-id": "P7hkLTcn7vEo2pqRa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bisketapis~shopify-price-sale-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bisketapis-shopify-price-sale-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/bisketapis~shopify-price-sale-monitor/runs": { "post": { "operationId": "runs-sync-bisketapis-shopify-price-sale-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/bisketapis~shopify-price-sale-monitor/run-sync": { "post": { "operationId": "run-sync-bisketapis-shopify-price-sale-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": "Store URLs", "type": "array", "description": "Shopify store URLs or bare domains to monitor, e.g. https://www.allbirds.com. The first run on a store records a baseline (no changes billed); every run after it reports what changed since the previous run.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "monitor", "baseline" ], "type": "string", "description": "monitor (default): report changes since the last run. baseline: just (re)record the current catalog as the new starting point and emit nothing — use it to seed a store or reset after big intentional changes.", "default": "monitor" }, "changeTypes": { "title": "Change types to report", "type": "array", "description": "Limit output to these change types. Leave empty to report all of them.", "items": { "type": "string", "enum": [ "price_drop", "price_increase", "sale_started", "sale_ended", "new_product", "new_variant", "removed", "sold_out", "restocked" ], "enumTitles": [ "Price drop", "Price increase", "Sale started", "Sale ended", "New product", "New variant", "Removed", "Sold out", "Restocked" ] }, "default": [] }, "minPriceChangePct": { "title": "Minimum price change (%)", "minimum": 0, "type": "integer", "description": "Suppress price changes smaller than this percentage (noise filter). 0 = report every price change. Does not affect sale or stock changes.", "default": 0 }, "collectionHandles": { "title": "Collection handles (optional)", "type": "array", "description": "If set, monitor only these collections via /collections//products.json instead of the whole store. Useful for splitting very large catalogs.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Cap the number of products read per store (0 = unlimited).", "default": 0 }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "type": "integer", "description": "Politeness delay between page requests.", "default": 200 } } }, "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 } } } } } } } } } }