---
title: "Scrape Coles (Australia) groceries"
method: POST
path: "/groceries/coles"
tags: ["Plugins"]
---

# Scrape Coles (Australia) groceries

`POST /groceries/coles`

## Request

- Base URL: `https://api.scrapeunblocker.com`
- URL: `https://api.scrapeunblocker.com/groceries/coles`
- Auth: API key in header `x-scrapeunblocker-key`

Coles Australia (coles.com.au) products as JSON. `mode=search&query=`, `mode=category&category=` and `mode=specials` return `products`: `id`, `name`, `brand`, `size`, `url`, `price`, `wasPrice`, `onSale`, `savings`, `promotion` (`type` half_price / special / multibuy / offer, `text`, multibuy `quantity` and `price`), `unitPrice` (`price`, `per`, `text`), `inStock`, `available`, `availableQuantity`, `purchaseLimit`, `promotionalLimit`, `onlineOnly`, `sponsored`, `image`, `categories` and `minimumShelfLife`, plus `totalResults`, `totalPages` and `nextPage`. `special` limits a search or the specials listing to half-price, multibuy or online-only deals. `mode=product&product=` returns `product` with those fields and `barcode`, `description`, `ingredients`, `allergens`, `dietary`, `storage`, `nutrition` (per serving and per 100 g / mL), `servingSize`, `servingsPerPack`, `countryOfOrigin`, `images` and `variants`. Prices are Coles' online prices in AUD. Listings collect up to `max_results` from `page` on, billed one unit per page.

## Query parameters

- `mode` string, nullable: 'search' (default): products matching `query`. 'category': a category listing. 'specials': the products on special. 'product': one product with nutrition and ingredients. Defaults to 'product' when `product` is given and to 'category' when `category` is.
- `query` string, nullable: What to search for (mode=search), e.g. 'milk', 'tim tam', 'chicken breast'.
- `category` string, nullable: mode=category: a browse link (https://www.coles.com.au/browse/dairy-eggs-fridge/milk) or its path ('dairy-eggs-fridge/milk').
- `product` string, nullable: mode=product: a Coles product id ('8150288') or a product link (https://www.coles.com.au/product/coles-full-cream-milk-3l-8150288).
- `special` string, nullable: Products on special only: all, half-price, multibuy, online-only. mode=specials defaults to 'all'; with mode=search it filters the results.
- `sort` string: Listing order: relevance, price_asc, price_desc, unit_price_asc.
- `page` integer: 1-based listing page to start from (48 products per page).
- `max_results` integer: Products to collect across pages, 1-480. Each page fetched is billed one unit.
- `proxy_country` string, nullable: Proxy country the request is sent from: AU, NZ, US or CA (Coles serves only these). Leave blank to spread over all of them.

## Response `200`

JSON with `products` (listings) or `product`. A search with no matches answers 200 with an empty `products` list.

- unknown

## Other responses

- `400`: Invalid parameters.
- `404`: Coles has no such product or category.
- `422`: Validation Error
- `502`: Blocked by Coles on every attempt, an unusable answer, or no answer in time.

---

[API](https://skmtc.dev/scrapeunblocker/apis/scrapeunblocker-api.md) · [All operations](https://skmtc.dev/scrapeunblocker/apis/scrapeunblocker-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeunblocker/apis/scrapeunblocker-api/revisions/c02f1254cc47?raw)