{ "openapi": "3.0.1", "info": { "title": "WooCommerce Products Scraper - Prices, Variations & Stock", "description": "Export all products from any WooCommerce store: prices, sale prices, variations with SKU and stock, categories, brands, images. Monitors new products and price changes. Pay per product.", "version": "0.1", "x-build-id": "2dq71BofXrHrAGbsj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tinyrex~woocommerce-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tinyrex-woocommerce-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/tinyrex~woocommerce-products-scraper/runs": { "post": { "operationId": "runs-sync-tinyrex-woocommerce-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/tinyrex~woocommerce-products-scraper/run-sync": { "post": { "operationId": "run-sync-tinyrex-woocommerce-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", "properties": { "stores": { "title": "WooCommerce stores, categories or products", "type": "array", "description": "Store domains (nalgene.com), store URLs, category URLs (https://store.com/product-category/mugs/) or product URLs (https://store.com/product/blue-mug/). Uses the store's public WooCommerce Store API. Sites that are not WooCommerce, block access or disallow the API in robots.txt are skipped and not charged.", "default": [ "https://nalgene.com", "mandarinstone.com" ], "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Maximum number of products to save per input (after filters). 0 = all products. Newest products come first.", "default": 100 }, "outputMode": { "title": "Output: one row per", "enum": [ "products", "variants" ], "type": "string", "description": "Product: one row per product, variations nested. Variation: one flat row per variation (size/color) - easiest for spreadsheets and price tracking; simple products still give one row. One charge per row.", "default": "products" }, "search": { "title": "Search query (on the store)", "type": "string", "description": "Optional. Uses the store's own product search, so only matching products are downloaded - fastest way to scan big stores for one product line.", "default": "" }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep only products whose title, SKU, categories, tags or brands contain any of these words (case-insensitive).", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop products whose title or tags contain any of these words.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Keep only products in these categories (name or slug, partial match). To download just one category, you can also paste its URL as input.", "default": [], "items": { "type": "string" } }, "brands": { "title": "Brands", "type": "array", "description": "Keep only products of these brands (partial match). Works on stores that use WooCommerce Brands.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest price must be at least this (store currency). 0 = no limit.", "default": 0 }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Lowest price must be at most this (store currency). 0 = no limit.", "default": 0 }, "onlyInStock": { "title": "Only in stock", "type": "boolean", "description": "Keep only products that are in stock.", "default": false }, "onlyOnSale": { "title": "Only on sale", "type": "boolean", "description": "Keep only discounted products.", "default": false }, "includeVariations": { "title": "Variation details", "type": "boolean", "description": "Add price, regular price, SKU and stock for every variation of variable products. Costs nothing extra (one request per 100 variations).", "default": true }, "descriptionFormat": { "title": "Description", "enum": [ "text", "html", "both", "none" ], "type": "string", "description": "Short and full description as plain text, HTML, both, or none (smaller output).", "default": "text" }, "monitorMode": { "title": "Monitoring mode", "enum": [ "off", "new", "changes" ], "type": "string", "description": "Off: return all matching products. New: only products not seen in previous runs. Changes: new products plus price or stock changes (with previous values). State is kept per store under the state key. The first monitoring run returns everything as the baseline.", "default": "off" }, "stateKey": { "title": "State key", "type": "string", "description": "Name of the monitoring state. Use different keys for different schedules or filters.", "default": "default" }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many stores are processed at the same time. Pages of one store are fetched politely one after another.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Usually not needed. Use a proxy if a store rate-limits requests (HTTP 429).", "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 } } } } } } } } } }