# Shopify Public Catalog Map & Promo Watch (`taroyamada/shopify-public-catalog-map-promo-watch-scraper`) Actor Unofficially map user-supplied public Shopify storefront catalogs and detect source-linked promo, collection, and catalog map changes. - **URL**: https://apify.com/taroyamada/shopify-public-catalog-map-promo-watch-scraper.md - **Developed by:** [åĪŠéƒŽ åąąį”°](https://apify.com/taroyamada) (community) - **Categories:** Business, E-commerce - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $80.00 / 1,000 shopify catalog map generateds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.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/platform/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 ## Shopify Public Catalog Map & Promo Watch Brands, Shopify agencies, and marketplace teams use this actor to monitor public storefront catalog and promo signals. Provide storefront domains, optional collection handles, and promo keywords. The actor returns source-linked catalog map, promo signal, change, report, and product map rows. ### Store Quickstart Run with `dryRun=false` for user-supplied public storefronts that can be monitored without login, checkout, or private data. ```json { "storeDomains": ["www.allbirds.com"], "promoKeywords": ["sale", "discount", "bundle"], "authorizedUseConfirmed": true, "generateReport": true, "emitUnchanged": false, "dryRun": false } ```` ### Input Examples #### Public storefront promo watch ```json { "storeDomains": ["www.allbirds.com"], "promoKeywords": ["sale", "discount", "limited time"], "authorizedUseConfirmed": true, "dryRun": false } ``` #### Collection-specific watch ```json { "storeDomains": ["www.allbirds.com"], "collectionHandles": ["best-sellers", "new-arrivals"], "maxProductsPerStore": 100, "authorizedUseConfirmed": true, "dryRun": false } ``` #### Product map handoff ```json { "storeDomains": ["www.allbirds.com"], "emitProductRows": true, "generateReport": true, "authorizedUseConfirmed": true, "dryRun": false } ``` ### Sample Output ```json { "actorName": "shopify-public-catalog-map-promo-watch-scraper", "rowType": "shopify_promo_signal", "billingEventName": "shopify-promo-signal-detected", "storeDomain": "example.myshopify.com", "promoKeywordHits": ["bundle"], "sourceUrl": "https://example.myshopify.com/products/sample-bundle" } ``` ### Output Fields - `rowType`: `shopify_catalog_map_summary`, `shopify_promo_signal`, `shopify_catalog_map_change`, `shopify_product_map_item`, or `shopify_promo_watch_report`. - `storeDomain`: storefront domain. - `product`: public product metadata from storefront surfaces. - `promoSignals`: compare-at price or keyword-derived public promo observations. - `sourceUrl`: public storefront URL supporting the row. ### Pricing And No-Change Runs - `shopify-catalog-map-generated`: $0.080 per storefront catalog map summary. - `shopify-promo-signal-detected`: $0.060 per source-linked promo signal. - `shopify-catalog-map-change-detected`: $0.050 per catalog map change. - `shopify-product-map-item`: $0.004 per optional product map item. - `shopify-promo-watch-report`: $5.000 per store-level report. When `emitUnchanged=false`, repeated unchanged runs emit zero dataset rows and zero charges after state is saved. ### Compliance Guardrails - Public storefront JSON/pages only. - No admin API, checkout, cart, customer, order, account, or hidden inventory access. - Non-dry runs require `authorizedUseConfirmed=true`; use this only for storefront monitoring you are allowed to perform. - This is an unofficial tool and is not affiliated with Shopify or any monitored storefront. - Use only for storefront monitoring that is permitted for your context; the actor does not access private merchant data. - Public prices are observed display values at retrieval time, not contractual pricing. ### Bundle Paths - Competitive Intel: run a low-cost catalog map first, then generate `shopify-promo-watch-report` when pricing, promo, or collection evidence matters for a client handoff. - Pair with [SaaS Pricing Changelog Battlecard Watch Scraper](https://apify.com/taroyamada/saas-pricing-changelog-battlecard-watch-scraper) for broader competitive monitoring. - Pair with [Ad Transparency Creative Change Watch Scraper](https://apify.com/taroyamada/ad-transparency-creative-change-watch-scraper) for campaign and storefront change context. ### See Also - [SaaS Pricing Changelog Battlecard Watch Scraper](https://apify.com/taroyamada/saas-pricing-changelog-battlecard-watch-scraper) for SaaS pricing/change battlecards. - [Site QA Indexability AI Crawler Report Scraper](https://apify.com/taroyamada/site-qa-indexability-ai-crawler-report-scraper) for owned-site crawler readiness reports. # Actor input Schema ## `storeDomains` (type: `array`): User-supplied public Shopify storefront domains. ## `collectionHandles` (type: `array`): Optional public collection handles to include. ## `promoKeywords` (type: `array`): Terms used to flag public sale and promo text. ## `maxProductsPerStore` (type: `integer`): Maximum public products to load from each storefront. ## `emitBaselineSummary` (type: `boolean`): Emit a baseline summary row on the first run for a new snapshot namespace. ## `emitProductRows` (type: `boolean`): Emit optional public product map item rows. Off by default; signal rows carry the business value. ## `generateReport` (type: `boolean`): Generate a report row when report-worthy rows are emitted. ## `authorizedUseConfirmed` (type: `boolean`): Required for non-dry runs. Confirms each storefront is owned by you or authorized by the merchant. ## `emitUnchanged` (type: `boolean`): When false, unchanged stores emit no dataset rows and no charges. ## `dryRun` (type: `boolean`): When true, emit sample rows without live calls or billing. ## `initialRunMode` (type: `string`): Deployment canary control used by automation; emit\_backfill allows first-run proof rows, baseline\_only is used for no-change proof. ## `snapshotKey` (type: `string`): Optional state namespace for canary and recurring no-change proof runs. ## Actor input object example ```json { "storeDomains": [ "example.myshopify.com" ], "collectionHandles": [], "promoKeywords": [ "sale", "discount", "clearance", "bundle", "limited time" ], "maxProductsPerStore": 100, "emitBaselineSummary": true, "emitProductRows": false, "generateReport": true, "authorizedUseConfirmed": false, "emitUnchanged": false, "dryRun": true, "initialRunMode": "emit_backfill", "snapshotKey": "" } ``` # 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("taroyamada/shopify-public-catalog-map-promo-watch-scraper").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("taroyamada/shopify-public-catalog-map-promo-watch-scraper").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 taroyamada/shopify-public-catalog-map-promo-watch-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=taroyamada/shopify-public-catalog-map-promo-watch-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Shopify Public Catalog Map & Promo Watch", "description": "Unofficially map user-supplied public Shopify storefront catalogs and detect source-linked promo, collection, and catalog map changes.", "version": "0.1", "x-build-id": "5eBoSVn1RT9dfDQL3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~shopify-public-catalog-map-promo-watch-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-shopify-public-catalog-map-promo-watch-scraper", "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/taroyamada~shopify-public-catalog-map-promo-watch-scraper/runs": { "post": { "operationId": "runs-sync-taroyamada-shopify-public-catalog-map-promo-watch-scraper", "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/taroyamada~shopify-public-catalog-map-promo-watch-scraper/run-sync": { "post": { "operationId": "run-sync-taroyamada-shopify-public-catalog-map-promo-watch-scraper", "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": { "storeDomains": { "title": "Store domains", "type": "array", "description": "User-supplied public Shopify storefront domains.", "items": { "type": "string" }, "default": [ "example.myshopify.com" ] }, "collectionHandles": { "title": "Collection handles", "type": "array", "description": "Optional public collection handles to include.", "items": { "type": "string" }, "default": [] }, "promoKeywords": { "title": "Promo keywords", "type": "array", "description": "Terms used to flag public sale and promo text.", "items": { "type": "string" }, "default": [ "sale", "discount", "clearance", "bundle", "limited time" ] }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum public products to load from each storefront.", "default": 100 }, "emitBaselineSummary": { "title": "Emit baseline summary", "type": "boolean", "description": "Emit a baseline summary row on the first run for a new snapshot namespace.", "default": true }, "emitProductRows": { "title": "Emit product map rows", "type": "boolean", "description": "Emit optional public product map item rows. Off by default; signal rows carry the business value.", "default": false }, "generateReport": { "title": "Generate promo report", "type": "boolean", "description": "Generate a report row when report-worthy rows are emitted.", "default": true }, "authorizedUseConfirmed": { "title": "Authorized use confirmed", "type": "boolean", "description": "Required for non-dry runs. Confirms each storefront is owned by you or authorized by the merchant.", "default": false }, "emitUnchanged": { "title": "Emit unchanged rows", "type": "boolean", "description": "When false, unchanged stores emit no dataset rows and no charges.", "default": false }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "When true, emit sample rows without live calls or billing.", "default": true }, "initialRunMode": { "title": "Initial run mode", "enum": [ "emit_backfill", "baseline_only" ], "type": "string", "description": "Deployment canary control used by automation; emit_backfill allows first-run proof rows, baseline_only is used for no-change proof.", "default": "emit_backfill" }, "snapshotKey": { "title": "Snapshot key", "type": "string", "description": "Optional state namespace for canary and recurring no-change proof runs.", "default": "" } } }, "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 } } } } } } } } } } ```