# Officeworks API — Australia's office, school & tech retailer: search, full product records, live price incl./excl. GST, stock at every store, reviews, Q&A, categories, brands, stores

> Keyword search over the whole Officeworks catalogue (37 378 products indexed on 2026-11-16) with every filter and sort the site's listing pages offer: category, brand, price range, rating, state, store, colour, clearance, online / in-store and the category-specific refinements. Each row carries the live price incl. and excl. GST (the call the site's own result tiles make) and the search index's price beside it.
> ReefAPI engine `officeworks` · 22 endpoints · clean JSON, no scraping or browsers to manage.

## How to call
- **Endpoint:** `POST https://api.reefapi.com/officeworks/v1/<action>` with a JSON body.
- **Auth:** header `x-api-key: <YOUR_REEFAPI_KEY>` — create one free (1,000 credits, no card): https://reefapi.com/signup
- **Response (every call):** `{ ok: boolean, data: ..., meta: { record_count, credits, ... }, error: { code, message } }` — branch on `ok`. Failed calls are free.
- **One key + one shared credit pool** across every ReefAPI API. Per-call credits are listed on each endpoint below.
- **Use it from an AI agent (MCP):** connect `https://api.reefapi.com/mcp` (remote streamable-http). Clients that add connectors by URL, such as ChatGPT and the Claude app, connect with OAuth 2.1 (the user pastes their key once on a ReefAPI page; discovery at `/.well-known/oauth-protected-resource/mcp`). Config files send the key as `Authorization: Bearer <key>`. `?key=<key>` in the URL also works as a last-resort fallback.

## Endpoints

### POST https://api.reefapi.com/officeworks/v1/search — 2 credits
Keyword search over the whole Officeworks catalogue (37 378 products indexed on 2026-11-16) with every filter and sort the site's listing pages offer: category, brand, price range, rating, state, store, colour, clearance, online / in-store and the category-specific refinements. Each row carries the live price incl. and excl. GST (the call the site's own result tiles make) and the search index's price beside it.

