Skip to content
Scrappa Get API key
Officeworks API 1 credit / request

Officeworks Search API Documentation

GET https://scrappa.co/api/officeworks/search

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.

Officeworks Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/officeworks/search
Auth header
x-api-key
Cost
1 credit / request
Response preview
200 OK
{
    "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": {
...

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.

query string Optional

Search text, e.g. laptop

Example value coffee shops
category string Optional

Category from a search hit

Example value example
brand string Optional

Brand from a search hit

Example value example
colour string Optional

Colour facet value

Example value example
sort string Optional

newest, price_asc, price_desc, rating_asc, rating_desc or name

Example value relevance
price_min number Optional

Minimum price in AUD

Example value 10
price_max number Optional

Maximum price in AUD

Example value 10
page integer Optional

Zero-based page number, default 0

Example value 1
hitsPerPage integer Optional

Results per page, default 24

Example value 10
clearance boolean Optional

Only clearance items

Example value true
ranged boolean Optional

Only ranged items

Example value true

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "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.

422

Validation Error

A query parameter is invalid. Failed requests are not billed.

503

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.