{ "openapi": "3.0.1", "info": { "title": "WooCommerce Scraper", "description": "Scrape products, categories, tags, attributes, and reviews from any WooCommerce store.", "version": "1.0", "x-build-id": "OGZeoXBFraBhQzVnW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~woocommerce-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-woocommerce-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/crawlerbros~woocommerce-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-woocommerce-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/crawlerbros~woocommerce-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-woocommerce-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": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Store URLs", "minItems": 1, "type": "array", "description": "Enter the homepage URL of each WooCommerce store you want to scrape. The scraper automatically detects the WooCommerce Store API and extracts product data. Supports any WooCommerce-powered site — custom themes, page builders (Elementor, Divi), multi-currency stores, etc. Example: https://my-store.com", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max Products Per Store", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum number of products to extract from each store. The scraper paginates through the store catalog automatically. Set to 0 to scrape all available products (up to 10,000). Lower values reduce run time and cost.", "default": 100 }, "resources": { "title": "Resources to Scrape", "type": "array", "description": "Choose which types of data to extract. Products include full details (name, price, images, stock, ratings). Categories and tags map the store's catalog structure. Attributes list product options (Size, Color, etc.). Reviews include customer ratings and feedback.", "items": { "type": "string", "enum": [ "products", "categories", "tags", "attributes", "reviews" ], "enumTitles": [ "Products — name, price, images, stock, SKU, description, ratings", "Categories — catalog hierarchy with product counts", "Tags — product labels and groupings", "Attributes — product options like Size, Color with all terms", "Reviews — customer ratings, review text, verified buyer status" ] }, "default": [ "products" ] }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Filter products by keyword. Searches product names and descriptions. Leave empty to scrape all products. Examples: 'organic', 'cotton t-shirt', 'wireless headphones'." }, "sortBy": { "title": "Sort Products By", "enum": [ "", "date", "price", "popularity", "rating", "title" ], "type": "string", "description": "Control the order in which products are scraped. Useful for getting cheapest items first (Price), newest arrivals (Date), or best sellers (Popularity). Default uses the store's native ordering.", "default": "" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Most WooCommerce stores work without a proxy since the scraper uses public APIs. Only enable this if a store blocks direct requests or returns CAPTCHAs. Datacenter proxies are usually sufficient — residential proxies are rarely needed." } } }, "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 } } } } } } } } } }