{ "openapi": "3.0.1", "info": { "title": "Woolworths NZ Scraper — Prices, Club Prices, Specials", "description": "Woolworths New Zealand (woolworths.co.nz, ex-Countdown) product data: prices, was prices, specials, club prices, multi-buys, promotion dates, unit prices, stock, barcodes, departments, images; ingredients and allergens on detail rows. By keyword, department or SKU. Pay per result, no login.", "version": "0.0", "x-build-id": "zpp01ya1Bw0mEJFqg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/architekture~woolworths-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-architekture-woolworths-nz-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/architekture~woolworths-nz-scraper/runs": { "post": { "operationId": "runs-sync-architekture-woolworths-nz-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/architekture~woolworths-nz-scraper/run-sync": { "post": { "operationId": "run-sync-architekture-woolworths-nz-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search, e.g. \"milk\", \"weet-bix\". One result set per term.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Whole departments to browse, by name, id or URL (case-insensitive): Dinner (1), Fruit & Veg (2), Meat & Poultry (3), Fish & Seafood (4), Fridge & Deli (5), Bakery (6), Frozen (7), Pantry (8), Beer & Wine (9), Drinks (10), Health & Body (11), Household (12), Baby & Child (13), Pet (14). Also accepts https://www.woolworths.co.nz/shop/browse/pantry.", "items": { "type": "string" } }, "skus": { "title": "SKUs or product URLs", "type": "array", "description": "Specific products: SKUs (e.g. 282768) or product URLs (https://www.woolworths.co.nz/shop/productdetails/282768/...). Always returns full detail (charged as product-detail).", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max items per search term / department", "minimum": 0, "type": "integer", "description": "Cap results per search term or department. 0 = no cap (a department can be several thousand products).", "default": 100 }, "includeDetails": { "title": "Fetch full product details", "type": "boolean", "description": "Also call the product detail endpoint for every result: allergens, ingredients, claims, health star rating, country of origin, extra images. Slower (Woolworths answers detail requests in ~10 s each, 6 at a time). Rows that get detail data are charged as product-detail; if a detail request fails the row keeps listing data and is charged as product.", "default": false }, "incrementalMode": { "title": "Incremental: only new or changed products", "type": "boolean", "description": "Requires stateKey. Delivers only products that are new to this stateKey, or whose price, club/special flags, multi-buy or promotion end date changed since they were last delivered. Unchanged products are skipped and not charged.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Any name (e.g. my-basket). Keeps saved progress and the incremental baseline in your account, isolated per key. Use a different key for different inputs.", "default": "" }, "continuePreviousRun": { "title": "Continue saved collection", "type": "boolean", "description": "Resume an unfinished collection saved under stateKey (after a spending limit, timeout, abort or platform migration). Delivered products are not delivered or charged again.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy is the tested default (verified 2026-10-17). Switch to RESIDENTIAL with country NZ only if a run reports blocked queries.", "default": { "useApifyProxy": true } }, "feedback": { "title": "Feedback for the maintainers", "type": "string", "description": "Tell the maintainers what you needed and did not get. Read by a human; does not change the output." } } }, "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 } } } } } } } } } }