# FoodWorks AU Product Search & Catalog (Unofficial) (`dromb/foodworks-au-product-search-catalog-unofficial`) Actor

Search products from FoodWorks Australia and fetch normalized catalog data for search, item pages, and category pages.

- **URL**: https://apify.com/dromb/foodworks-au-product-search-catalog-unofficial.md
- **Developed by:** [Dmitriy Gyrbu](https://apify.com/dromb) (community)
- **Categories:** E-commerce, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.10 / 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

## FoodWorks AU Product Search, Catalog & Store Discovery (Unofficial)

Search products from FoodWorks Australia, fetch normalized catalog data, and discover
real shop values from the live store chooser.

This is an unofficial actor and is not affiliated with FoodWorks.

### Supported operations

- `stores`
- `search`
- `item`
- `categories`
- `category`

### 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.

- `stores`
  Required: none
  Optional: `query`, `limit`, `includeRaw`
- `search`
  Required: `query`
  Optional: `shop`, `page`, `includeRaw`
- `item`
  Required: `itemSlug` or `itemId`
  Optional: `shop`, `includeRaw`
- `categories`
  Required: none
  Optional: `shop`, `topOnly`, `includeRaw`
- `category`
  Required: `categorySlug` or `categoryId`
  Optional: `shop`, `page`, `includeRaw`

### How shop values work

Do not rely on old examples like `eastivanhoe` unless you verified that store is
still online.

Use the `stores` operation first. It parses `https://shop.foodworks.com.au/change`
and returns the current live store list, including:

- `shop`: canonical host prefix, for example `griffithreddrop-shop`
- `catalogue_url`
- `shop_url`
- `store_info_url`
- address, phone, and store attributes

The current verified working examples in this actor use `griffithreddrop-shop`.

### Example inputs

```json
{
  "operation": "stores",
  "query": "griffith",
  "limit": 5,
  "includeRaw": false
}
````

```json
{
  "operation": "search",
  "shop": "griffithreddrop-shop",
  "query": "bananas",
  "page": 1,
  "includeRaw": false
}
```

```json
{
  "operation": "categories",
  "shop": "griffithreddrop-shop",
  "topOnly": true,
  "includeRaw": false
}
```

```json
{
  "operation": "category",
  "shop": "griffithreddrop-shop",
  "categorySlug": "fruit-vegetables",
  "page": 1,
  "includeRaw": false
}
```

```json
{
  "operation": "item",
  "shop": "griffithreddrop-shop",
  "itemSlug": "bananas-kg",
  "includeRaw": false
}
```

### Output

- Dataset: normalized products or structured category/store rows
- Key-value store `OUTPUT`: run summary with `source`, `operation`, `success`, `total`, `errors`, `proxy`, and `monetization`

### Notes

- `search` uses the upstream Myfoodlink `q` parameter, not the older broken `query` parameter.
- `shop` accepts a host prefix like `griffithreddrop-shop`, a store name like `Griffith`, or a full shop URL.
- `item` payloads now include richer metadata such as category path, availability, currency, and store context.
- `topOnly=true` limits `categories` output to top-level categories.
- Default proxy strategy is `direct`.
- The runtime is prepared for future pay-per-event monetization.

# 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.

## `shop` (type: `string`):

Optional for categories, category, search, and item. Use the `stores` operation to discover real values such as `griffithreddrop-shop`, a store name like `Griffith`, or a full shop URL.

## `query` (type: `string`):

Required for `search`. Optional filter text for `stores`.

## `itemId` (type: `string`):

Optional for `item`. Use `itemId` or `itemSlug`.

## `itemSlug` (type: `string`):

Optional for `item`. Use `itemSlug` or `itemId`.

## `categoryId` (type: `string`):

Optional for `category`. Use `categoryId` or `categorySlug`.

## `categorySlug` (type: `string`):

Optional for `category`. Use `categorySlug` or `categoryId`.

## `page` (type: `integer`):

Optional for `search` and `category`. One-based page index.

## `limit` (type: `integer`):

Optional for `stores`. Maximum number of rows to return.

## `topOnly` (type: `boolean`):

Optional for `categories`. Return only top-level category rows.

## `includeRaw` (type: `boolean`):

Optional for any operation. Include the unnormalized source payload in the OUTPUT summary.

## Actor input object example

```json
{
  "operation": "stores",
  "shop": "griffithreddrop-shop",
  "page": 1,
  "limit": 25,
  "topOnly": true,
  "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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("dromb/foodworks-au-product-search-catalog-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("dromb/foodworks-au-product-search-catalog-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/foodworks-au-product-search-catalog-unofficial --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=dromb/foodworks-au-product-search-catalog-unofficial",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "FoodWorks AU Product Search & Catalog (Unofficial)",
        "description": "Search products from FoodWorks Australia and fetch normalized catalog data for search, item pages, and category pages.",
        "version": "0.0",
        "x-build-id": "LdsXy0pSVW4Wcugct"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/dromb~foodworks-au-product-search-catalog-unofficial/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-dromb-foodworks-au-product-search-catalog-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~foodworks-au-product-search-catalog-unofficial/runs": {
            "post": {
                "operationId": "runs-sync-dromb-foodworks-au-product-search-catalog-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~foodworks-au-product-search-catalog-unofficial/run-sync": {
            "post": {
                "operationId": "run-sync-dromb-foodworks-au-product-search-catalog-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": [
                            "stores",
                            "search",
                            "item",
                            "categories",
                            "category"
                        ],
                        "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": "stores"
                    },
                    "shop": {
                        "title": "Shop",
                        "type": "string",
                        "description": "Optional for categories, category, search, and item. Use the `stores` operation to discover real values such as `griffithreddrop-shop`, a store name like `Griffith`, or a full shop URL.",
                        "default": "griffithreddrop-shop"
                    },
                    "query": {
                        "title": "Query",
                        "type": "string",
                        "description": "Required for `search`. Optional filter text for `stores`."
                    },
                    "itemId": {
                        "title": "Item Slug Alias",
                        "type": "string",
                        "description": "Optional for `item`. Use `itemId` or `itemSlug`."
                    },
                    "itemSlug": {
                        "title": "Item Slug",
                        "type": "string",
                        "description": "Optional for `item`. Use `itemSlug` or `itemId`."
                    },
                    "categoryId": {
                        "title": "Category Slug Alias",
                        "type": "string",
                        "description": "Optional for `category`. Use `categoryId` or `categorySlug`."
                    },
                    "categorySlug": {
                        "title": "Category Slug",
                        "type": "string",
                        "description": "Optional for `category`. Use `categorySlug` or `categoryId`."
                    },
                    "page": {
                        "title": "Page",
                        "type": "integer",
                        "description": "Optional for `search` and `category`. One-based page index.",
                        "default": 1
                    },
                    "limit": {
                        "title": "Store Limit",
                        "type": "integer",
                        "description": "Optional for `stores`. Maximum number of rows to return.",
                        "default": 25
                    },
                    "topOnly": {
                        "title": "Top-Level Categories Only",
                        "type": "boolean",
                        "description": "Optional for `categories`. Return only top-level category rows.",
                        "default": true
                    },
                    "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
