# Coles AU Product Search Scraper (`dromb/coles-au-product-search-specials-stores-unofficial`) Actor Scrape Coles Australia product search results, prices, specials, categories, store context, barcode lookups, and normalized item data for grocery monitoring workflows. - **URL**: https://apify.com/dromb/coles-au-product-search-specials-stores-unofficial.md - **Developed by:** [Dmitriy Gyrbu](https://apify.com/dromb) (community) - **Categories:** E-commerce, Automation, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $0.04 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Coles AU Product Search & Catalog (Unofficial) Search Coles Australia products and fetch categories, specials, and normalized item data. This is an unofficial actor and is not affiliated with Coles. ### Supported operations - `categories` - `search` - `search_filters` - `item` - `category` - `specials` - `specials_filters` - `specials_catalogue` - `item_by_barcode` - `item_by_gtin` - `store` - `stores_by_postcode` - `nearby_stores` - `stores_search` - `item_store_context` - `availability_by_store` ### Operation guide The Apify Console form shows the union of all supported fields, so the visible inputs do not change when you switch `operation`. Use the guide below to know which fields are required. - `categories` Required: none Optional: `refresh`, `includeRaw` - `search` Required: `query` Optional: `page`, `limit`, `details`, `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `search_filters` Required: none Optional: `query`, `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `category` Required: `categorySlug`, `categoryId`, or `categoryUrl` Optional: `page`, `limit`, `details`, `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `item` Required: `itemId`, `productId`, `itemSlug`, `slug`, or `url` Optional: `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `specials` Required: none Optional: `special`, `page`, `limit`, `details`, `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `specials_filters` Required: none Optional: `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `specials_catalogue` Required: `slug`, `categorySlug`, or `url` Optional: `page`, `limit`, `details`, `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `item_by_barcode` Required: `barcode` Optional: `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `item_by_gtin` Required: `gtin` Optional: `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `store` Required: `storeId` Optional: `includeRaw` - `stores_by_postcode` Required: `postcode` Optional: `state`, `radius`, `limit`, `includeRaw` - `nearby_stores` Required: `lat`, `lon` Optional: `radius`, `limit`, `includeRaw` - `stores_search` Required: `query` Optional: `state`, `radius`, `limit`, `includeRaw` - `item_store_context` Required: `itemId`, `productId`, `itemSlug`, `slug`, or `url` Optional: `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` - `availability_by_store` Required: `itemId`, `productId`, `itemSlug`, `slug`, or `url` Optional: `storeId`, `postcode`, `state`, `contextMode`, `includeRaw` ### Recommended first runs If you are validating the actor from scratch, use these in order: 1. `categories` 2. `search` 3. `item` 4. `specials` Then use ids/slugs from those results in the more targeted operations. ### Example inputs ```json { "operation": "categories", "includeRaw": false } ```` ```json { "operation": "search", "query": "milk", "page": 1, "limit": 20, "includeRaw": false } ``` ```json { "operation": "item", "itemId": "8150288", "includeRaw": false } ``` ```json { "operation": "category", "categoryId": "1300", "page": 1, "limit": 20, "includeRaw": false } ``` ```json { "operation": "specials", "special": "halfprice", "page": 1, "limit": 20, "includeRaw": false } ``` ### Output - Dataset: normalized products, category rows, filters, or item records - Key-value store `OUTPUT`: run summary with `source`, `operation`, `success`, `total`, `errors`, `proxy`, and `monetization` ### Notes - Coles is the richest actor in this bundle, so the Apify Console will show a large union of optional fields. - `search`, `categories`, and `item` are the best smoke tests. - `item` and `category` now have validated starter examples: `8150288` and `1300`. - If Coles cannot resolve the current site build id, the actor now returns a structured blocked error instead of the raw `build_id_unavailable` note. - Store-aware fields are supported where Coles returns them, but standalone store locator endpoints should be treated as best-effort. - The actor uses a private custom proxy pool configured as secret environment variables. # Actor input Schema ## `operation` (type: `string`): Actor operation to execute. The Console form shows all possible fields at once, so check the README for the exact required inputs for each operation. ## `query` (type: `string`): Required for `search` and `stores_search`. Optional for `search_filters` sample collection. ## `page` (type: `integer`): Optional for `search`, `category`, and `specials_catalogue`. ## `limit` (type: `integer`): Optional for listing operations. ## `details` (type: `boolean`): Optional for `search`, `category`, `specials`, and `specials_catalogue`. ## `storeId` (type: `string`): Optional store-aware context for product and specials operations. ## `postcode` (type: `string`): Optional postcode or required for `stores_by_postcode`. ## `state` (type: `string`): Optional Australian state code for store-aware Coles operations. ## `contextMode` (type: `string`): Optional store context mode. Default is `delivery`. ## `categoryId` (type: `string`): Optional for `category`. ## `categorySlug` (type: `string`): Optional for `category` or `specials_catalogue`. ## `categoryUrl` (type: `string`): Optional full category URL for `category`. ## `itemId` (type: `string`): Optional for `item`, `item_store_context`, or `availability_by_store`. ## `productId` (type: `string`): Optional for Coles item operations. ## `itemSlug` (type: `string`): Optional for item-oriented operations. ## `slug` (type: `string`): Optional slug alias for item or specials-catalogue operations. ## `url` (type: `string`): Optional full product/category/catalogue URL. ## `special` (type: `string`): Optional for `specials`: `allspecials`, `halfprice`, `multibuy`, or `onlineonly`. ## `barcode` (type: `string`): Required for `item_by_barcode`. ## `gtin` (type: `string`): Required for `item_by_gtin`. ## `radius` (type: `integer`): Optional for store search operations. ## `lat` (type: `number`): Required for `nearby_stores`. ## `lon` (type: `number`): Required for `nearby_stores`. ## `refresh` (type: `boolean`): Optional for `categories`. Force live category refresh. ## `includeRaw` (type: `boolean`): Optional for any operation. Include the unnormalized source payload in the OUTPUT summary. ## Actor input object example ```json { "operation": "search", "query": "milk", "page": 1, "limit": 8, "details": false, "contextMode": "delivery", "special": "allspecials", "radius": 25, "refresh": false, "includeRaw": false } ``` # Actor output Schema ## `results` (type: `string`): Normalized dataset items returned by the actor. ## `summary` (type: `string`): Run summary JSON stored under the OUTPUT key. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("dromb/coles-au-product-search-specials-stores-unofficial").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("dromb/coles-au-product-search-specials-stores-unofficial").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call dromb/coles-au-product-search-specials-stores-unofficial --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=dromb/coles-au-product-search-specials-stores-unofficial", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Coles AU Product Search Scraper", "description": "Scrape Coles Australia product search results, prices, specials, categories, store context, barcode lookups, and normalized item data for grocery monitoring workflows.", "version": "0.0", "x-build-id": "qVlgbPbPJPb1KxtIK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dromb~coles-au-product-search-specials-stores-unofficial/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dromb-coles-au-product-search-specials-stores-unofficial", "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/dromb~coles-au-product-search-specials-stores-unofficial/runs": { "post": { "operationId": "runs-sync-dromb-coles-au-product-search-specials-stores-unofficial", "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/dromb~coles-au-product-search-specials-stores-unofficial/run-sync": { "post": { "operationId": "run-sync-dromb-coles-au-product-search-specials-stores-unofficial", "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", "required": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "categories", "search", "search_filters", "item", "category", "specials", "specials_filters", "specials_catalogue", "item_by_barcode", "item_by_gtin", "store", "stores_by_postcode", "nearby_stores", "stores_search", "item_store_context", "availability_by_store" ], "type": "string", "description": "Actor operation to execute. The Console form shows all possible fields at once, so check the README for the exact required inputs for each operation.", "default": "search" }, "query": { "title": "Query", "type": "string", "description": "Required for `search` and `stores_search`. Optional for `search_filters` sample collection.", "default": "milk" }, "page": { "title": "Page", "type": "integer", "description": "Optional for `search`, `category`, and `specials_catalogue`.", "default": 1 }, "limit": { "title": "Limit", "type": "integer", "description": "Optional for listing operations.", "default": 8 }, "details": { "title": "Enrich Details", "type": "boolean", "description": "Optional for `search`, `category`, `specials`, and `specials_catalogue`.", "default": false }, "storeId": { "title": "Store ID", "type": "string", "description": "Optional store-aware context for product and specials operations." }, "postcode": { "title": "Postcode", "type": "string", "description": "Optional postcode or required for `stores_by_postcode`." }, "state": { "title": "State", "type": "string", "description": "Optional Australian state code for store-aware Coles operations." }, "contextMode": { "title": "Context Mode", "type": "string", "description": "Optional store context mode. Default is `delivery`.", "default": "delivery" }, "categoryId": { "title": "Category ID", "type": "string", "description": "Optional for `category`." }, "categorySlug": { "title": "Category Slug", "type": "string", "description": "Optional for `category` or `specials_catalogue`." }, "categoryUrl": { "title": "Category URL", "type": "string", "description": "Optional full category URL for `category`." }, "itemId": { "title": "Item ID Alias", "type": "string", "description": "Optional for `item`, `item_store_context`, or `availability_by_store`." }, "productId": { "title": "Product ID", "type": "string", "description": "Optional for Coles item operations." }, "itemSlug": { "title": "Item Slug", "type": "string", "description": "Optional for item-oriented operations." }, "slug": { "title": "Slug Alias", "type": "string", "description": "Optional slug alias for item or specials-catalogue operations." }, "url": { "title": "URL", "type": "string", "description": "Optional full product/category/catalogue URL." }, "special": { "title": "Special View", "type": "string", "description": "Optional for `specials`: `allspecials`, `halfprice`, `multibuy`, or `onlineonly`.", "default": "allspecials" }, "barcode": { "title": "Barcode", "type": "string", "description": "Required for `item_by_barcode`." }, "gtin": { "title": "GTIN", "type": "string", "description": "Required for `item_by_gtin`." }, "radius": { "title": "Radius", "type": "integer", "description": "Optional for store search operations.", "default": 25 }, "lat": { "title": "Latitude", "type": "number", "description": "Required for `nearby_stores`." }, "lon": { "title": "Longitude", "type": "number", "description": "Required for `nearby_stores`." }, "refresh": { "title": "Refresh Categories", "type": "boolean", "description": "Optional for `categories`. Force live category refresh.", "default": false }, "includeRaw": { "title": "Include Raw Payload", "type": "boolean", "description": "Optional for any operation. Include the unnormalized source payload in the OUTPUT summary.", "default": false } } }, "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 } } } } } } } } } } ```