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

Officeworks Sitemap API Documentation

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

Officeworks Sitemap API Documentation Read the public sitemap index or a product sub-sitemap, paged. Product urls expose skus that work unchanged in product, prices, availability, reviews and questions. 1 credit per request. Failed requests are never billed.

Officeworks Sitemap API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/officeworks/sitemap
Auth header
x-api-key
Cost
1 credit / request
Response preview
200 OK
{
    "data": {
        "page": 0,
        "type": "index",
        "count": 5,
        "total": 5,
        "per_page": 200,
        "products": [],
        "sitemaps": [
            {
                "url": "https://www.officeworks.com.au/sitemap-products.xml",
                "name": "sitemap-products"
            }
        ]
...

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.

2 optional filters available.

name string Optional

Sub-sitemap name or index

Example value example
page integer Optional

Zero-based page number

Example value 1

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": {
        "page": 0,
        "type": "index",
        "count": 5,
        "total": 5,
        "per_page": 200,
        "products": [],
        "sitemaps": [
            {
                "url": "https://www.officeworks.com.au/sitemap-products.xml",
                "name": "sitemap-products"
            }
        ]
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "sitemap"
    },
    "success": true
}

Errors

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

422

Validation Error

Use a sub-sitemap name from the index. 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.