{ "openapi": "3.0.1", "info": { "title": "Kohl's Product Scraper", "description": "Scrape Kohl's (kohls.com) products — title, regular/sale/Your Price, ratings, review counts, SKUs, colors, availability, brand and category. Search by keyword (no proxy) or enrich with full detail. Clean JSON for Sheets, BI or your CRM. Pay only for the results you get.", "version": "1.0", "x-build-id": "lVnsNYyeXTPI8bYsa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~kohls-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-kohls-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/axlymxp~kohls-product-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-kohls-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/axlymxp~kohls-product-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-kohls-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords to search on kohls.com (one search per keyword). This is the fast, no-proxy path and returns full product data. Leave empty if you only use category dimensions or product IDs.", "default": [], "items": { "type": "string" } }, "categoryDimensions": { "title": "Category dimensions (optional, needs US proxy)", "type": "array", "description": "Browse whole categories by Kohl's facet path, e.g. 'Gender:Mens+Product:Jeans+Department:Clothing' (the same value found after CN= in a Kohl's catalog URL). Category browse is US-geo-gated, so a US residential proxy is used automatically.", "default": [], "items": { "type": "string" } }, "productIds": { "title": "Product IDs or URLs (optional, needs US proxy)", "type": "array", "description": "Fetch full detail for specific products by web ID (e.g. '5178' or 'prd-5178') or by product URL. Product detail is US-geo-gated (US residential proxy used automatically, with an Internet-Archive fallback).", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items (total)", "minimum": 1, "type": "integer", "description": "Global cap across all queries, categories and product IDs. The run stops once this many products are pushed to the dataset.", "default": 200 }, "maxPagesPerQuery": { "title": "Max pages per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Search/category pages to fetch per query (120 products per page).", "default": 5 }, "sort": { "title": "Sort order", "enum": [ "featured", "new", "bestsellers", "priceAsc", "priceDesc", "rating", "percentOff" ], "type": "string", "description": "Result ordering for searches and category browses.", "default": "featured" }, "includeDetails": { "title": "Include full detail (brand, description, taxonomy)", "type": "boolean", "description": "Enrich each product with brand, short/long description and breadcrumb taxonomy (department/category/subcategory) from the product page. This step is US-geo-gated, so a US residential proxy is used automatically and the run is slower. Best-effort: Kohl's blocks some product pages, leaving these fields empty for those items — the core product data (prices, ratings, SKUs, colors, availability) is always returned regardless.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used only for the geo-gated add-ons (category browse, product-ID detail, and Include full detail). Keyword search runs without a proxy. A US residential proxy is recommended for the gated endpoints.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }