{ "openapi": "3.0.1", "info": { "title": "Shopify Product & Price Monitor: Catalog + Stock Alerts", "description": "Scrape any Shopify store's catalog (every variant's price, sale price, stock, SKU, images) or monitor it: get only price drops, increases, restocks, sell-outs, new and removed products since the last run. Multi-store, no browser.", "version": "1.0", "x-build-id": "UrfI4pWxw4nw5UjCa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hydrocore~shopify-product-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hydrocore-shopify-product-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/hydrocore~shopify-product-monitor/runs": { "post": { "operationId": "runs-sync-hydrocore-shopify-product-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/hydrocore~shopify-product-monitor/run-sync": { "post": { "operationId": "run-sync-hydrocore-shopify-product-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", "type": "array", "description": "One store per line. Accepts a domain (allbirds.com), a homepage URL (https://www.allbirds.com) or a collection URL (https://colourpop.com/collections/lips) to fetch only that collection. Works with any Shopify store that serves its public /products.json catalog; stores that don't are reported in RUN_SUMMARY and never charged.", "items": { "type": "string" } }, "monitorChanges": { "title": "Monitor changes (only output what changed)", "type": "boolean", "description": "Off: output the catalog. On: compare with the previous run and output only change rows (price drop/increase, back in stock, out of stock, new product, new variant, removed product). The first run of each store saves a baseline silently. Schedule it (e.g. every 6 hours) to get a change feed. You pay only for changes.", "default": false }, "changeTypes": { "title": "Change types to report", "type": "array", "description": "Which changes to output in monitoring mode. Leave all selected for a full change feed, or keep only price_drop for deal alerts, back_in_stock for restock alerts, etc.", "items": { "type": "string", "enum": [ "new_product", "removed_product", "new_variant", "price_drop", "price_increase", "back_in_stock", "out_of_stock" ], "enumTitles": [ "New product", "Removed product", "New variant", "Price drop", "Price increase", "Back in stock", "Out of stock" ] }, "default": [ "new_product", "removed_product", "new_variant", "price_drop", "price_increase", "back_in_stock", "out_of_stock" ] }, "minPriceChangePercent": { "title": "Minimum price change (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Ignore price changes smaller than this percentage (0 = report every change).", "default": 0 }, "outputCatalogOnFirstRun": { "title": "Also output the full catalog on the first run", "type": "boolean", "description": "By default the first monitoring run of a store only saves a baseline (nothing is output or charged). Turn on to also get the full catalog in that first run (charged per row).", "default": false }, "monitoringStoreName": { "title": "Monitoring memory name", "type": "string", "description": "Name of the key-value store that remembers the last snapshot of each store. Use a different name for each saved task or watchlist.", "default": "shopify-product-monitor" }, "outputLevel": { "title": "Output level (catalog mode)", "enum": [ "product", "variant" ], "type": "string", "description": "One row per product (variants nested in a 'variants' array), or one row per variant (size/color) with product fields flattened, which is best for spreadsheets and price comparison. Each row is one charged result.", "default": "product" }, "descriptionFormat": { "title": "Product description", "enum": [ "text", "html", "both", "none" ], "type": "string", "description": "Plain text is best for spreadsheets and AI pipelines; HTML keeps the original formatting; None makes rows smaller.", "default": "text" }, "keywords": { "title": "Keywords (any)", "type": "array", "description": "Keep products whose title, product type, vendor or tags contain ANY of these words (case-insensitive). Empty = all products.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude title keywords", "type": "array", "description": "Drop products whose title contains any of these words, e.g. gift card, sample.", "default": [], "items": { "type": "string" } }, "vendors": { "title": "Vendors / brands (exact, any)", "type": "array", "description": "Keep only these vendors (exact match, case-insensitive). Useful for multi-brand retailers.", "default": [], "items": { "type": "string" } }, "productTypes": { "title": "Product types (exact, any)", "type": "array", "description": "Keep only these product types (exact match, case-insensitive), e.g. Shoes, Coffee.", "default": [], "items": { "type": "string" } }, "tags": { "title": "Tags (any)", "type": "array", "description": "Keep products that have ANY of these tags (exact tag, case-insensitive).", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Keep products with at least one variant priced at or above this (store currency)." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Keep products with at least one variant priced at or below this (store currency)." }, "onlyAvailable": { "title": "In-stock products only", "type": "boolean", "description": "Catalog mode: keep only products with at least one variant in stock. (Ignored in monitoring mode so sell-outs are still reported.)", "default": false }, "onlyOnSale": { "title": "On-sale products only", "type": "boolean", "description": "Catalog mode: keep only products where a variant has a compare-at price above its price. (Ignored in monitoring mode.)", "default": false }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Fetch at most this many products per store (0 = whole catalog). In monitoring mode a partial catalog disables removed-product detection.", "default": 0 }, "maxResults": { "title": "Max results in total", "minimum": 0, "type": "integer", "description": "Stop after saving this many rows across all stores. 0 = no limit (your 'Max cost per run' still applies).", "default": 0 }, "requestDelayMs": { "title": "Delay between requests to one store (ms)", "minimum": 200, "maximum": 10000, "type": "integer", "description": "Politeness delay between page requests to the same store (robots.txt Crawl-delay is honored if larger). Stores are fetched in parallel, pages of one store one at a time.", "default": 500 } } }, "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 } } } } } } } } } }