{
"openapi": "3.0.1",
"info": {
"title": "Shopify & WooCommerce Products Scraper + Price Tracker",
"description": "Export full product catalogs from any Shopify or WooCommerce store: prices, sale prices, discounts, stock, variants, images. Optional price and stock change tracking between runs. No browser, no login.",
"version": "1.0",
"x-build-id": "J3X79b2rLFOyOiDlx"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/despottt~shop-products-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-despottt-shop-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/despottt~shop-products-scraper/runs": {
"post": {
"operationId": "runs-sync-despottt-shop-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/despottt~shop-products-scraper/run-sync": {
"post": {
"operationId": "run-sync-despottt-shop-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": [
"storeUrls"
],
"properties": {
"storeUrls": {
"title": "Store URLs",
"type": "array",
"description": "Home page or any URL of Shopify / WooCommerce stores, e.g. allbirds.com, https://colourpop.com. The platform is detected automatically.",
"items": {
"type": "string"
}
},
"platform": {
"title": "Platform",
"enum": [
"auto",
"shopify",
"woocommerce"
],
"type": "string",
"description": "Leave on auto unless detection fails.",
"default": "auto"
},
"keywords": {
"title": "Keywords (any)",
"type": "array",
"description": "Keep products whose title, type, tags or categories contain any of these words.",
"default": [],
"items": {
"type": "string"
}
},
"excludeKeywords": {
"title": "Exclude keywords",
"type": "array",
"description": "Drop products whose title contains any of these words.",
"default": [],
"items": {
"type": "string"
}
},
"productTypes": {
"title": "Product types / categories",
"type": "array",
"description": "Exact product type (Shopify) or category name (WooCommerce).",
"default": [],
"items": {
"type": "string"
}
},
"vendors": {
"title": "Vendors / brands",
"type": "array",
"description": "Exact vendor or brand names.",
"default": [],
"items": {
"type": "string"
}
},
"minPrice": {
"title": "Min price",
"minimum": 0,
"type": "integer",
"description": "Lowest price in store currency (whole units)."
},
"maxPrice": {
"title": "Max price",
"minimum": 0,
"type": "integer",
"description": "Highest price in store currency (whole units)."
},
"onlyAvailable": {
"title": "Only in stock",
"type": "boolean",
"description": "Skip sold-out products.",
"default": false
},
"onlyOnSale": {
"title": "Only on sale",
"type": "boolean",
"description": "Only products with a compare-at / regular price higher than the current price.",
"default": false
},
"includeVariants": {
"title": "Include variants",
"type": "boolean",
"description": "Add every variant (size, colour, SKU, price, stock).",
"default": false
},
"includeDescription": {
"title": "Include description",
"type": "boolean",
"description": "Add the plain-text product description.",
"default": false
},
"trackChanges": {
"title": "Track price & stock changes",
"type": "boolean",
"description": "Keep a snapshot between runs (same store list) and add changeType, previousPrice and priceChange to each product. Ideal with an Apify Schedule.",
"default": false
},
"outputOnlyChanges": {
"title": "Output only changes",
"type": "boolean",
"description": "With change tracking on, output only new or changed products (you pay only for those).",
"default": false
},
"maxProductsPerStore": {
"title": "Max products per store",
"minimum": 0,
"type": "integer",
"description": "0 = whole catalog.",
"default": 0
},
"maxItems": {
"title": "Max products in total",
"minimum": 0,
"type": "integer",
"description": "0 = no limit. Also see Maximum cost per run in the run options.",
"default": 0
}
}
},
"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
}
}
}
}
}
}
}
}
}
}