{ "openapi": "3.0.1", "info": { "title": "Shopify Product Search - All Stores, Any Keyword", "description": "Search products across all Shopify stores via the Shop app. No store URL needed — just a keyword. Extract prices, variants, reviews, ratings, images, and sales volume. Filter by price, category, stock, and shipping. Export as JSON or CSV.", "version": "0.0", "x-build-id": "vKR1RHHpKgYXzzgjW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearpath~shop-by-shopify-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearpath-shop-by-shopify-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/clearpath~shop-by-shopify-product-scraper/runs": { "post": { "operationId": "runs-sync-clearpath-shop-by-shopify-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/clearpath~shop-by-shopify-product-scraper/run-sync": { "post": { "operationId": "run-sync-clearpath-shop-by-shopify-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", "properties": { "category": { "title": "Category", "enum": [ "", "gid://shopify/ProductCategory/1", "gid://shopify/ProductCategory/2", "gid://shopify/ProductCategory/3", "gid://shopify/ProductCategory/5", "gid://shopify/ProductCategory/6", "gid://shopify/ProductCategory/7", "gid://shopify/ProductCategory/9", "gid://shopify/ProductCategory/10", "gid://shopify/ProductCategory/15", "gid://shopify/ProductCategory/69", "gid://shopify/ProductCategory/209", "gid://shopify/ProductCategory/251", "gid://shopify/ProductCategory/267", "gid://shopify/ProductCategory/285", "gid://shopify/ProductCategory/25", "gid://shopify/ProductCategory/26", "gid://shopify/ProductCategory/27", "gid://shopify/ProductCategory/28", "gid://shopify/ProductCategory/33", "gid://shopify/ProductCategory/34", "gid://shopify/ProductCategory/35", "gid://shopify/ProductCategory/36", "gid://shopify/ProductCategory/37", "gid://shopify/ProductCategory/38", "gid://shopify/ProductCategory/39", "gid://shopify/ProductCategory/40", "gid://shopify/ProductCategory/187" ], "type": "string", "description": "Select a category to scrape. Works on its own (scrapes entire category) or combined with a search query to filter results." }, "query": { "title": "Search query (optional)", "type": "string", "description": "Product search term. Optional if a category is selected above." }, "maxItems": { "title": "Max products", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of products to scrape", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "most_recent", "price_low_to_high", "price_high_to_low" ], "type": "string", "description": "How to sort search results", "default": "relevance" }, "priceMin": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum price filter" }, "priceMax": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum price filter" }, "onSale": { "title": "On sale only", "type": "boolean", "description": "Only show products currently on sale", "default": false }, "inStock": { "title": "In stock only", "type": "boolean", "description": "Only show products that are in stock", "default": false }, "shipsFrom": { "title": "Ships from my country", "type": "boolean", "description": "Only show products from local sellers (based on your location)", "default": false }, "shipsTo": { "title": "Ships to country", "enum": [ "", "US", "CA", "GB", "AU", "DE", "FR", "IT", "ES", "NL", "BE", "AT", "CH", "SE", "DK", "NO", "FI", "IE", "PT", "PL", "CZ", "RO", "HU", "GR", "HR", "BG", "SK", "SI", "LT", "LV", "EE", "IS", "LU", "NZ", "JP", "KR", "SG", "HK", "TW", "MY", "PH", "TH", "ID", "VN", "IN", "BR", "MX", "CO", "AR", "CL", "ZA", "AE", "SA", "IL", "TR", "NG", "EG", "KE" ], "type": "string", "description": "Only show products that ship to this country" } } }, "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 } } } } } } } } } }