{ "openapi": "3.0.1", "info": { "title": "Woocommerce Scraper", "description": "πŸ›οΈ WooCommerce Scraper (woocommerce-scraper) extracts product titles, prices, stock, variants, categories, images, reviews & URLs from WooCommerce stores. ⚑ Ideal for SEO, price tracking, competitor research & catalog import. CSV/JSON export, scheduling, scaling. πŸ”„", "version": "0.1", "x-build-id": "ymO65S9AOfwpEPAyt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeflow~woocommerce-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeflow-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/scrapeflow~woocommerce-scraper/runs": { "post": { "operationId": "runs-sync-scrapeflow-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/scrapeflow~woocommerce-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeflow-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": [ "startUrls" ], "properties": { "startUrls": { "title": "❓ URL", "type": "array", "description": "πŸ’‘ Where do you want to Shop? (Also accepts 'url' as array of store URLs)", "items": { "type": "string" } }, "url": { "title": "URL (alternative)", "type": "array", "description": "Alternative to startUrls: array of store URLs to scrape.", "items": { "type": "string" } }, "limit": { "title": "♾️ Limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Number of results (per-query)", "default": 20 }, "resource": { "title": "πŸ“ Resource", "enum": [ "products", "categories", "brands", "tags", "attributes", "reviews", "pages", "posts", "comments", "post-categories", "post-tags", "users" ], "type": "string", "description": "Select resource type to scrape", "default": "products" }, "include_variations": { "title": "Include Variations", "type": "boolean", "description": "Include product variations in results", "default": false }, "format": { "title": "Output Format", "enum": [ "md", "text", "html" ], "type": "string", "description": "πŸ’‘ Output format for Descriptions. (default: Markdown)", "default": "md" }, "sort": { "title": "Sorting", "enum": [ "", "date", "modified", "id", "include", "title", "slug", "price", "popularity", "rating", "menu_order", "comment_count" ], "type": "string", "description": "Sort results by attribute", "default": "date" }, "order": { "title": "Order", "enum": [ "", "asc", "desc" ], "type": "string", "description": "Order sort direction", "default": "" }, "search": { "title": "Search", "type": "string", "description": "πŸ’‘ Limit results to those matching a string." }, "sku": { "title": "SKU", "type": "string", "description": "πŸ’‘ Limit result set to products with specific SKU(s). Use commas to separate." }, "rating": { "title": "Product Ratings", "type": "string", "description": "πŸ’‘ Filter by product ratings. Enter comma-separated rating values (e.g., 1,2,3,4,5)" }, "min_price": { "title": "Price Range - Min", "type": "integer", "description": "Limit result set to products based on a minimum price." }, "max_price": { "title": "Price Range - Max", "type": "integer", "description": "Limit result set to products based on a maximum price." }, "tax_class": { "title": "Tax Class", "enum": [ "", "standard", "reduced-rate", "zero-rate" ], "type": "string", "description": "Limit result set to products with a specific tax class." }, "category": { "title": "Category", "type": "string", "description": "Product Category ID(s) separated by comma" }, "tag": { "title": "Tag", "type": "string", "description": "Product Tag ID(s) separated by comma" }, "product_type": { "title": "Product Type", "enum": [ "", "simple", "grouped", "external", "variable", "wbs_bundle", "variation" ], "type": "string", "description": "Products assigned a specific type" }, "status": { "title": "Product Status", "enum": [ "", "future", "trash", "draft", "pending", "private", "publish" ], "type": "string", "description": "Filter by product status" }, "stock": { "title": "Stock Status", "enum": [ "", "instock", "outofstock", "onbackorder" ], "type": "string", "description": "Filter by stock status" }, "featured": { "title": "Featured", "type": "boolean", "description": "Featured products", "default": false }, "sale": { "title": "On Sale", "type": "boolean", "description": "Products on sale", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Choose which proxies to use. By default, no proxy is used." }, "dev_proxy_config": { "title": "🌐 PROXY NETWORKING", "type": "string", "description": "πŸ’‘ Supported protocol: HTTP(S), SOCKS5\n{http|socks5}://{user:pass}@{hostname|ip-address}:port\nExample: socks5://example.com:9000" }, "dev_custom_headers": { "title": "πŸ“œ HTTP HEADERS", "type": "string", "description": "πŸ’‘ Additional HTTP Headers as JSON array. Example: [{\"name\": \"Authorization\", \"value\": \"Bearer token\"}]" }, "dev_custom_cookies": { "title": "🍰 HTTP COOKIES", "type": "string", "description": "πŸ’‘ Additional HTTP Cookies as JSON array. Example: [{\"name\": \"session\", \"value\": \"abc123\"}]" }, "dev_transform_fields": { "title": "♻️ CUSTOM FIELD", "type": "string", "description": "πŸ’‘ Transform the resulting output. Enter comma-separated field paths.\nFor nested object use DOT. For example: address.streetAddress\nFor nested array use NUMBER (index of array element starting from index=0). For example: images.0.url" }, "dev_dataset_name": { "title": "πŸ“ CUSTOM STORAGE", "type": "string", "description": "πŸ’‘ Save results into custom named Dataset, use mask to customize dataset name\n{ACTOR} = actor name\n{DATE} = date (YYYYMMDD)\n{TIME} = time (HHMMSS)\nThis masks can be used to autogenerate Dataset Name.\nexample: data-{DATE}\nDepending on today date the dataset name will be: data-20230603\ndefault: data-{ACTOR}-{DATE}-{TIME}" }, "dev_dataset_clear": { "title": "Clear Storage", "type": "boolean", "description": "Clear Dataset before insert/update.", "default": false }, "dev_no_strip": { "title": "Disable data cleansing", "type": "boolean", "description": "πŸ’‘ Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)", "default": false }, "dev_fileupload": { "title": "πŸ“ FILE UPLOADER", "type": "string", "description": "πŸ’‘ Upload your file and copy & paste the URL somewhere." } } }, "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 } } } } } } } } } }