{ "openapi": "3.0.1", "info": { "title": "WooCommerce Products Scraper — Prices, SKUs & Stock", "description": "Export public WooCommerce Store API products with currency-scaled prices, SKUs, stock flags, images, categories and parent variation options. Per-product fees and separate Apify platform usage apply.", "version": "1.0", "x-build-id": "xsCyE8hLBCRsIuP7O" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/funny_ground~woocommerce-store-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-funny_ground-woocommerce-store-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/funny_ground~woocommerce-store-products-scraper/runs": { "post": { "operationId": "runs-sync-funny_ground-woocommerce-store-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/funny_ground~woocommerce-store-products-scraper/run-sync": { "post": { "operationId": "run-sync-funny_ground-woocommerce-store-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 roots or Store API collection URLs", "minItems": 1, "maxItems": 20, "type": "array", "description": "Paste 1–20 public HTTPS WordPress installation roots, such as https://store.com/ or https://store.com/wordpress/, or the full /wp-json/wc/store/v1/products collection URL. Public ?rest_route=/wc/store/v1/products routes also work. Do not enter a shop/category/product page, private credentials, cart/admin API or query filters; use the options below. Duplicate canonical stores/products are not billed again within this run.", "items": { "type": "string" }, "default": [ "https://woocommerce.com" ] }, "maxProductsPerStore": { "title": "Maximum matching products per store", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Default 10 products cost $0.005 in event fees. Applied after invalid items, duplicates and local stock/sale/type/category checks. Available variation option mappings are included in each product row; no child-detail expansion or extra option fee.", "default": 10 }, "maxProducts": { "title": "Maximum products across the whole run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Global result cap after deduplication. Stores are processed in input order. Your event-charge budget is also respected, but it does not cap separately billed platform usage. Early-stop reasons are reported in OUTPUT.", "default": 1000 }, "onlyInStock": { "title": "Only products marked in stock", "type": "boolean", "description": "Request the API's instock filter, then require is_in_stock=true and exclude products explicitly marked is_on_backorder=true before writing. This is a public product-level flag, not an exact inventory count. Missing backorder metadata is not inferred.", "default": false }, "onlyOnSale": { "title": "Only products marked on sale", "type": "boolean", "description": "Request on_sale=true and require the returned on_sale flag. The presence of a sale_price alone does not mean a promotion is active.", "default": false }, "search": { "title": "Store search text (optional)", "type": "string", "description": "Passed to the store's own public search parameter. Matching rules depend on its WooCommerce version/search extensions. Applied on the server before pagination.", "default": "" }, "category": { "title": "Category IDs (optional, comma-separated)", "type": "string", "description": "For example 22,43. Match at least one category ID. IDs are local to each store and are not portable between stores. Server filtering is backed by a local returned-category check. Leave blank for all categories.", "default": "" }, "productType": { "title": "Product type", "enum": [ "any", "simple", "variable", "grouped", "external" ], "type": "string", "description": "Any returns the store's default public product collection. Variable returns parent products with available child IDs/options, not separately fetched child SKUs/prices. No private/admin variation endpoint is used.", "default": "any" }, "includeDescription": { "title": "Include clean plain-text descriptions", "type": "boolean", "description": "Optional descriptions up to 10,000 characters and short descriptions up to 3,000. No extra event fee. Password-protected descriptions remain unavailable; no password or cookie is submitted.", "default": false }, "pageSize": { "title": "Products requested per page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Up to 100, reduced for smaller initial product/budget caps and then kept fixed throughout a store's pagination. Reduce if a store's response exceeds 4 MiB. At most 100 pages per store / 120 HTTP requests per run / two minutes of collection. Small page sizes can hit these safety caps before a large export finishes.", "default": 100 }, "failOnStoreError": { "title": "Fail on any store error", "type": "boolean", "description": "By default, continue with other stores and report failed/partial sources in OUTPUT. If all stores fail with no valid results, the run fails. When enabled, stop and fail at the first source error; previously saved products remain available and billable.", "default": 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 } } } } } } } } } }