{ "openapi": "3.0.1", "info": { "title": "Shopify & WooCommerce Price Monitor - Price & Stock Tracker", "description": "Shopify price monitor and WooCommerce price tracker: paste competitor shops, get every product price and stock as Excel. Run on a schedule to see only changes: price drops and increases, back in stock, out of stock, new and removed products.", "version": "0.1", "x-build-id": "ULOA9RovgC6AlLIZP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alpine-data~shop-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alpine-data-shop-price-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/alpine-data~shop-price-monitor/runs": { "post": { "operationId": "runs-sync-alpine-data-shop-price-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/alpine-data~shop-price-monitor/run-sync": { "post": { "operationId": "run-sync-alpine-data-shop-price-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", "properties": { "shops": { "title": "1. Which shops? (Shopify or WooCommerce website)", "type": "array", "description": "One shop per line (commas also work). Paste a website with or without https, e.g. allbirds.com, https://porterandyork.com or yourshop.myshopify.com. You can also paste single product links (shop.com/products/name for Shopify, shop.com/product/name for WooCommerce) to watch only those products. Up to 500 shops per run.", "items": { "type": "string" } }, "outputMode": { "title": "2. What do you want back?", "enum": [ "all", "only_changes" ], "type": "string", "description": "All products = the full price list every run, with the change since the last run in the 'Change' column. Only changes = just new products, removed products, price up/down and stock changes (cheapest for daily monitoring). Billing of the first run (baseline): All products charges every row as a product row ($0.00075); Only changes returns no rows and charges nothing. Later: $0.0075 per change, unchanged rows $0.00075 (All products) or free (Only changes).", "default": "all" }, "rowLevel": { "title": "3. One row per product or per variant?", "enum": [ "product", "variant" ], "type": "string", "description": "Product = one row per product with the lowest price and 'in stock if any variant is available'. Variant = one row per size/colour/SKU (more rows, more detail).", "default": "product" }, "maxProductsPerShop": { "title": "Max products per shop", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Cost cap per shop. Pre-filled with 50 to keep the first test cheap; raise it (up to 50,000) to watch the whole catalogue. Removed products are only reported when the whole catalogue fits under this cap.", "default": 1000 }, "titleKeywords": { "title": "Product name contains (any of)", "type": "array", "description": "Keep only products whose name (or variant name) contains at least one of these words, e.g. jacket, steak, 500ml.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Product name must NOT contain", "type": "array", "description": "Drop products whose name contains any of these words, e.g. gift card, sample.", "items": { "type": "string" } }, "vendorOrCategory": { "title": "Brand, category or tag contains (any of)", "type": "array", "description": "Keep only products whose brand/vendor, product type/category or tags contain one of these, e.g. Nike, Beef, sale.", "items": { "type": "string" } }, "onlyInStock": { "title": "Only products in stock", "type": "boolean", "description": "Skip products that are currently sold out (an 'out of stock' change is still reported).", "default": false }, "minPriceChangePct": { "title": "Ignore price changes smaller than (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "0 = report every price change. Example: 5 reports only changes of 5% or more.", "default": 0 }, "reportRemoved": { "title": "Report removed products", "type": "boolean", "description": "Add one row with change 'removed' when a product from the last run is gone from the shop.", "default": true }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Optional. Use different names to keep separate monitors for the same shops (e.g. 'daily' and 'weekly'). Letters, numbers and dashes." }, "includeDescription": { "title": "Include product description text", "type": "boolean", "description": "Adds the plain-text product description (max 3,000 characters). Descriptions are written by the shop and protected by copyright: use them for your own analysis only.", "default": false }, "platform": { "title": "Shop platform", "enum": [ "auto", "shopify", "woocommerce" ], "type": "string", "description": "Leave on Auto-detect. Only change it if detection picks the wrong platform.", "default": "auto" }, "proxyConfiguration": { "title": "Proxy (only if a shop blocks or rate-limits you)", "type": "object", "description": "Leave off. Turn on Apify Proxy only if a shop answers 'too many requests' (HTTP 429) again and again. Proxy traffic is billed by Apify to your account.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }