# Shopify Endpoints Extractor (`taroyamada/shopify-store-intelligence`) Actor Extract structured JSON data from Shopify public endpoints. Crawl products, collections, and store metadata to integrate into your apps. - **URL**: https://apify.com/taroyamada/shopify-store-intelligence.md - **Developed by:** [太郎 山田](https://apify.com/taroyamada) (community) - **Categories:** Developer tools, E-commerce, Automation - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per event 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 Store Intelligence API | Catalog, Collections & Merch Signals Analyze public Shopify storefront endpoints such as `products.json`, `collections.json`, and `meta.json` — no admin access or app install required. Get store summaries, catalog samples, content metadata, and merchandising rollups in one normalized output. ### Store Quickstart - Start with 1–2 public `storeUrls` and keep product / collection samples around 10–25. - Leave `includeContentMetadata` off for the fastest first run, then turn it on when you need blog or page intelligence. - Use `dryRun: true` before scaling to multi-store or webhook workflows. ### Key Features - 🛍️ **Multi-store support** — analyze up to 50 Shopify storefronts per run - 📦 **Catalog sampling** — fast product and collection samples via public JSON endpoints - 🧠 **Merch rollups** — vendor, tag, and product-type counts from sampled products - 🏪 **Store summary** — normalized name, domain, currency, description, theme hint, canonical URL - ⚠️ **Restriction-aware** — surfaces 401/403/404/non-JSON cases clearly instead of failing silently - 🧾 **Optional pages / blogs metadata** — enabled only when you need it ### Use Cases | Who | Why | |-----|-----| | Developers | Automate recurring data fetches without building custom scrapers | | Data teams | Pipe structured output into analytics warehouses | | Ops teams | Monitor changes via webhook alerts | | Product managers | Track competitor/market signals without engineering time | ### Input | Field | Type | Default | Description | |-------|------|---------|-------------| | storeUrls | array | prefilled | One or more Shopify storefront URLs. Custom domains and *.myshopify.com domains both work. Maximum 50 stores per run. | | productSampleLimit | integer | `25` | Maximum number of public products to fetch per store from /products.json. | | collectionSampleLimit | integer | `25` | Maximum number of public collections to fetch per store from /collections.json. | | includeContentMetadata | boolean | `false` | Attempt lightweight metadata fetches from /pages.json and /blogs.json when public storefront endpoints expose them. | | contentSampleLimit | integer | `10` | Maximum public pages or blogs to sample per store when includeContentMetadata is enabled. | | timeoutMs | integer | `15000` | Per-request timeout in milliseconds. | | delivery | string | `"dataset"` | Where to send results. Dataset is best for inspection; webhook posts the same payload to your endpoint. | | webhookUrl | string | — | Required when delivery is webhook. | #### Input Example ```json { "storeUrls": [ "https://colourpop.com", "https://allbirds.com" ], "productSampleLimit": 10, "collectionSampleLimit": 6, "includeContentMetadata": true, "contentSampleLimit": 5, "delivery": "dataset" } ```` ### Output | Field | Type | Description | |-------|------|-------------| | `meta` | object | | | `results` | array | | | `results[].inputUrl` | string (url) | | | `results[].normalizedUrl` | string (url) | | | `results[].hostname` | string | | | `results[].status` | string | | | `results[].store` | object | | | `results[].summary` | object | | | `results[].collections` | array | | | `results[].productSamples` | array | | | `results[].rollups` | object | | | `results[].content` | object | | | `results[].warnings` | array | | | `results[].error` | null | | #### Output Example ```json { "meta": { "generatedAt": "2026-04-10T17:06:39.370Z", "totals": { "stores": 1, "ok": 1, "restricted": 0, "errors": 0, "warningCount": 3 }, "limits": { "productSampleLimit": 8, "collectionSampleLimit": 5, "contentSampleLimit": 5, "includeContentMetadata": true }, "duplicateInputsSkipped": 0, "notes": [ "Vendor, tag, and product-type rollups are derived from sampled public products only.", "Warnings highlight public endpoint restrictions or partial storefront exposure." ] }, "results": [ { "inputUrl": "https://colourpop.com", "normalizedUrl": "https://colourpop.com", "hostname": "colourpop.com", "status": "ok", "store": { "name": "ColourPop", "description": "Shop ColourPop® top-rated makeup for eyes, lips & face. From Super Shock Shadow to glossy balms & liners, plus iconic collabs. Find your match - shop now!", "url": "https://colourpop.com", "canonicalUrl": "https://colourpop.com/", "domain": "colourpop.com", "myshopifyDomain": "colourpop-prd.myshopify.com", "currency": "USD", "country": "US", "province": "California", "city": "Oxnard", "locale": "en", ``` ### API Usage Run this actor programmatically using the Apify API. Replace `YOUR_API_TOKEN` with your token from [Apify Console → Settings → Integrations](https://console.apify.com/account/integrations). #### cURL ```bash curl -X POST "https://api.apify.com/v2/acts/taroyamada~shopify-store-intelligence/run-sync-get-dataset-items?token=YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "storeUrls": [ "https://colourpop.com", "https://allbirds.com" ], "productSampleLimit": 10, "collectionSampleLimit": 6, "includeContentMetadata": true, "contentSampleLimit": 5, "delivery": "dataset" }' ``` #### Python ```python from apify_client import ApifyClient client = ApifyClient("YOUR_API_TOKEN") run = client.actor("taroyamada/shopify-store-intelligence").call(run_input={ "storeUrls": [ "https://colourpop.com", "https://allbirds.com" ], "productSampleLimit": 10, "collectionSampleLimit": 6, "includeContentMetadata": true, "contentSampleLimit": 5, "delivery": "dataset" }) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) ``` #### JavaScript / Node.js ```javascript import { ApifyClient } from 'apify-client'; const client = new ApifyClient({ token: 'YOUR_API_TOKEN' }); const run = await client.actor('taroyamada/shopify-store-intelligence').call({ "storeUrls": [ "https://colourpop.com", "https://allbirds.com" ], "productSampleLimit": 10, "collectionSampleLimit": 6, "includeContentMetadata": true, "contentSampleLimit": 5, "delivery": "dataset" }); const { items } = await client.dataset(run.defaultDatasetId).listItems(); console.log(items); ``` ### Tips & Limitations - Run weekly for trend tracking; daily for competitive launch monitoring. - Use webhook delivery to push insights into your BI tools or marketing Slack. - Archive results in Apify Dataset for your own historical trend analysis. - Combine with `ai-visibility-monitor-actor` for AI-era brand surface coverage. - Start with a small watchlist, iterate on keyword precision before scaling. ### FAQ **What platforms are covered?** Varies by actor — see each actor's input schema for the full source list. Most cover 3–8 major platforms per vertical. **How is data deduplicated across sources?** The actor normalizes entity identifiers (brand name, SKU) before aggregation — cross-source duplicates are merged. **Can I whitelabel the output?** Dataset rows are raw data — build your own presentation layer to whitelabel. **Is the sentiment scoring accurate?** Sentiment uses rule-based + keyword scoring tuned for English. For non-English content, treat scores as directional rather than absolute. **Can I share the dashboard output?** Export from Dataset API into your BI tool (Looker, Metabase, Tableau) for stakeholder-facing dashboards. ### Related Actors Pair this actor with other flagship intelligence APIs in the same portfolio: - [Trustpilot Review Intelligence API](https://apify.com/taroyamada/trustpilot-enterprise-review-aggregator) — add brand-level review, rating, and reply signals for the same merchants. - [Google Maps Review Intelligence API](https://apify.com/taroyamada/google-maps-review-intelligence) — compare local-store reputation with storefront and catalog signals. - [YouTube Channel Analytics API](https://apify.com/taroyamada/youtube-channel-analytics) — connect merchandising changes with creator and content cadence. - [Google Play Intelligence API](https://apify.com/taroyamada/google-play-intelligence) — add mobile-app feedback when the same brand also has an Android presence. ### Pricing & Cost Control Apify Store pricing is usage-based, so total cost mainly follows how many `storeUrls` you process plus how deep you sample products, collections, and content. Check the Store pricing card for the current per-event rates. - Start with 1–2 `storeUrls` while validating the schema. - Keep `productSampleLimit`, `collectionSampleLimit`, and `contentSampleLimit` low for first passes. - Leave `includeContentMetadata` off unless you need blogs or pages. - Use `dryRun: true` before daily or multi-store runs. # Actor input Schema ## `storeUrls` (type: `array`): One or more Shopify storefront URLs. Custom domains and \*.myshopify.com domains both work. Maximum 50 stores per run. ## `productSampleLimit` (type: `integer`): Maximum number of public products to fetch per store from /products.json. ## `collectionSampleLimit` (type: `integer`): Maximum number of public collections to fetch per store from /collections.json. ## `includeContentMetadata` (type: `boolean`): Attempt lightweight metadata fetches from /pages.json and /blogs.json when public storefront endpoints expose them. ## `contentSampleLimit` (type: `integer`): Maximum public pages or blogs to sample per store when includeContentMetadata is enabled. ## `timeoutMs` (type: `integer`): Per-request timeout in milliseconds. ## `delivery` (type: `string`): Where to send results. Dataset is best for inspection; webhook posts the same payload to your endpoint. ## `webhookUrl` (type: `string`): Required when delivery is webhook. ## `dryRun` (type: `boolean`): Skip dataset writes and webhook delivery; still writes output/result.json locally. ## Actor input object example ```json { "storeUrls": [ "https://colourpop.com", "https://allbirds.com" ], "productSampleLimit": 25, "collectionSampleLimit": 25, "includeContentMetadata": false, "contentSampleLimit": 10, "timeoutMs": 15000, "delivery": "dataset", "dryRun": false } ``` # 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 = { "storeUrls": [ "https://colourpop.com", "https://allbirds.com" ] }; // Run the Actor and wait for it to finish const run = await client.actor("taroyamada/shopify-store-intelligence").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 = { "storeUrls": [ "https://colourpop.com", "https://allbirds.com", ] } # Run the Actor and wait for it to finish run = client.actor("taroyamada/shopify-store-intelligence").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 '{ "storeUrls": [ "https://colourpop.com", "https://allbirds.com" ] }' | apify call taroyamada/shopify-store-intelligence --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=taroyamada/shopify-store-intelligence", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Shopify Endpoints Extractor", "description": "Extract structured JSON data from Shopify public endpoints. Crawl products, collections, and store metadata to integrate into your apps.", "version": "0.1", "x-build-id": "KJUlF9kpdiu4anFzV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~shopify-store-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-shopify-store-intelligence", "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-store-intelligence/runs": { "post": { "operationId": "runs-sync-taroyamada-shopify-store-intelligence", "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-store-intelligence/run-sync": { "post": { "operationId": "run-sync-taroyamada-shopify-store-intelligence", "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": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Shopify Store URLs", "type": "array", "description": "One or more Shopify storefront URLs. Custom domains and *.myshopify.com domains both work. Maximum 50 stores per run.", "items": { "type": "string" } }, "productSampleLimit": { "title": "Product Sample Limit", "minimum": 1, "maximum": 250, "type": "integer", "description": "Maximum number of public products to fetch per store from /products.json.", "default": 25 }, "collectionSampleLimit": { "title": "Collection Sample Limit", "minimum": 1, "maximum": 250, "type": "integer", "description": "Maximum number of public collections to fetch per store from /collections.json.", "default": 25 }, "includeContentMetadata": { "title": "Include Blogs / Pages Metadata", "type": "boolean", "description": "Attempt lightweight metadata fetches from /pages.json and /blogs.json when public storefront endpoints expose them.", "default": false }, "contentSampleLimit": { "title": "Content Sample Limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum public pages or blogs to sample per store when includeContentMetadata is enabled.", "default": 10 }, "timeoutMs": { "title": "Timeout (ms)", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Per-request timeout in milliseconds.", "default": 15000 }, "delivery": { "title": "Delivery Mode", "enum": [ "dataset", "webhook" ], "type": "string", "description": "Where to send results. Dataset is best for inspection; webhook posts the same payload to your endpoint.", "default": "dataset" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Required when delivery is webhook." }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "Skip dataset writes and webhook delivery; still writes output/result.json locally.", "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 } } } } } } } } } } ```