{ "openapi": "3.0.1", "info": { "title": "WooCommerce Store Products Scraper", "description": "Get every product from any WooCommerce store through its public Store API: prices in real decimals, discount %, stock, categories and ratings, one row per product.", "version": "0.1", "x-build-id": "8YCdh0Uyn1KUA6VWK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sampon~woocommerce-store-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sampon-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/sampon~woocommerce-store-products/runs": { "post": { "operationId": "runs-sync-sampon-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/sampon~woocommerce-store-products/run-sync": { "post": { "operationId": "run-sync-sampon-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Store URLs", "type": "array", "description": "The home page or shop page of a WooCommerce store, for example https://mercantile.wordpress.org/. Several stores can be listed in one run; they are read one after another.", "default": [ { "url": "https://mercantile.wordpress.org/" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Stop after this many products in total, across all stores.", "default": 20 }, "maxItemsPerStore": { "title": "Maximum products per store", "minimum": 1, "type": "integer", "description": "Optional cap for each store, so one big store does not use up the whole run." }, "categories": { "title": "Categories", "type": "array", "description": "Keep only products in one of these categories. Use the category slug as it appears in the store's URLs (for example drinkware), the category ID, or the category name.", "items": { "type": "string" } }, "tags": { "title": "Tags", "type": "array", "description": "Keep only products with one of these tags (slug, ID or name).", "items": { "type": "string" } }, "search": { "title": "Search words", "type": "string", "description": "Passed to the store's own product search." }, "onSaleOnly": { "title": "Only products on sale", "type": "boolean", "description": "Keep only products that have a sale price right now.", "default": false }, "inStockOnly": { "title": "Only products in stock", "type": "boolean", "description": "Skip products that are out of stock.", "default": false }, "includeShortDescription": { "title": "Include the short description", "type": "boolean", "description": "The product's short description as plain text. Turn off for smaller rows.", "default": true }, "trackPriceChanges": { "title": "Compare with the previous run", "type": "boolean", "description": "Remember each product's price in a named key-value store in your account and add the previous price and the change to every row.", "default": false }, "changesOnly": { "title": "Return only new products and price changes", "type": "boolean", "description": "Turns on the comparison and leaves out products whose price did not change since the previous run. The first run returns every product as new.", "default": false }, "historyName": { "title": "Price history name", "type": "string", "description": "Name of the key-value store that keeps the previous prices. Use a different name for each separate monitoring task.", "default": "woocommerce-price-history" }, "requestDelayMs": { "title": "Gap between requests (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Minimum time between two requests to the same store. A longer crawl delay in the store's robots.txt always wins.", "default": 1000 } } }, "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 } } } } } } } } } }