{ "openapi": "3.0.1", "info": { "title": "WooCommerce Scraper - Products, Prices, Stock & Price Tracker", "description": "Every product, price, sale price, stock flag, category and rating from any WooCommerce store, many stores per run. Change mode returns only new products and price or stock changes since the last run.", "version": "0.1", "x-build-id": "NpYaETeRyCgscwmSh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/olsols4~woocommerce-store-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-olsols4-woocommerce-store-products", "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/olsols4~woocommerce-store-products/runs": { "post": { "operationId": "runs-sync-olsols4-woocommerce-store-products", "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/olsols4~woocommerce-store-products/run-sync": { "post": { "operationId": "run-sync-olsols4-woocommerce-store-products", "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": [ "stores" ], "properties": { "stores": { "title": "WooCommerce stores", "type": "array", "description": "Store URLs or domains (yithemes.com). Paste a /product-category// URL to scrape one category.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Optional category slugs or IDs (e.g. hoodies, 42) applied to every store. Leave empty for the whole catalogue.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep only products whose name, SKU, categories, tags, brands or short description contain any of these.", "items": { "type": "string" } }, "onlyAvailable": { "title": "In stock only", "type": "boolean", "description": "Skip out-of-stock products.", "default": false }, "onlyOnSale": { "title": "On sale only", "type": "boolean", "description": "Keep only products that are currently discounted.", "default": false }, "includeDescription": { "title": "Include description and all images", "type": "boolean", "description": "Adds the full description text and every image URL.", "default": false }, "onlyChanges": { "title": "Only new products and price/stock changes", "type": "boolean", "description": "For scheduled price monitoring: remembers the last run for each store and returns only new products and ones whose price, sale price or stock changed (you only pay for those).", "default": false }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "type": "integer", "description": "Upper limit of products saved per store.", "default": 100000 }, "maxConcurrency": { "title": "Stores at once", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many stores to fetch in parallel.", "default": 5 }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route requests through Apify's datacenter proxy so stores don't rate-limit the run. Included in the price.", "default": true } } }, "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 } } } } } } } } } }