{ "openapi": "3.0.1", "info": { "title": "Shopify Store Monitor: Price Drops, Stock & New Products", "description": "Track any Shopify store or collection. Get price drops, price increases, back-in-stock, sold-out, new and removed products since your last run, or export the full product catalog with variants, SKUs and prices. No login.", "version": "0.1", "x-build-id": "zlX6fIlqO01dHE4Sc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/developing_developer~shopify-store-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-developing_developer-shopify-store-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/developing_developer~shopify-store-monitor/runs": { "post": { "operationId": "runs-sync-developing_developer-shopify-store-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/developing_developer~shopify-store-monitor/run-sync": { "post": { "operationId": "run-sync-developing_developer-shopify-store-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": [ "stores" ], "properties": { "stores": { "title": "Shopify stores or collections", "type": "array", "description": "Store domains or URLs, e.g. \"allbirds.com\" or \"https://www.gymshark.com\". Paste a collection URL (\".../collections/sale\") to track only that collection. Stores that block bots or are password-protected are skipped and listed in the run summary.", "items": { "type": "string" } }, "monitorChanges": { "title": "Monitor changes", "type": "boolean", "description": "Off: return every product (full catalog). On: return only what changed since the previous run with the same monitor name: price drops, price increases, back in stock, out of stock, new and removed products. The first run saves a snapshot and returns nothing. Use with a schedule.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Separate monitors keep separate snapshots. Use letters, numbers and hyphens.", "default": "default" }, "changeTypes": { "title": "Change types", "type": "array", "description": "Return only these change types. Leave empty for all.", "items": { "type": "string", "enum": [ "price_drop", "price_increase", "back_in_stock", "out_of_stock", "new_product", "removed_product" ], "enumTitles": [ "Price drop", "Price increase", "Back in stock", "Out of stock", "New product", "Removed product" ] } }, "minPriceChangePercent": { "title": "Minimum price change (%)", "minimum": 0, "type": "integer", "description": "Ignore price changes smaller than this percentage. 0 = report every change.", "default": 0 }, "keywords": { "title": "Title keywords", "type": "array", "description": "Keep products whose title contains at least one of these words (case-insensitive).", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude title keywords", "type": "array", "description": "Drop products whose title contains any of these words, e.g. \"gift card\".", "items": { "type": "string" } }, "vendors": { "title": "Vendors (brands)", "type": "array", "description": "Keep products from these vendors only (exact name, case-insensitive).", "items": { "type": "string" } }, "productTypes": { "title": "Product types", "type": "array", "description": "Keep products of these types only (exact name, case-insensitive), e.g. \"Shoes\".", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Keep products whose lowest variant price is at least this, in the store currency. 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Keep products whose lowest variant price is at most this. 0 = no maximum.", "default": 0 }, "onlyAvailable": { "title": "Only in-stock products", "type": "boolean", "description": "Catalog mode only: keep products with at least one variant in stock. In monitor mode use change types instead.", "default": false }, "includeDescription": { "title": "Include product description", "type": "boolean", "description": "Catalog mode: add the description as HTML and plain text. Makes results larger.", "default": false }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many products or changes. 0 = no limit. In monitor mode, changes over the limit are reported in the next run.", "default": 0 } } }, "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 } } } } } } } } } }