{ "openapi": "3.0.1", "info": { "title": "WooCommerce Products Scraper: Prices, Stock, Images & SKUs", "description": "Export a public WooCommerce catalog: name, decimal price, sale price, stock, SKU, categories, images, and URL. No login. Filter by category, keyword, stock, or sale. changesOnly diffs a saved baseline; the first run only records it.", "version": "0.6", "x-build-id": "Uw5H21BsNXxwHVvyE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dheerajitbhu~woocommerce-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dheerajitbhu-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/dheerajitbhu~woocommerce-products-scraper/runs": { "post": { "operationId": "runs-sync-dheerajitbhu-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/dheerajitbhu~woocommerce-products-scraper/run-sync": { "post": { "operationId": "run-sync-dheerajitbhu-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": { "storeUrls": { "title": "Store URLs", "type": "array", "description": "One or more WooCommerce store URLs, e.g. https://example-store.com. Works with the large majority of public WooCommerce stores. Leave empty to see demo output.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stops reading a store after this many products. Lower it to cap your cost. Example: 200 for a quick check, 1000 (default) for most stores.", "default": 1000 }, "categories": { "title": "Categories (optional)", "type": "array", "description": "Only products in these categories. Use category slugs (e.g. t-shirts), names, or numeric IDs. Example: [\"sale\"] to export only the Sale category.", "items": { "type": "string" } }, "search": { "title": "Search keyword (optional)", "type": "string", "description": "Only products matching this keyword (the store's own product search). Example: 'mug' to export only products matching that keyword." }, "inStockOnly": { "title": "In-stock products only", "type": "boolean", "description": "Skip out-of-stock products. Example: true to export only items currently available to buy.", "default": false }, "onSaleOnly": { "title": "On-sale products only", "type": "boolean", "description": "Only products currently on sale. Example: true to export only discounted items with their sale price.", "default": false }, "maxChargeUsd": { "title": "Maximum charge per run (USD)", "minimum": 0, "type": "number", "description": "Hard spending cap for this run. The actor stops cleanly before exceeding it; rows already exported are kept. Example: 5 caps the run at $5 (about 1,000 products).", "default": 5 }, "outputMode": { "title": "Output mode", "enum": [ "all", "changesOnly" ], "type": "string", "description": "Default 'all' exports every matching product, every run. 'changesOnly' remembers the last run and exports only products that are new, changed, or no longer found — handy on a schedule. Example: 'changesOnly' to get a daily diff instead of a full re-export.", "default": "all" }, "monitorKey": { "title": "Monitor name (optional)", "type": "string", "description": "Only used with 'changesOnly'. Names the saved baseline so scheduled runs compare against the right one. Leave blank to derive it automatically from your other inputs. Example: 'my-store-daily' if you run several monitors." }, "includeRemoved": { "title": "Report removed products", "type": "boolean", "description": "Only used with 'changesOnly'. When true (default), products no longer found are reported once as removed. Example: false to only see new/changed products.", "default": true }, "ignoreFields": { "title": "Fields to ignore when detecting changes (optional)", "type": "array", "description": "Only used with 'changesOnly'. Field names that should not, by themselves, trigger a 'changed' result. Example: [\"reviewCount\"] to ignore review-count drift and only react to price/stock/etc.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }