{ "openapi": "3.0.1", "info": { "title": "Shopify Price & Restock Monitor", "description": "Monitor a Shopify product shortlist. Export variant-level prices, availability and before/after changes. Public available is not warehouse inventory.", "version": "0.1", "x-build-id": "HaUFYZY97nw9dq2Xm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/atlasi~shopify-price-restock-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-atlasi-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/atlasi~shopify-price-restock-monitor/runs": { "post": { "operationId": "runs-sync-atlasi-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/atlasi~shopify-price-restock-monitor/run-sync": { "post": { "operationId": "run-sync-atlasi-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", "required": [ "productUrls" ], "properties": { "productUrls": { "title": "Product URLs", "minItems": 1, "maxItems": 500, "type": "array", "description": "1–500 HTTPS Shopify product pages, not homepages or collection pages. Duplicate products are checked once. A ?variant=ID selects an option; choose Selected options only below to limit output and changes.", "items": { "type": "string" } }, "watchId": { "title": "Watch ID", "pattern": "^[\\w.-]{0,100}$", "type": "string", "description": "Leave blank in a Saved Task to use its unique Task ID. Manual/API monitor runs require your own ID. Keep it for repeated checks; use a different ID per customer/list. When copying a Task, clear the old explicit ID." }, "mode": { "title": "Mode", "enum": [ "monitor", "snapshot" ], "type": "string", "description": "Snapshot reads/writes no baseline. Monitor requires watchId or a Saved Task ID.", "default": "monitor" }, "minPriceChangePct": { "title": "Minimum price change (%)", "minimum": 0, "type": "number", "description": "Only price drop/increase events use this threshold. Discount and availability events are unaffected. The baseline still advances after a filtered change.", "default": 0 }, "changeTypes": { "title": "Change types", "type": "array", "description": "Choose report events. Filtering does not change product-check billing.", "items": { "type": "string", "enum": [ "price_drop", "price_increase", "discount_changed", "became_available", "became_unavailable" ] }, "default": [ "price_drop", "price_increase", "discount_changed", "became_available", "became_unavailable" ] }, "variantScope": { "title": "Options to monitor", "enum": [ "all", "selected" ], "type": "string", "description": "Selected mode limits output and change events to variant IDs in your URLs. Products without variant IDs still include all options. The full product baseline and per-product billing remain unchanged. Missing selected IDs are a free partial check.", "default": "all" } } }, "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 } } } } } } } } } }