{ "openapi": "3.0.1", "info": { "title": "Shopify Price, Stock & Catalog Monitor — Batch + Diff", "description": "Competitor price tracking for Shopify stores: batch of store domains, diff mode returns only CHANGE EVENTS (price, stock, new/removed products) plus a free per-store summary every run. Public /products.json feed — no login, no browser. Not affiliated with Shopify.", "version": "0.1", "x-build-id": "yN6B9c8G1Lj0nKlre" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/johnatan029~shopify-price-catalog-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-johnatan029-shopify-price-catalog-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/johnatan029~shopify-price-catalog-monitor/runs": { "post": { "operationId": "runs-sync-johnatan029-shopify-price-catalog-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/johnatan029~shopify-price-catalog-monitor/run-sync": { "post": { "operationId": "run-sync-johnatan029-shopify-price-catalog-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": "Stores (domains)", "type": "array", "description": "1–50 store domains or URLs (e.g. \"gymshark.com\" or \"https://www.gymshark.com\"). Protocol, www and paths are stripped automatically. Headless storefronts (no /products.json) and password-protected stores become a controlled status without stopping the batch.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "monitor", "snapshot" ], "type": "string", "description": "monitor (default): diff vs the previous run — only change events are charged; first visit of a store creates a free baseline. snapshot: full catalog export, one record per product.", "default": "monitor" }, "collectionHandle": { "title": "Collection handle (optional)", "type": "string", "description": "Monitor only one collection instead of the whole catalog — the handle from the collection URL (e.g. \"best-sellers\" in /collections/best-sellers). Applies to every store in the batch. Monitor state is kept per store+collection, so switching this does not corrupt the full-catalog diff." }, "eventTypes": { "title": "Event types (monitor)", "type": "array", "description": "Which change events to emit. Default: all of PRICE_CHANGE, STOCK_CHANGE, NEW_PRODUCT, REMOVED_PRODUCT, NEW_VARIANT.", "items": { "type": "string", "enum": [ "PRICE_CHANGE", "STOCK_CHANGE", "NEW_PRODUCT", "REMOVED_PRODUCT", "NEW_VARIANT" ] }, "default": [ "PRICE_CHANGE", "STOCK_CHANGE", "NEW_PRODUCT", "REMOVED_PRODUCT", "NEW_VARIANT" ] }, "minPriceDeltaPct": { "title": "Minimum price change (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Ignore PRICE_CHANGE events smaller than this absolute percentage (0 = report every change). Filtered events cost nothing.", "default": 0 }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Safety cap per store (250 products per page are fetched until the catalog ends or this cap is reached).", "default": 5000 }, "maxResults": { "title": "Max charged records per run", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Global cap on charged records (events or products). Free per-store summaries do not count. If the cap truncates a store's events, that store's diff state is NOT advanced, so nothing is silently lost.", "default": 5000 }, "pageDelayMs": { "title": "Delay between pages (ms)", "minimum": 250, "maximum": 5000, "type": "integer", "description": "Polite pacing between catalog pages of the same store. The 250 ms floor is deliberate.", "default": 500 }, "proxyConfiguration": { "title": "Proxy (optional)", "type": "object", "description": "Off by default — the public feed answers without proxies. Reserved for future use; the Actor never uses proxies to work around a store that blocked it (403/430 becomes a controlled status instead)." }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Verbose logs.", "default": false } } }, "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 } } } } } } } } } }