Core APIs
Categories API

Overview

2min

Categories API Overview

Home Depot have a large product hierachy and to make navigating this easier BigBox API provides the Categories API to allow you to retrieve category_id values for different levels of the Home Depot hierarchy.

category_id values returned by the Categories API can be used in subsequent category API requests to show category listings from the given category.

This is useful for use-cases such as "iterating all of the products in a category".

Whilst most of the time the category_id 's returned by the Categories API are "static", it's expected that Home Depot's category hierarchy will change over time. BigBox API continuously updates the Categories API dataset to capture these changes. It's advised that, if your code relies on showing the category hierarchy to users, you periodically refresh your cached hierarchy from the Categories API.

Categories API Cost & Rate Limits Each request to the Categories API counts against your monthly request quota so it's recommended that you cache the Categories API response locally and use your local copy for lookups within your app.

The Categories API has a rate limit of 2000 requests per minute.

As well as interacting with the Categories API programmatically BigBox API provides a visual categories browser on the Dashboard, as shown below. You can use this to visually explore the Home Depot hierarchy and generate sample category API requests.

Categories Browser
Categories Browser


You can browse the category hierarchy visually using the categories browser.



Next Steps      Listing & Searching Categories

Updated 05 Aug 2024
Did this page help you?