{ "openapi": "3.0.1", "info": { "title": "Shopify & WooCommerce Products Scraper", "description": "Scrape full product catalogues from any Shopify or WooCommerce store: titles, prices, compare-at prices, variants, SKUs, stock, images, tags. Monitor mode returns only new, changed and removed products. No login, no browser. Export JSON/CSV or call via API/MCP.", "version": "1.0", "x-build-id": "vmnzZKnzJMgALknrw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/teddythebuilder~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-teddythebuilder-shopify-products-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/teddythebuilder~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-teddythebuilder-shopify-products-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/teddythebuilder~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-teddythebuilder-shopify-products-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Store, collection or product URLs", "type": "array", "description": "Shopify or WooCommerce store URLs, e.g. https://www.allbirds.com. Collection (/collections/sale), category (/product-category/shoes) and product URLs are also accepted. The platform is detected automatically.", "default": [ "https://www.allbirds.com", "https://woocommerce.com" ], "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "type": "integer", "description": "Stop after this many products per URL. Set it high (e.g. 100000) to read the whole catalogue.", "default": 10 }, "outputLevel": { "title": "One row per", "enum": [ "product", "variant" ], "type": "string", "description": "Product: one row per product with a nested variants list. Variant: one row per Shopify variant (size/colour) with its own price, SKU and stock flag, best for price monitoring and CSV export.", "default": "product" }, "monitorChanges": { "title": "Monitor mode: only new, changed and removed products", "type": "boolean", "description": "Remember each store's catalogue between runs and output only new products, price changes, stock changes and removed products. Unchanged products are not output and cost only $0.05 per 1,000. The first run outputs everything as 'new'.", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Name of the saved snapshot, e.g. 'competitor-prices'. Use different IDs for independent schedules that watch the same store.", "default": "default" }, "includeRemoved": { "title": "Report removed products (monitor mode)", "type": "boolean", "description": "Output a 'removed' row for products that disappeared since the last run. Only reported when the whole catalogue was read.", "default": true }, "onlyAvailable": { "title": "Only in-stock products", "type": "boolean", "description": "Skip products (or variants) that are sold out.", "default": false }, "onlyOnSale": { "title": "Only products on sale", "type": "boolean", "description": "Keep only products with a compare-at (regular) price above the current price.", "default": false }, "includeDescription": { "title": "Include description text", "type": "boolean", "description": "Add the product description as plain text (HTML removed, max 5,000 characters).", "default": true }, "includeImages": { "title": "Include all image URLs", "type": "boolean", "description": "Add the list of all product image URLs. The main image URL is always included.", "default": true }, "platform": { "title": "Platform", "enum": [ "auto", "shopify", "woocommerce" ], "type": "string", "description": "Leave on auto-detect unless a store is misdetected.", "default": "auto" }, "maxResults": { "title": "Max rows in total", "minimum": 0, "type": "integer", "description": "Hard cap on output rows across all stores (0 = no cap). Useful as a cost limit.", "default": 0 }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many stores are read at the same time (pages within one store are always read one by one).", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is used by default because Shopify rate-limits shared cloud and datacenter IPs. The proxy cost is included in the price. If you pick your own proxies, the IP changes automatically when a store answers 403 or 429.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }