{ "openapi": "3.0.1", "info": { "title": "Woolworths AU Products: Search, Categories, Specials, GTIN", "description": "More complete results than the leading store alternative. Woolworths Australia prices, unit prices, specials, nutrition and barcodes from search terms, categories, specials, stockcodes or GTINs in one run, paged to the site total, sponsored tiles de-duplicated, optional changed-prices-only mode.", "version": "0.0", "x-build-id": "5oEHHNMKiPRoBXnPq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kiamehr74~woolworths-au-grocery-catalog/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kiamehr74-woolworths-au-grocery-catalog", "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/kiamehr74~woolworths-au-grocery-catalog/runs": { "post": { "operationId": "runs-sync-kiamehr74-woolworths-au-grocery-catalog", "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/kiamehr74~woolworths-au-grocery-catalog/run-sync": { "post": { "operationId": "run-sync-kiamehr74-woolworths-au-grocery-catalog", "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": "Keyword searches (36 products per page, paged to the site total or Max items).", "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs or ids", "type": "array", "description": "Browse pages such as the dairy-eggs-fridge URL, or a category NodeId such as 1_6E4F4E4.", "items": { "type": "string" } }, "specials": { "title": "Specials groups", "type": "array", "description": "Any of: half-price, lower-shelf-price, everyday-low-price, buy-more-save-more, online-only-specials, seasonal-price, bundles.", "items": { "type": "string" } }, "productIds": { "title": "Stockcodes or product URLs", "type": "array", "description": "Refreshed in bulk (about 20 per request).", "items": { "type": "string" } }, "gtins": { "title": "Barcodes (GTIN/EAN-13)", "type": "array", "description": "Exact-match lookup; an unknown barcode gives a free status entry in the run log.", "items": { "type": "string" } }, "fullCatalog": { "title": "Full catalogue", "type": "boolean", "description": "Walk every department with cross-department de-duplication (tens of thousands of products: set Max items).", "default": false }, "sortBy": { "title": "Sort", "enum": [ "relevance", "priceLowToHigh", "priceHighToLow", "unitPriceLowToHigh", "name" ], "type": "string", "description": "Sort order of search and category pages.", "default": "relevance" }, "includeSponsored": { "title": "Include sponsored tiles", "type": "boolean", "description": "Off = organic tiles only; position is the organic rank.", "default": false }, "includeNutrition": { "title": "Nutrition and allergens", "type": "boolean", "description": "From list pages, no extra requests.", "default": true }, "fetchDetails": { "title": "Fetch details", "type": "boolean", "description": "One extra request per product for structured nutrition and country of origin (charged as product-detail).", "default": false }, "onlyChangedPrices": { "title": "Only changed prices", "type": "boolean", "description": "Monitor mode: emit only products whose price changed since the last run (state in a named key-value store).", "default": false }, "maxItems": { "title": "Max products", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Global cap on charged products.", "default": 50 }, "maxPagesPerSource": { "title": "Max pages per source", "minimum": 1, "maximum": 500, "type": "integer", "description": "Safety cap per search/category (36 per page).", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential Australian proxy is on by default: Woolworths blocks datacenter IPs (HTTP 403). Keep it unless you have your own Australian residential proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "AU" } } } }, "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 } } } } } } } } } }