{ "openapi": "3.0.1", "info": { "title": "Woolworths NZ Scraper: Prices, Specials & Club Deals", "description": "Get Woolworths New Zealand prices for milk, bread and weekly specials. Collect store prices, regular and member offers, promotion dates, unit prices, stock, barcode, brand and size by postcode, category or product. About $0.003 per product, or $3 for 1,000. No login.", "version": "1.0", "x-build-id": "HY1eULGcuofjeaClR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vant47~woolworths-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vant47-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/vant47~woolworths-nz-scraper/runs": { "post": { "operationId": "runs-sync-vant47-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/vant47~woolworths-nz-scraper/run-sync": { "post": { "operationId": "run-sync-vant47-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": "Search products such as milk, coffee or bread. Leave empty when using category/product links or product IDs.", "items": { "type": "string" } }, "startUrls": { "title": "Category, deals or product links", "type": "array", "description": "Optional woolworths.co.nz product, browse, specials or search links. Product links may use the current product-details or older productdetails form.", "items": { "type": "string" } }, "productIds": { "title": "Product stockcodes", "type": "array", "description": "Optional numeric stockcodes, for example 282764. Current product names and canonical barcodes are checked for the same store.", "items": { "type": "string" } }, "locations": { "title": "NZ postcodes", "type": "array", "description": "Four-digit NZ pickup-store postcodes, including leading zeros. Exact public directory matches; current site postal aliases are checked when needed. Examples: 0629, 8051, 9016, 9300 and 2022. Multiple stores use the first by name. Unknown postcodes give a free note; empty uses the site default.", "items": { "type": "string" } }, "storeIds": { "title": "Pickup-address IDs", "type": "array", "description": "Optional retailer pickup-address IDs, for example 1225718 for Northlands or 1190273 for Glenfield. These differ from fulfilment store IDs returned in output. Unknown IDs give free notes.", "items": { "type": "string" } }, "maxItemsPerSearch": { "title": "Maximum products examined per search or category", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Product candidates examined for each search/category at each selected store. Deals filtering and duplicates can reduce delivered rows.", "default": 20 }, "maxItems": { "title": "Maximum product-store rows", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Run-wide cap on unique product-store rows, across all inputs and stores. About $0.003 per row: 20 rows cost $0.06 plus the small start charge. Raise this to cover every requested store.", "default": 20 }, "dealsOnly": { "title": "Deals only", "type": "boolean", "description": "Deliver current specials, member prices, multibuy or points offers. Regular low shelf prices alone are not counted as a discount.", "default": false }, "includeDetails": { "title": "Include ingredients and nutrition", "type": "boolean", "description": "Slower: fetch product details for ingredients, nutrition, allergens, origins and health star rating where published. Included in the product price. Failed enrichment is not an extra charge.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "NZ residential is the verified route. Datacenter and direct connections failed feasibility. Custom proxies and direct mode are honored; a failed configured Apify datacenter connection can retry through NZ residential.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "NZ" } } } }, "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 } } } } } } } } } }