{ "openapi": "3.0.1", "info": { "title": "Shopify & WooCommerce Scraper: Products, Stock & Store Leads", "description": "Extract complete product catalogues, exact variant inventory, compare-at discounts, B2B store leads (verified emails, phones, social links, 35+ installed apps/pixels), and customer reviews (Judge.me, Okendo, Yotpo, WooCommerce) from any Shopify or WooCommerce domain. Zero browser overhead.", "version": "1.0", "x-build-id": "gte2X3hzUXOyYMceB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/storeintel~ecommerce-store-intelligence-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-storeintel-ecommerce-store-intelligence-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/storeintel~ecommerce-store-intelligence-scraper/runs": { "post": { "operationId": "runs-sync-storeintel-ecommerce-store-intelligence-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/storeintel~ecommerce-store-intelligence-scraper/run-sync": { "post": { "operationId": "run-sync-storeintel-ecommerce-store-intelligence-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", "required": [ "domains" ], "properties": { "domains": { "title": "Store Domains or URLs", "type": "array", "description": "One or more store domains (e.g. 'allbirds.com'), collection URLs ('https://example.com/collections/sale'), or direct product URLs.", "default": [ "tentree.com" ], "items": { "type": "string" } }, "scrapeProducts": { "title": "Extract Product Catalogue & Variants", "type": "boolean", "description": "Paginate the store's public product feed and extract all variants, prices, compare-at prices, calculated discount %, SKUs, options, tags, and images.", "default": true }, "maxProductsPerStore": { "title": "Max Products per Store (0 = unlimited)", "minimum": 0, "maximum": 250000, "type": "integer", "description": "Maximum number of products to collect per domain. Set to 0 to extract the entire store catalogue.", "default": 50 }, "includeExactInventory": { "title": "Enrich with Exact Stock Quantities & Barcodes", "type": "boolean", "description": "Fetches per-product .js / Store API metadata to retrieve exact variant inventory quantities (when publicly exposed by the merchant), inventory policy, and GTIN/UPC barcodes.", "default": false }, "includeStoreLeadProfile": { "title": "Extract B2B Store Lead Profile (Emails, Phones, Socials & Tech Stack)", "type": "boolean", "description": "Crawls the storefront homepage, contact page, and legal contact policy to extract verified business emails, phone numbers, social media links, theme details, and 35+ detected apps and ad pixels.", "default": true }, "includeReviews": { "title": "Extract Customer Reviews (Judge.me, Loox, Yotpo, Stamped, WooCommerce)", "type": "boolean", "description": "Auto-detects the store's review provider and extracts structured customer reviews (rating, title, body, author, verified status, timestamp).", "default": false }, "maxReviewsPerStore": { "title": "Max Reviews per Store", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of customer reviews to extract per store when Review Extraction is enabled.", "default": 50 }, "onlyInStock": { "title": "In-Stock Products Only", "type": "boolean", "description": "Skip products where all variants are out of stock.", "default": false }, "onlyOnSale": { "title": "Discounted / On-Sale Products Only", "type": "boolean", "description": "Only return products where at least one variant has a compare-at price higher than the active selling price.", "default": false }, "minDiscountPercent": { "title": "Minimum Discount %", "minimum": 0, "maximum": 99, "type": "integer", "description": "Only return products discounted by at least this percentage (e.g. 20 for 20% off).", "default": 0 }, "keywordFilter": { "title": "Keyword Filter (Title, Type, Vendor, or Tag)", "type": "string", "description": "Optional case-insensitive substring filter matched against product title, product type, vendor, or tags.", "default": "" }, "maxConcurrency": { "title": "Max Concurrent Requests", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum parallel HTTP requests. Keep between 4 and 10 to avoid store rate-limiting.", "default": 6 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy settings. Direct connections are used first for speed; if a proxy configuration is supplied, it is used automatically when a store rate-limits direct requests.", "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 } } } } } } } } } }