{ "openapi": "3.0.1", "info": { "title": "WooCommerce Products Scraper – Store API Export", "description": "Export every product of a WooCommerce store through its public Store API: title, SKU, prices and sale prices, stock, categories, tags, attributes, ratings, images and links, one row per product. No login, no API keys, no proxies, no personal data; pay only for the rows delivered.", "version": "1.0", "x-build-id": "eLz4yg2hQVKeghN8r" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rowcraft~woocommerce-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rowcraft-woocommerce-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/rowcraft~woocommerce-products-scraper/runs": { "post": { "operationId": "runs-sync-rowcraft-woocommerce-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/rowcraft~woocommerce-products-scraper/run-sync": { "post": { "operationId": "run-sync-rowcraft-woocommerce-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", "required": [ "stores" ], "properties": { "stores": { "title": "Stores", "type": "array", "description": "WooCommerce stores to read, one per line: a domain (`offermanwoodshop.com`), a store URL, a category URL (`https://store.com/product-category/gifts/`) or a product URL (`https://store.com/product/handle/`).", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Keep products whose category, category path, product type or collection contains one of these words (case ignored): `coffee`, `women > dresses`. To read one category only, paste its URL in Stores instead.", "items": { "type": "string" } }, "brands": { "title": "Brands", "type": "array", "description": "Keep products of these brands or vendors only (exact name, case ignored).", "items": { "type": "string" } }, "tags": { "title": "Tags", "type": "array", "description": "Keep products carrying one of these tags, case ignored.", "items": { "type": "string" } }, "titleContains": { "title": "Title contains", "type": "array", "description": "Keep products whose title contains one of these words (case ignored).", "items": { "type": "string" } }, "availableOnly": { "title": "In stock only", "type": "boolean", "description": "Keep only products the store marks as available.", "default": false }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Keep only products with a reduced price (a list or compare-at price above the selling price).", "default": false }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Lowest selling price to keep, in the store's currency." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Highest selling price to keep, in the store's currency." }, "includeDescription": { "title": "Description as text", "type": "boolean", "description": "Deliver the product description as plain text (HTML removed, contact details masked). Switch off for a lighter export.", "default": true }, "includeImages": { "title": "Image list", "type": "boolean", "description": "Deliver the full image list of each product (the first image URL is always in its own column).", "default": true }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Stop each store after this many products. 0 = all.", "default": 0 }, "maxItems": { "title": "Max rows", "minimum": 0, "type": "integer", "description": "Stop the run after this many rows in total. 0 = no limit.", "default": 500 }, "countOnly": { "title": "Count only (free check)", "type": "boolean", "description": "Only count how many rows match your filters and estimate the cost at your price tier. Nothing is delivered and nothing is charged apart from the start event. Turn it off to get the data.", "default": false }, "onlyNew": { "title": "Only new rows since the last run", "type": "boolean", "description": "Remember the rows already delivered to you (in a key-value store in your Apify account) and deliver only rows that appeared since the last run with the same state key. The first run delivers everything that matches; later runs cost only the new rows. Ideal for schedules.", "default": false }, "stateName": { "title": "State name", "type": "string", "description": "Name of the memory used by \"Only new rows\". Use a different name for each schedule or search (for example `stockholm-python`) so they do not share one memory.", "default": "default" }, "notifyUrl": { "title": "Notify this URL when the run ends", "type": "string", "description": "A webhook address that receives one JSON POST with the number of new rows and links to the dataset: a Slack or Discord incoming webhook, a Make, n8n or Zapier catch hook, or your own endpoint. The message is also in the `text` (Slack) and `content` (Discord) fields." }, "notifyWhenEmpty": { "title": "Notify also when there are no new rows", "type": "boolean", "description": "By default the notification is sent only when at least one row was delivered.", "default": false }, "requestIntervalMs": { "title": "Pause between requests (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Pause between two requests to the same run's stores: 1000 ms by default (one request per second), 500 ms at the lowest.", "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 } } } } } } } } } }