{ "openapi": "3.0.1", "info": { "title": "WooCommerce Product Scraper | $0.9/1K | Shopify CSV Export", "description": "Scrape any WooCommerce catalog via the public Store API. Full variant prices, reviews text, related products, discount %, product intelligence score. Export to Shopify CSV (migration) or Google Merchant feed. $0.0009 per product ($0.9 per 1,000).", "version": "1.0", "x-build-id": "XNfibeF2gZTt0ZYBf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~woocommerce-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-woocommerce-product-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/apivault_labs~woocommerce-product-scraper/runs": { "post": { "operationId": "runs-sync-apivault_labs-woocommerce-product-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/apivault_labs~woocommerce-product-scraper/run-sync": { "post": { "operationId": "run-sync-apivault_labs-woocommerce-product-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", "required": [ "storeUrls" ], "properties": { "storeUrls": { "title": "WooCommerce Store or Product URLs", "type": "array", "description": "Accepts:\n• Store domain — https://woocommerce.com (pulls entire catalog)\n• Product URL — https://store.com/product/awesome-shirt/\n• Bare domain — store.com\nMix them freely.", "items": { "type": "string" } }, "maxProducts": { "title": "Max products per store", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Limit per store (0 = unlimited). Default: 250.", "default": 250 }, "perPage": { "title": "Products per page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Products per API page. WooCommerce max: 100.", "default": 100 }, "flattenVariants": { "title": "One row per variant", "type": "boolean", "description": "If true: outputs one row per variant (size/color) with full variant prices and stock. Auto-enables enrichVariants.", "default": false }, "enrichVariants": { "title": "Enrich variants (full data)", "type": "boolean", "description": "Make a second API call per product to get full variant prices, stock, attributes, plus related_ids and cross-sells. Slower but adds rich variant data.", "default": false }, "extractReviewsText": { "title": "Extract review text", "type": "boolean", "description": "Pull actual review text + reviewer info per product. Adds 1 extra API call per product.", "default": false }, "reviewsPerProduct": { "title": "Reviews per product", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many recent reviews to fetch per product when extractReviewsText is on.", "default": 5 }, "exportFormat": { "title": "Export format", "enum": [ "default", "shopify-csv", "shopify-csv-only", "google-merchant", "google-merchant-only", "custom-csv", "catalog-snapshot" ], "type": "string", "description": "Output format. 'default' = full JSON. 'shopify-csv' / 'shopify-csv-only' = WC → Shopify migration. 'google-merchant' / 'google-merchant-only' = Google Shopping feed. 'custom-csv' = user-defined columns (use customColumns). 'catalog-snapshot' = ONE aggregate record per store.", "default": "default" }, "customColumns": { "title": "Custom CSV columns", "type": "string", "description": "Comma-separated column names for exportFormat='custom-csv'. Example: 'productId,title,price,brand,categorySlugs,inStock,averageRating'. Available columns: productId, productUrl, slug, title, price, regularPrice, salePrice, currency, discountPct, sku, brand, autoCategory, categories, tags, inStock, averageRating, reviewCount, popularityRank, isNewArrival, productIntelligenceScore, mainImage, images, variationsCount, etc.", "default": "" }, "convertToCurrency": { "title": "Convert prices to currency", "type": "string", "description": "Optional ISO currency code (USD, EUR, GBP). If set and store currency differs, adds 'priceUsd' / 'priceEur' / etc field with live FX-converted price. Free FX rates from open.er-api.com.", "default": "" }, "onlyInStock": { "title": "Only in-stock products", "type": "boolean", "description": "Skip products that are out of stock.", "default": false }, "category": { "title": "Filter by category slug", "type": "string", "description": "Optional: only fetch products from this category slug (e.g. 'hoodies').", "default": "" }, "extractTitle": { "title": "Product Title", "type": "boolean", "description": "Extract product name", "default": true }, "extractPrice": { "title": "Price", "type": "boolean", "description": "Extract current price", "default": true }, "extractRegularPrice": { "title": "Regular Price", "type": "boolean", "description": "Extract regular (non-sale) price", "default": true }, "extractSalePrice": { "title": "Sale Price", "type": "boolean", "description": "Extract sale price", "default": true }, "extractSku": { "title": "SKU", "type": "boolean", "description": "Extract SKU codes", "default": true }, "extractDescription": { "title": "Description", "type": "boolean", "description": "Extract full product description (HTML stripped)", "default": true }, "extractShortDescription": { "title": "Short Description", "type": "boolean", "description": "Extract short product description", "default": true }, "extractImages": { "title": "Images", "type": "boolean", "description": "Extract all image URLs", "default": true }, "extractCategories": { "title": "Categories", "type": "boolean", "description": "Extract category list", "default": true }, "extractTags": { "title": "Tags", "type": "boolean", "description": "Extract product tags", "default": true }, "extractAttributes": { "title": "Attributes", "type": "boolean", "description": "Extract product attributes (brand, material, etc.)", "default": true }, "extractStock": { "title": "Stock / Availability", "type": "boolean", "description": "Extract stock availability status and low-stock count", "default": true }, "extractRating": { "title": "Rating", "type": "boolean", "description": "Extract average rating and review count", "default": true }, "extractVariations": { "title": "Variations", "type": "boolean", "description": "Extract product variation IDs (when not flattening)", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel store fetches", "default": 3 }, "timeout": { "title": "Timeout per request (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "HTTP timeout per API call", "default": 30 } } }, "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 } } }, "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 } } } } } } } } } }