{ "openapi": "3.0.1", "info": { "title": "WooCommerce Products Scraper & Price Tracker", "description": "Scrape every product from any WooCommerce store through its public Store API: prices, sale prices, stock, SKUs, categories, tags, attributes, ratings and images. Schedule it to track price drops, price increases, restocks, sell-outs, new and removed products. Pay only per product.", "version": "1.0", "x-build-id": "bDCae18xl0QRHZJtg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jtpalms~woocommerce-store-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jtpalms-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/jtpalms~woocommerce-store-products/runs": { "post": { "operationId": "runs-sync-jtpalms-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/jtpalms~woocommerce-store-products/run-sync": { "post": { "operationId": "run-sync-jtpalms-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 domains or URLs, one per line. Examples: lunchconcept.com, https://www.nalgene.com. A category page URL (https://store.com/product-category/sale/) reads only that category, and a tag page URL (https://store.com/product-tag/summer/) only that tag. Duplicates are removed automatically.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Stop after this many products from each store. 0 means no limit.", "default": 0 }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Compare with the previous run and add a \"change\" field to each row: new, price_drop, price_increase, back_in_stock, sold_out or unchanged. Products that disappeared are reported as removed (free). Snapshots are kept in your \"woocommerce-price-tracker\" key-value store. Schedule the actor daily to use this.", "default": false }, "onlyChanges": { "title": "Only output changes", "type": "boolean", "description": "Skip unchanged products, so you pay only for new, removed, repriced and restocked or sold-out products. Turns on change tracking. On the first run every product counts as new.", "default": false }, "category": { "title": "Category", "type": "string", "description": "Read only one category from every store: its slug (the part after /product-category/ in the URL, for example \"sale\") or its numeric ID. Separate several with commas to get products from any of them. Leave empty to read the whole catalog." }, "tag": { "title": "Tag", "type": "string", "description": "Read only products with this product tag: its slug (the part after /product-tag/ in the URL) or its numeric ID. Separate several with commas." }, "search": { "title": "Search text", "type": "string", "description": "Only products that match this text, the same as the store's own search box." }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Only products that have a sale price right now.", "default": false }, "stockStatus": { "title": "Stock status", "enum": [ "any", "instock", "outofstock", "onbackorder" ], "type": "string", "description": "Only products with this stock status.", "default": "any" }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many stores to read at the same time. Pages within one store are always read one by one, with a short pause, to be polite.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Only needed if a store blocks requests from data centers (HTTP 403 or 429 errors, or a bot check), or to fix the country for stores that convert prices to the visitor's currency." } } }, "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 } } } } } } } } } }