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

Officeworks Availability API Documentation

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

Officeworks Availability API Documentation Get stock for one sku at a store and postcode: click and collect, in store and delivery to door, with quantities, dates and the store record. 1 credit per request. Failed requests are never billed.

Officeworks Availability API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/officeworks/availability
Auth header
x-api-key
Cost
1 credit / request
sku = example
Response preview
200 OK
{
    "data": {
        "availability": {
            "sku": "HPD90S3PA",
            "store": {
                "id": "W251",
                "name": "Officeworks Melbourne",
                "state": "VIC",
                "status": "OPEN",
                "postcode": "3000"
            },
            "ranged": {
                "online": true,
                "inStore": true
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

2 optional filters available.

sku string Required

Sku from a live search

Example value example
storeId string Optional

Store id, e.g. W251

Example value example
postcode string Optional

Four digit postcode, e.g. 2000

Example value example

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": {
        "availability": {
            "sku": "HPD90S3PA",
            "store": {
                "id": "W251",
                "name": "Officeworks Melbourne",
                "state": "VIC",
                "status": "OPEN",
                "postcode": "3000"
            },
            "ranged": {
                "online": true,
                "inStore": true
            },
            "inStore": {
                "quantity": 5,
                "available": true
            },
            "productType": "PRODUCT",
            "deliverToDoor": {
                "quantity": 9,
                "available": true
            },
            "clickAndCollect": {
                "quantity": 5,
                "available": true,
                "available_date": null,
                "quick_collect_available": true,
                "relative_available_date": null
            }
        }
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "graphql_availability"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

Supply a valid sku from a live search. 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.