Officeworks Categories API Documentation Get the public Officeworks category tree with facets and breadcrumbs, optionally scoped to a category path from a search hit. 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.
1 optional filter available.
string
Optional
Optional category path from a search hit
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"count": 0,
"categories": []
},
"meta": {
"credits": 1,
"billable": true,
"endpoint_family": "catalogue_categories"
},
"success": true
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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.