# Ecommerce Catalog Price Change Monitor for Shopify/WooCommerce (`isotonic/ecommerce-catalog-price-change-monitor`) Actor Captures public Shopify and WooCommerce catalog snapshots and emits product and variant price change rows. - **URL**: https://apify.com/isotonic/ecommerce-catalog-price-change-monitor.md - **Developed by:** [Brian Keefe](https://apify.com/isotonic) (community) - **Categories:** E-commerce, Automation, Business - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Ecommerce Catalog Price Change Monitor for Shopify/WooCommerce Apify Actor that captures public ecommerce catalog snapshots and emits normalized product and variant rows for price-change monitoring. ### What it does - Accepts `storeUrls` and/or `domains` - Detects Shopify and WooCommerce storefronts from public pages and endpoints - Uses Shopify `products.json` pagination as the primary source when public - Uses WooCommerce `wp-json/wc/store/v1/products` as the primary source when public - Falls back to sitemap, collection/category, and product pages with public schema markup when API-style endpoints are unavailable - Emits current snapshot rows and optional delta fields against a supplied prior snapshot ### Public data only - No login, cart, checkout, account, or admin access - No private APIs - Only public storefront HTML, sitemap XML, and public JSON endpoints ### Input ```json { "storeUrls": [ "https://demo-shop.example", "https://demo-woo.example" ], "maxProducts": 250, "compareToPreviousDataset": true, "previousSnapshot": [ { "storeUrl": "https://demo-shop.example", "platform": "shopify", "rowType": "variant", "handle": "trail-coffee-beans", "sku": "TRAIL-1", "sourceUrl": "https://demo-shop.example/products/trail-coffee-beans", "title": "Trail Coffee Beans - Single Bag", "price": 19, "compareAtPrice": 24, "availability": "in_stock" } ], "includeVariants": true } ```` Notes: - `storeUrls` can include subpaths, which is useful for local fixture testing. - `domains` are normalized to `https://`. - `previousSnapshot` is an inline array of rows from a prior run. Use it with `compareToPreviousDataset` for deterministic delta fields. - `compareToPreviousDataset` is optional. Delta fields are produced whenever a usable `previousSnapshot` is supplied. ### Output Each dataset item is one `product` or `variant` snapshot row. Key fields: - `storeUrl`, `domain`, `platform` - `snapshotTimestamp`, `rowType` - `title`, `handle`, `sku` - `price`, `compareAtPrice`, `markdownPercent` - `availability` - `collection`, `category` - `imageUrl`, `sourceUrl` - `previousPrice`, `previousCompareAtPrice`, `previousAvailability` - `priceDelta`, `compareAtDelta`, `priceChanged`, `availabilityChanged`, `deltaStatus` See `examples/sample-output.json` for a representative snapshot. ### Local development Install dependencies: ```bash npm install ``` Run deterministic offline smoke tests: ```bash npm test ``` Run locally with Apify CLI: ```bash npx --yes apify-cli run --purge --input-file examples/sample-input.json ``` ### Implementation notes - Shopify extraction prioritizes `/products.json` pagination and then enriches from sitemap and public product/collection pages. - WooCommerce extraction uses the public Store API when available and falls back to public schema/product pages when it is not. - Smoke tests use a local HTTP fixture server, so `npm test` does not require internet access. # Actor input Schema ## `storeUrls` (type: `array`): Storefront base URLs to monitor. Subpaths are supported for local testing and reverse-proxied stores. ## `domains` (type: `array`): Optional bare domains. The actor normalizes them to HTTPS store URLs. ## `maxProducts` (type: `integer`): Maximum products fetched per store before pagination stops. ## `compareToPreviousDataset` (type: `boolean`): When enabled alongside `previousSnapshot`, attaches price and availability delta fields to the current snapshot rows. ## `previousSnapshot` (type: `array`): Optional previous snapshot rows used for deterministic delta fields. Paste rows from a prior run. ## `includeVariants` (type: `boolean`): Emit variant rows in addition to product rows when public variant data is available. ## Actor input object example ```json { "maxProducts": 250, "compareToPreviousDataset": false, "previousSnapshot": [], "includeVariants": true } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("isotonic/ecommerce-catalog-price-change-monitor").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("isotonic/ecommerce-catalog-price-change-monitor").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call isotonic/ecommerce-catalog-price-change-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=isotonic/ecommerce-catalog-price-change-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Ecommerce Catalog Price Change Monitor for Shopify/WooCommerce", "description": "Captures public Shopify and WooCommerce catalog snapshots and emits product and variant price change rows.", "version": "0.1", "x-build-id": "lKGSg0TIjukQUna2f" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/isotonic~ecommerce-catalog-price-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-isotonic-ecommerce-catalog-price-change-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/isotonic~ecommerce-catalog-price-change-monitor/runs": { "post": { "operationId": "runs-sync-isotonic-ecommerce-catalog-price-change-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/isotonic~ecommerce-catalog-price-change-monitor/run-sync": { "post": { "operationId": "run-sync-isotonic-ecommerce-catalog-price-change-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": { "storeUrls": { "title": "Store URLs", "type": "array", "description": "Storefront base URLs to monitor. Subpaths are supported for local testing and reverse-proxied stores.", "items": { "type": "string" } }, "domains": { "title": "Domains", "type": "array", "description": "Optional bare domains. The actor normalizes them to HTTPS store URLs.", "items": { "type": "string" } }, "maxProducts": { "title": "Max products", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum products fetched per store before pagination stops.", "default": 250 }, "compareToPreviousDataset": { "title": "Compare to previous dataset", "type": "boolean", "description": "When enabled alongside `previousSnapshot`, attaches price and availability delta fields to the current snapshot rows.", "default": false }, "previousSnapshot": { "title": "Previous snapshot rows", "type": "array", "description": "Optional previous snapshot rows used for deterministic delta fields. Paste rows from a prior run.", "items": { "type": "object" }, "default": [] }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Emit variant rows in addition to product rows when public variant data is available.", "default": true } } }, "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 } } } } } } } } } } ```