Officeworks Search API Documentation Search the public Australian office supplies catalogue by query, category, brand, colour, sort, AUD price range, zero-based page and clearance or ranged flags. Hits carry sku, name, brand, AUD price, categories, stock flags and full-size image URLs. Ids work unchanged in the next routes. 1 credit per request. Failed requests are never billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
11 optional filters available.
string
Optional
Search text, e.g. laptop
coffee shops
string
Optional
Category from a search hit
example
string
Optional
Brand from a search hit
example
string
Optional
Colour facet value
example
string
Optional
newest, price_asc, price_desc, rating_asc, rating_desc or name
relevance
number
Optional
Minimum price in AUD
10
number
Optional
Maximum price in AUD
10
integer
Optional
Zero-based page number, default 0
1
integer
Optional
Results per page, default 24
10
boolean
Optional
Only clearance items
true
boolean
Optional
Only ranged items
true
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"hits": [
{
"sku": "HPD90S3PA",
"url": "https://www.officeworks.com.au/hp-laptop",
"name": "HP Laptop",
"brand": "HP",
"flags": {
"ranged": true,
"clearance": false
},
"image": "https://www.officeworks.com.au/image.jpg",
"price": {
"current": 397,
"currency": "AUD",
"discount": null,
"original": null
},
"rating": {
"count": 120,
"average": 4.5
},
"highlight": null,
"attributes": [],
"categories": [
"Computers/Laptops"
]
}
],
"page": 0,
"query": "laptop",
"facets": {
"brand": {
"HP": 120
}
},
"nbHits": 1200,
"nbPages": 50,
"hitsPerPage": 24
},
"meta": {
"credits": 1,
"billable": true,
"endpoint_family": "algolia_search"
},
"success": true
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A query parameter is invalid. Failed requests are not billed.
Upstream Unavailable
The source is temporarily unavailable. Failed requests are not billed.
Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.