Search Woolworths products
Woolworths (Australia) product search: stockcode, barcode, name, brand, link, package size, price, was price and savings, unit price (per kg/L), in-store price, special / half-price flags, promotion text, multibuy and member prices, stock and availability for delivery, pickup and express, departments and categories, ingredients, allergens (contains / may contain), dietary and lifestyle claims, health star rating, nutrition panel per 100 g and per serve, images, and size variants. facets lists the departments the results fall into; related_searches the site's suggested refinements. 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 |
|---|---|---|
qrequired | string | Search keywords. Example: milk |
sort | relevance | price_asc | price_desc | unit_price_asc | unit_price_desc | name | Order: relevance (default), price_asc, price_desc, unit_price_asc, unit_price_desc, name. |
specials | boolean | true for products on special only. |
limit | integer | Products per page, 10-36 (default 24). |
page | integer | Page number, 1 for the first. Pass back next_page. |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/woolworths/v1/search?q=milk" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/woolworths/v1/search",
params={"q": "milk"},
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/search");
url.searchParams.set("q", "milk");
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).