{ "openapi": "3.0.1", "info": { "title": "WooCommerce Store Products Scraper - Any Store, Full Catalog", "description": "Export the full product catalog of any WooCommerce store from its public REST API: titles, SKU, prices, sale prices, stock, categories, tags, images, attributes and every variation with its own price and stock. Optional price and stock change tracking. From US$0.50 per 1,000 products.", "version": "0.1", "x-build-id": "8pJgSSFbGCcJnFvfv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~woocommerce-store-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-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/fabrikit~woocommerce-store-products-scraper/runs": { "post": { "operationId": "runs-sync-fabrikit-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/fabrikit~woocommerce-store-products-scraper/run-sync": { "post": { "operationId": "run-sync-fabrikit-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": { "stores": { "title": "Stores", "type": "array", "description": "WooCommerce store domains or URLs, one per line. A store URL scrapes the whole catalog; a category URL (https://store.com/product-category/shoes/) scrapes only that category; a product URL (https://store.com/product/my-shirt/) scrapes one product. Stores in a sub-folder (store.com/shop) are found automatically.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "catalog", "changes" ], "type": "string", "description": "Catalog: export every product. Changes: compare with the previous run of the same store (kept in a named key-value store) and output only new, removed and price/stock-changed products.", "default": "catalog" }, "flattenVariants": { "title": "One row per variation", "type": "boolean", "description": "Output one record per variation (product fields repeated on each row; sku, price and stock are the variation's) instead of one record per product with a variants array. Counts every variation as one result. Ignored in Changes mode.", "default": false }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Total records to save across all stores (products, or variants when 'One row per variant' is on).", "default": 50 }, "maxItemsPerStore": { "title": "Maximum results per store", "minimum": 1, "type": "integer", "description": "Optional cap for each store, useful when you list many stores." }, "categories": { "title": "Categories", "type": "array", "description": "Only these categories (slug, name, id or category URL). Applies to the whole run for each store.", "items": { "type": "string" } }, "searchQuery": { "title": "Search keyword", "type": "string", "description": "Only products matching this keyword (uses the store's own search)." }, "onlyInStock": { "title": "Only products in stock", "type": "boolean", "description": "Skip products that are out of stock. Ignored in Changes mode.", "default": false }, "onlyOnSale": { "title": "Only products on sale", "type": "boolean", "description": "Skip products that are not on sale. Ignored in Changes mode.", "default": false }, "includeVariations": { "title": "Include variations", "type": "boolean", "description": "For variable products, also load every variation with its own SKU, price, sale price and stock (1 extra request per ~20 variable products).", "default": true }, "includeDates": { "title": "Include created / modified dates", "type": "boolean", "description": "Add createdAt/updatedAt from the WordPress feed (1 extra request per 100 products). Skipped automatically if the store hides it.", "default": true }, "includeDescription": { "title": "Include description (plain text)", "type": "boolean", "description": "Add the product description as plain text.", "default": false }, "includeDescriptionHtml": { "title": "Include description (HTML)", "type": "boolean", "description": "Add the original description HTML.", "default": false }, "listCategories": { "title": "Also save the category list", "type": "boolean", "description": "Save each store's categories (id, name, slug, parent, product count, URL) to a key-value store record named CATEGORIES_. Free, not counted as results.", "default": false }, "changeTrackingStoreName": { "title": "Snapshot store name (Changes mode)", "type": "string", "description": "Name of the key-value store that remembers the previous run. Use the same name on every scheduled run; use a different name to track a separate watch-list.", "default": "woocommerce-store-products-snapshots" }, "emitBaseline": { "title": "Output the full catalog on the first Changes run", "type": "boolean", "description": "By default the first Changes run only stores the baseline and outputs nothing. Turn this on to also get every product (marked changeType 'baseline').", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Most stores answer datacenter IPs. If a store rate-limits or blocks, the actor automatically switches to a residential proxy for the rest of the run.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }