# Woolworths (Australia) — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and browse Woolworths supermarket products with detailed information including nutritional content, current pricing, and special offers. Get autocomplete suggestions while shopping, explore products by category, and access real-time data on what's available and on sale.

**Category:** Food & Dining | **Website:** [woolworths.com.au/](https://woolworths.com.au/) | **Docs:** [parse.bot/marketplace/8abc9026-2b7c-4a44-bc12-e610b16029f5/woolworths-com-au-api](https://parse.bot/marketplace/8abc9026-2b7c-4a44-bc12-e610b16029f5/woolworths-com-au-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-woolworths-com-au-api-8abc9026/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_category_products

Browse products within a specific category using the category's node_id and url_friendly_name from list_categories. Returns paginated product listings with total count.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | Yes | Category node ID from list_categories (e.g. '1_5AF3A0A' for Drinks). |
| `category_url` | string | No | URL-friendly category name from list_categories (e.g. 'drinks', 'dairy-eggs-fridge'). |
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of products per page. |
| `sort_type` | string | No | Sort order for results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-woolworths-com-au-api-8abc9026/get_category_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"<string>","category_url":"<string>","page":"<integer>","page_size":"<integer>","sort_type":"<string>"}'
```

### get_product_detail

Get full product details including nutritional information, ingredients, allergens, health star rating, country of origin, and images for a specific product identified by its stockcode. Returns a single product object with all available metadata.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `stockcode` | string | Yes | Woolworths product stockcode (numeric ID from search_products results, e.g. '888140'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-woolworths-com-au-api-8abc9026/get_product_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"stockcode":"<string>"}'
```

### get_specials

Get current specials and promotional products by searching with the specials filter enabled. Requires a search term to scope which specials are returned. Paginates via page number.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of products per page. |
| `search_term` | string | No | Search term to filter specials (e.g. 'milk', 'bread', 'chocolate'). |
| `sort_type` | string | No | Sort order for results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-woolworths-com-au-api-8abc9026/get_specials \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","page_size":"<integer>","search_term":"<string>","sort_type":"<string>"}'
```

### list_categories

List the full product category tree including specials, departments, and subcategories. Each category includes a node_id and url_friendly_name that can be used with get_category_products. No parameters required.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-woolworths-com-au-api-8abc9026/list_categories \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_products

Search for products by keyword with pagination and sorting. Returns matching products with pricing, availability, and stock information. Paginates via page number; total_products gives the full count of matching results across all pages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `is_special` | string | No | Filter to only show products on special. Accepts: true, false. |
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of products per page. |
| `search_term` | string | No | Search query term. |
| `sort_type` | string | No | Sort order for results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-woolworths-com-au-api-8abc9026/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"is_special":"<string>","page":"<integer>","page_size":"<integer>","search_term":"<string>","sort_type":"<string>"}'
```

### search_suggestions

Get autocomplete search suggestions for a given partial or complete search term. Returns up to 10 suggestion strings and any auto-corrected term.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `search_term` | string | Yes | Partial or complete search term to get suggestions for. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-woolworths-com-au-api-8abc9026/search_suggestions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"search_term":"<string>"}'
```