**Parameters:**
- `query` (string, required) — Search words, a SKU or a barcode (the site's search covers name, brand, SKU, GTIN, part number, category). When nothing matches, the source drops trailing words (see `words_removed`).
- `sort` (enum, optional, default "relevance") — Result order — the seven sort options of the site's own listing pages. [one of: relevance, best_match, newest, name, price_asc, price_desc, rating_desc, rating_asc]
- `page` (integer, optional, default 1) — 1-based page. The source serves the first 1 000 results of any listing.
- `page_size` (integer, optional, default 24) — Rows per page (the site's pages show 24).
- `category` (string, optional) — Category path or category link; a parent path includes all its sub-categories.
- `brand` (string, optional) — Brand name as the site prints it (Pilot, J.Burrows) or its slug (j-burrows).
- `min_price` (number, optional) — Minimum price in AUD incl. GST (applied by the site's search index, like its own price filter).
- `max_price` (number, optional) — Maximum price in AUD incl. GST (applied by the site's search index).
- `min_rating` (integer, optional) — Minimum average star rating (1-5).
- `state` (enum, optional) — Only products ranged in this state. [one of: NSW, VIC, QLD, SA, WA, TAS, ACT, NT]
- `store_id` (string, optional) — Only products ranged at this store (store ids from `stores`).
- `colour` (string, optional) — Colour as the site lists it.
- `clearance` (boolean, optional) — true = only clearance-priced products, false = exclude them.
- `available_online` (boolean, optional) — true = only products sold online.
- `available_in_store` (boolean, optional) — true = only products ranged in stores.
- `facet_filters` (object, optional) — Any other refinement the site shows for the listing, as {facet: value or [values]} (values OR within a facet, facets AND). Facet names and values come from `facets` of an earlier call (all_facets=true lists every one).
- `all_facets` (boolean, optional, default false) — Return every refinement facet with counts (default: brand, colour, rating, price, state, category, clearance, online / in-store).

**Returns:** results[]{sku, name, brand, url, image, price_inc_gst_aud (live), gst_aud, price_ex_gst_aud, price_source, index_price_inc_gst_aud, index_price_differs, currency, rating (0-5), review_count, gtin, manufacturer_part_number, colour, status, available_online, available_in_store, clearance, is_new, units_per_pack, substitutes[], category_paths[], leaf_categories[], parent_categories[], category_names[], web_hierarchy, merch_hierarchy, merch_category, back_to_school_range[], date_created, ranged_states[], ranged_store_ids[], ranged_store_count, site_rank{}, attributes{category refinements}} + count + total + page + page_size + total_pages + has_more + reachable_results + total_exceeds_reachable + query_used + words_removed + facets{name: [{value, count}]} + price_stats{min_aud, max_aud, avg_aud} + index_price_differs_count + filters + sort + sort_match_scope (full | narrow: price_asc matches fewer products, as on the site) + sort_match_note

**Example request body:**
```json
{
  "query": "stapler"
}
```

### POST https://api.reefapi.com/officeworks/v1/suggestions — 1 credit
The search box's own query suggestions for a few typed letters, with each suggestion's popularity, its exact result count and the categories it lands in.

**Parameters:**
- `query` (string, required) — What the user has typed so far.
- `limit` (integer, optional, default 10) — How many suggestions.

**Returns:** suggestions[]{query, popularity, word_count, exact_results, top_categories[{name, count}]} + count

**Example request body:**
```json
{
  "query": "stapler"
}
```

### POST https://api.reefapi.com/officeworks/v1/category_products — 2 credits
One category's products (a parent category includes every sub-category) with the same filters, sorts and paging as `search`, plus the category's name, description and breadcrumbs.

**Parameters:**
- `query` (string, optional) — Search words, a SKU or a barcode (the site's search covers name, brand, SKU, GTIN, part number, category). When nothing matches, the source drops trailing words (see `words_removed`).
- `sort` (enum, optional, default "relevance") — Result order — the seven sort options of the site's own listing pages. [one of: relevance, best_match, newest, name, price_asc, price_desc, rating_desc, rating_asc]
- `page` (integer, optional, default 1) — 1-based page. The source serves the first 1 000 results of any listing.
- `page_size` (integer, optional, default 24) — Rows per page (the site's pages show 24).
- `category` (string, required) — Category path (from `categories`) or a category link.
- `brand` (string, optional) — Brand name as the site prints it (Pilot, J.Burrows) or its slug (j-burrows).
- `min_price` (number, optional) — Minimum price in AUD incl. GST (applied by the site's search index, like its own price filter).
- `max_price` (number, optional) — Maximum price in AUD incl. GST (applied by the site's search index).
- `min_rating` (integer, optional) — Minimum average star rating (1-5).
- `state` (enum, optional) — Only products ranged in this state. [one of: NSW, VIC, QLD, SA, WA, TAS, ACT, NT]
- `store_id` (string, optional) — Only products ranged at this store (store ids from `stores`).
- `colour` (string, optional) — Colour as the site lists it.
- `clearance` (boolean, optional) — true = only clearance-priced products, false = exclude them.
- `available_online` (boolean, optional) — true = only products sold online.
- `available_in_store` (boolean, optional) — true = only products ranged in stores.
- `facet_filters` (object, optional) — Any other refinement the site shows for the listing, as {facet: value or [values]} (values OR within a facet, facets AND). Facet names and values come from `facets` of an earlier call (all_facets=true lists every one).
- `all_facets` (boolean, optional, default false) — Return every refinement facet with counts (default: brand, colour, rating, price, state, category, clearance, online / in-store).

**Returns:** results[]{sku, name, brand, url, image, price_inc_gst_aud (live), gst_aud, price_ex_gst_aud, price_source, index_price_inc_gst_aud, index_price_differs, currency, rating (0-5), review_count, gtin, manufacturer_part_number, colour, status, available_online, available_in_store, clearance, is_new, units_per_pack, substitutes[], category_paths[], leaf_categories[], parent_categories[], category_names[], web_hierarchy, merch_hierarchy, merch_category, back_to_school_range[], date_created, ranged_states[], ranged_store_ids[], ranged_store_count, site_rank{}, attributes{category refinements}} + count + total + page + page_size + total_pages + has_more + reachable_results + total_exceeds_reachable + query_used + words_removed + facets{name: [{value, count}]} + price_stats{min_aud, max_aud, avg_aud} + index_price_differs_count + filters + sort + sort_match_scope (full | narrow: price_asc matches fewer products, as on the site) + sort_match_note + category{category_id, name, title, path, url, description, breadcrumbs[], children[]} + category_paths_included

**Example request body:**
```json
{
  "category": "office-supplies/pens/ballpoint-pens"
}
```

### POST https://api.reefapi.com/officeworks/v1/brand_products — 2 credits
One brand's full Officeworks range with the same filters, sorts and paging as `search`, plus the brand's logo and description.

**Parameters:**
- `query` (string, optional) — Search words, a SKU or a barcode (the site's search covers name, brand, SKU, GTIN, part number, category). When nothing matches, the source drops trailing words (see `words_removed`).
- `sort` (enum, optional, default "relevance") — Result order — the seven sort options of the site's own listing pages. [one of: relevance, best_match, newest, name, price_asc, price_desc, rating_desc, rating_asc]
- `page` (integer, optional, default 1) — 1-based page. The source serves the first 1 000 results of any listing.
- `page_size` (integer, optional, default 24) — Rows per page (the site's pages show 24).
- `category` (string, optional) — Category path or category link; a parent path includes all its sub-categories.
- `brand` (string, required) — Brand name (Logitech), slug (logitech) or brand link.
- `min_price` (number, optional) — Minimum price in AUD incl. GST (applied by the site's search index, like its own price filter).
- `max_price` (number, optional) — Maximum price in AUD incl. GST (applied by the site's search index).
- `min_rating` (integer, optional) — Minimum average star rating (1-5).
- `state` (enum, optional) — Only products ranged in this state. [one of: NSW, VIC, QLD, SA, WA, TAS, ACT, NT]
- `store_id` (string, optional) — Only products ranged at this store (store ids from `stores`).
- `colour` (string, optional) — Colour as the site lists it.
- `clearance` (boolean, optional) — true = only clearance-priced products, false = exclude them.
- `available_online` (boolean, optional) — true = only products sold online.
- `available_in_store` (boolean, optional) — true = only products ranged in stores.
- `facet_filters` (object, optional) — Any other refinement the site shows for the listing, as {facet: value or [values]} (values OR within a facet, facets AND). Facet names and values come from `facets` of an earlier call (all_facets=true lists every one).
- `all_facets` (boolean, optional, default false) — Return every refinement facet with counts (default: brand, colour, rating, price, state, category, clearance, online / in-store).

**Returns:** results[]{sku, name, brand, url, image, price_inc_gst_aud (live), gst_aud, price_ex_gst_aud, price_source, index_price_inc_gst_aud, index_price_differs, currency, rating (0-5), review_count, gtin, manufacturer_part_number, colour, status, available_online, available_in_store, clearance, is_new, units_per_pack, substitutes[], category_paths[], leaf_categories[], parent_categories[], category_names[], web_hierarchy, merch_hierarchy, merch_category, back_to_school_range[], date_created, ranged_states[], ranged_store_ids[], ranged_store_count, site_rank{}, attributes{category refinements}} + count + total + page + page_size + total_pages + has_more + reachable_results + total_exceeds_reachable + query_used + words_removed + facets{name: [{value, count}]} + price_stats{min_aud, max_aud, avg_aud} + index_price_differs_count + filters + sort + sort_match_scope (full | narrow: price_asc matches fewer products, as on the site) + sort_match_note + brand{brand_id, name, slug, url, logo, description}

**Example request body:**
```json
{
  "brand": "logitech"
}
```

### POST https://api.reefapi.com/officeworks/v1/deals — 2 credits
The site's deal collections — deals, clearance, price drop, everyday low prices, Black Friday deals, what's new, price checked & dropped — with the same filters, sorts and paging as `search`.

**Parameters:**
- `collection` (enum, optional, default "deals") — Which collection. [one of: deals, clearance, price_drop, everyday_low_prices, black_friday_deals, whats_new, price_checked_price_dropped]
- `query` (string, optional) — Search words, a SKU or a barcode (the site's search covers name, brand, SKU, GTIN, part number, category). When nothing matches, the source drops trailing words (see `words_removed`).
- `sort` (enum, optional, default "relevance") — Result order — the seven sort options of the site's own listing pages. [one of: relevance, best_match, newest, name, price_asc, price_desc, rating_desc, rating_asc]
- `page` (integer, optional, default 1) — 1-based page. The source serves the first 1 000 results of any listing.
- `page_size` (integer, optional, default 24) — Rows per page (the site's pages show 24).
- `category` (string, optional) — Category path or category link; a parent path includes all its sub-categories.
- `brand` (string, optional) — Brand name as the site prints it (Pilot, J.Burrows) or its slug (j-burrows).
- `min_price` (number, optional) — Minimum price in AUD incl. GST (applied by the site's search index, like its own price filter).
- `max_price` (number, optional) — Maximum price in AUD incl. GST (applied by the site's search index).
- `min_rating` (integer, optional) — Minimum average star rating (1-5).
- `state` (enum, optional) — Only products ranged in this state. [one of: NSW, VIC, QLD, SA, WA, TAS, ACT, NT]
- `store_id` (string, optional) — Only products ranged at this store (store ids from `stores`).
- `colour` (string, optional) — Colour as the site lists it.
- `available_online` (boolean, optional) — true = only products sold online.
- `available_in_store` (boolean, optional) — true = only products ranged in stores.
- `facet_filters` (object, optional) — Any other refinement the site shows for the listing, as {facet: value or [values]} (values OR within a facet, facets AND). Facet names and values come from `facets` of an earlier call (all_facets=true lists every one).
- `all_facets` (boolean, optional, default false) — Return every refinement facet with counts (default: brand, colour, rating, price, state, category, clearance, online / in-store).

**Returns:** results[]{sku, name, brand, url, image, price_inc_gst_aud (live), gst_aud, price_ex_gst_aud, price_source, index_price_inc_gst_aud, index_price_differs, currency, rating (0-5), review_count, gtin, manufacturer_part_number, colour, status, available_online, available_in_store, clearance, is_new, units_per_pack, substitutes[], category_paths[], leaf_categories[], parent_categories[], category_names[], web_hierarchy, merch_hierarchy, merch_category, back_to_school_range[], date_created, ranged_states[], ranged_store_ids[], ranged_store_count, site_rank{}, attributes{category refinements}} + count + total + page + page_size + total_pages + has_more + reachable_results + total_exceeds_reachable + query_used + words_removed + facets{name: [{value, count}]} + price_stats{min_aud, max_aud, avg_aud} + index_price_differs_count + filters + sort + sort_match_scope (full | narrow: price_asc matches fewer products, as on the site) + sort_match_note + collection

**Example request body:**
```json
{
  "query": "stapler"
}
```

### POST https://api.reefapi.com/officeworks/v1/product — 2 credits
The full product record: name, brand, barcode (GTIN), part and model number, live price incl. and excl. GST (the price the product page shows), everyday-low-price line, price ticket (was price and dates), description, feature bullets, every spec group, all 100+ attributes, every image size, variants, accessories, substitutes, dimensions and weight, delivery window, warranty, rating and review count, category path.

**Parameters:**
- `sku` (string, required) — Officeworks SKU (LOM280BLK), a product slug or a product link.

**Returns:** product{sku, name, url, brand{}, gtin, case_gtin, manufacturer_part_number, model_number, manufacturer, colour, price_inc_gst_aud, gst_aud, price_ex_gst_aud, currency, pricing{}, edlp_price_aud, price_differs_from_edlp, price_ticket{type, start_date, end_date, was_price_aud, was_price_date, active}, ribbon, description, description_short, meta_description, features[], image, images{full[], preview[], thumb[]}, breadcrumbs[], categories[], specs[{group, attributes[{name, value}]}], attributes[{id, name, value}], variant_attributes{}, variants[], accessories[], substitutes[], product_options[], ranged{online, in_store}, status, review_count, rating_average, warranty, dimensions{}, delivery{min_days, max_days, express_delivery, method, returns_window}, date_created, ...}

**Example request body:**
```json
{
  "sku": "BI2411BE"
}
```

### POST https://api.reefapi.com/officeworks/v1/products — 3 credits
Full product records with live prices for up to 50 SKUs in one call (the source answers the whole list in one request). Unknown SKUs are listed under `missing`.

**Parameters:**
- `skus` (array, required) — Up to 50 SKUs or product links (comma-separated string or array).

**Returns:** products[]{same shape as product} + count + missing[] + requested

**Example request body:**
```json
{
  "skus": "BI2411BE,PAAP012984"
}
```

### POST https://api.reefapi.com/officeworks/v1/prices — 1 credit
Live prices for up to 500 SKUs in one call: price incl. GST, the GST amount, price excl. GST, GST rate and whether a business price exists. Same price the product page shows.

**Parameters:**
- `skus` (array, required) — Up to 500 SKUs or product links (comma-separated string or array).

**Returns:** prices[]{sku, found, price_inc_gst_aud, gst_aud, price_ex_gst_aud, gst_rate_pct, has_business_price, currency} + count + priced + missing[]

**Example request body:**
```json
{
  "skus": "BI2411BE,PAAP012984"
}
```

### POST https://api.reefapi.com/officeworks/v1/availability — 1 credit
Stock for one SKU at Officeworks stores in a single request: click & collect, in-store and delivery quantity with the date each is available. Pick stores by id, by state, nearest to a postcode, or leave all empty for every store (178).

**Parameters:**
- `sku` (string, required) — Officeworks SKU (LOM280BLK), a product slug or a product link.
- `store_ids` (array, optional) — Store ids (W + 3 digits) or store links.
- `state` (enum, optional) — Every store in this state. [one of: NSW, VIC, QLD, SA, WA, TAS, ACT, NT]
- `postcode` (string, optional) — Stores nearest this 4-digit postcode (see `nearest`).
- `nearest` (integer, optional, default 10) — How many stores nearest the postcode.
- `quantity` (integer, optional, default 1) — Quantity to check, as the site's stock checker asks.

**Returns:** product{sku, product_type, ranged_online, ranged_in_store} + stores[]{store_id, store_name, status, postcode, state, store_url, click_and_collect{available_date, relative_available_date, quantity, quick_collect_available}, in_store{…}, deliver_to_door{…}, in_store_quantity, click_and_collect_quantity} + count + stores_with_stock + total_in_store_quantity + scope

**Example request body:**
```json
{
  "sku": "BI2411BE",
  "state": "VIC"
}
```

### POST https://api.reefapi.com/officeworks/v1/store_stock — 1 credit
Stock for up to 50 SKUs at one store in a single request, as the site's result pages show it: in-store and click & collect quantity with the collection estimate, plus delivery type, quantity and arrival estimate to a postcode, and the store's name, location and phone.

**Parameters:**
- `skus` (array, required) — Up to 50 SKUs or product links.
- `store_id` (string, required) — Store id (W + 3 digits) or store link.
- `postcode` (string, optional) — Postcode for the delivery estimate (default: the store's own postcode).

**Returns:** store{store_id, name, location, phone} + postcode + items[]{sku, found, in_store_quantity, click_and_collect_quantity, collect_estimate, collect_range_estimate, quick_collect_available, delivery_type, delivery_quantity, delivery_estimate, delivery_range_estimate, ship_from_store, fulfilled_by_supplier, thirty_day_account_enabled, ranged_in_store, ranged_online} + count + in_stock_count + missing[]

**Example request body:**
```json
{
  "skus": "BI2411BE,PAAP012984",
  "store_id": "W320"
}
```

### POST https://api.reefapi.com/officeworks/v1/reviews — 1 credit
Customer reviews of a product (Bazaarvoice, as shown on the product page) with the full rating breakdown: text, title, stars, quality / value ratings, recommended or not, where it was bought, photos, helpful votes and brand responses. Sort, filter by star rating, photos only.

**Parameters:**
- `sku` (string, required) — Officeworks SKU (LOM280BLK), a product slug or a product link.
- `sort` (enum, optional, default "newest") — Review order. [one of: newest, oldest, highest, lowest, most_helpful]
- `rating` (integer, optional) — Only reviews with this star rating.
- `with_photos` (boolean, optional, default false) — Only reviews with photos.
- `page` (integer, optional, default 1)
- `page_size` (integer, optional, default 25) — Reviews per page (source maximum 100).

**Returns:** summary{average_rating, total_reviews, rating_distribution{5..1}, recommended_count, not_recommended_count, secondary_ratings{}, context_distribution{}, first_review, last_review} + reviews[]{review_id, rating, title, text, pros, cons, submitted, last_modified, author_nickname, author_id, author_location, is_recommended, is_ratings_only, secondary_ratings{}, context{}, helpful_votes, not_helpful_votes, badges[], photos[], brand_responses[]} + count + total + page + page_size + has_more

**Example request body:**
```json
{
  "sku": "BI2411BE"
}
```

### POST https://api.reefapi.com/officeworks/v1/questions — 1 credit
Customer questions on a product with every answer (staff and brand answers flagged).

**Parameters:**
- `sku` (string, required) — Officeworks SKU (LOM280BLK), a product slug or a product link.
- `sort` (enum, optional, default "newest") — Question order. [one of: newest, oldest, most_answers]
- `page` (integer, optional, default 1)
- `page_size` (integer, optional, default 20) — Questions per page (source maximum 100).

**Returns:** questions[]{question_id, question, details, submitted, author_nickname, author_location, answer_count, answers[]{answer_id, text, submitted, author_nickname, is_staff, is_brand_answer, is_best_answer, helpful_votes}} + count + total + total_answers + page + has_more

**Example request body:**
```json
{
  "sku": "BI2411BE"
}
```

### POST https://api.reefapi.com/officeworks/v1/review_stats — 1 credit
Average rating, review count, question and answer counts for up to 100 SKUs in one call.

**Parameters:**
- `skus` (array, required) — Up to 100 SKUs or product links.

**Returns:** stats[]{sku, name, average_rating, review_count, question_count, answer_count} + count + missing[]

**Example request body:**
```json
{
  "skus": "BI2411BE,PAAP012984"
}
```

### POST https://api.reefapi.com/officeworks/v1/categories — 1 credit
The site's whole category tree (departments, categories, sub-categories; 1 254 nodes on 2026-11-16) or one branch of it.

**Parameters:**
- `root` (string, optional) — Only this branch (a category path).

**Returns:** categories[]{name, path, url, level, child_count, children[]} + count

**Example request body:**
```json
{
  "root": "technology"
}
```

### POST https://api.reefapi.com/officeworks/v1/category — 1 credit
One category: name, page title, description, image, sub-categories and breadcrumbs.

**Parameters:**
- `category` (string, required) — Category path or category link.

**Returns:** category{category_id, web_id, name, title, path, url, description, short_description, thumbnail, children[], breadcrumbs[]}

**Example request body:**
```json
{
  "category": "office-supplies/pens/ballpoint-pens"
}
```

### POST https://api.reefapi.com/officeworks/v1/brands — 1 credit
Every brand Officeworks sells (850 on 2026-11-16) with logo, description and brand page, optionally filtered by a name fragment.

**Parameters:**
- `query` (string, optional) — Only brands whose name contains this text.
- `page` (integer, optional, default 1)
- `page_size` (integer, optional, default 100)

**Returns:** brands[]{brand_id, name, slug, url, logo, description, published, sponsored_page_url} + count + total + page + page_size + has_more

**Example request body:**
```json
{
  "query": "logi"
}
```

### POST https://api.reefapi.com/officeworks/v1/brand — 1 credit
One brand: name, logo, description and its brand pages.

**Parameters:**
- `brand` (string, required) — Brand slug, name or brand link.

**Returns:** brand{brand_id, name, slug, url, logo, description, published, sponsored_page_url}

**Example request body:**
```json
{
  "brand": "logitech"
}
```

### POST https://api.reefapi.com/officeworks/v1/stores — 1 credit
Every Officeworks store (178 on 2026-11-16), grouped by state, with address and phone.

**Parameters:**
- `state` (enum, optional) — Only this state. [one of: NSW, VIC, QLD, SA, WA, TAS, ACT, NT]

**Returns:** stores[]{store_id, name, address{street, suburb, postcode, state}, phone, url} + count + by_state{}

### POST https://api.reefapi.com/officeworks/v1/store — 1 credit
One store: address, coordinates, phone, fax, e-mail, opening hours, holiday hours and services.

**Parameters:**
- `store_id` (string, required) — Store id (W + 3 digits) or store page link.

**Returns:** store{store_id, name, status, opening_date, address{}, latitude, longitude, phone, fax, email, opening_hours[], exception_hours[], services{}, url}

**Example request body:**
```json
{
  "store_id": "W320"
}
```

### POST https://api.reefapi.com/officeworks/v1/stores_nearby — 1 credit
The site's store finder: nearest stores to a postcode, a suburb or lat,lng, with distance, full address, hours and services.

**Parameters:**
- `location` (string, required) — 4-digit postcode, suburb name or lat,lng.
- `limit` (integer, optional, default 10) — How many stores.
- `state` (enum, optional) — Pick the suburb in this state when the name exists in several. [one of: NSW, VIC, QLD, SA, WA, TAS, ACT, NT]

**Returns:** location{input, postcode, suburb, state} + stores[]{same as store + distance_km} + count

**Example request body:**
```json
{
  "location": "2000"
}
```

### POST https://api.reefapi.com/officeworks/v1/locations — 1 credit
Suburb / postcode suggestions from the site's delivery-location box.

**Parameters:**
- `query` (string, required) — Suburb name or postcode, partial is fine.
- `limit` (integer, optional, default 10) — How many suggestions.

**Returns:** locations[]{suburb, postcode, state} + count

**Example request body:**
```json
{
  "query": "stapler"
}
```

### POST https://api.reefapi.com/officeworks/v1/sitemap — 3 credits
Every URL the site publishes in its sitemaps: products (40 035 with SKU), categories, stores, content pages, campaigns — paged.

**Parameters:**
- `type` (enum, optional, default "products") — Which sitemap. [one of: products, categories, stores, content, campaigns]
- `page` (integer, optional, default 1)
- `page_size` (integer, optional, default 1000)

**Returns:** links[]{url, lastmod, changefreq, priority, sku | category_path | store_id} + count + total + page + page_size + has_more + type

## At scale
- **Volume:** 5M+ requests a day, measured at 60 requests a second across the fleet with no
  central bottleneck. Per-key limits are raised for high-volume accounts; volume pricing on request.
- **Missing a source:** tell us a site we do not cover and it becomes an engine. A customer asked
  for bestprice.gr on 21 Sep 2026 and it was in the catalog on 22 Sep.
- **Support:** 2 minute median time from a question in the live chat to the first answer. Setup
  help included, no support tier to buy.
- **One key, one credit pool** across every API. No per-site plans, no separate subscriptions.

## More
- Try it live, no code: https://reefapi.com/playground?engine=officeworks
- Human docs page: https://reefapi.com/docs/officeworks
- Overview page: https://reefapi.com/officeworks-api
- Every ReefAPI API in one file (for your AI): https://reefapi.com/llms-full.txt
