Woolworths specials
Woolworths (Australia) specials by group (half price, lower shelf price, everyday low price, seasonal price, buy more save more, online only, bundles, Everyday Market), optionally narrowed to one department: total, and each product's stockcode, name, brand, link, package size, price, was price and savings, unit price, special / half-price flags, promotion text, multibuy and member prices, stock and availability, sponsored flag, departments, ingredients, allergens, dietary claims, health star rating, nutrition and images. facets lists brands, allergens, dietary and health star filters with counts; groups and departments list the values to pass back. Pass next_page back as page; null on the last page.
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
group | string | Specials group (default half-price): half-price, lower-shelf-price, everyday-low-price, seasonal-price, buy-more-save-more, online-only-specials, bundles, everyday-market-specials-and-offers; the response's groups lists the current ones. Example: half-price |
department | string | Only this department of the group, e.g. pantry, drinks, freezer (the response's departments lists them). |
sort | relevance | price_asc | price_desc | unit_price_asc | unit_price_desc | name | Order (default relevance). |
limit | integer | Products per page (default 24, 10-36). |
page | integer | Page number. Pass next_page from the previous response; null on the last page. |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/woolworths/v1/specials?group=half-price" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/woolworths/v1/specials",
params={"group": "half-price"},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json() const url = new URL("https://api.api.sh/woolworths/v1/specials");
url.searchParams.set("group", "half-price");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json(); Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).