List and Search

list and search categories get get /categories the categories api exposes just one endpoint /categories categories are expressed in a hierarchical structure, each category may have one or more child categories as determined by the has children property you can retrieve the child categories of a given category by passing the parent category id in the parent id parameter to retrieve the top level categories make a request without any parent id top level categories have their is root=true property set to true parameters the following querystring (http get) parameters allow you to refine the results returned by the categories api parameter required description api key required the api key for your account id optional single id of the category to retrieve note that id cannot be used when parent id or search term are used parent id optional the id of the parent category to retrieve child categories for note that parent id cannot be used when id or search term are used search term optional searches the entire category hierarchy for categories containing the search term i e search term=appliances (to return only categories containing the string appliances ) note that search term cannot be used when id or parent id are used results the categories api returns the following properties property type description categories array an array of category objects containing details of a given category the categories array is present when either the parent id or search term request parameters are used id string the id of the category can be passed into the category id parameter of a subsequent category https //docs trajectdata com/bigboxapi/product data api/parameters/category api request name string the name of the category has children boolean true/false as to whether this category has child categories is root boolean true/false as to whether this category is a top level (root) category path string the fully qualified path to the category in the category hierarchy, delimited by ">" characters for example category 1 > category 2 > category 3 current category object an object with the same properties as the category objects in the categories array showing details of the current category note that current category is only present when a request is made using the parent id request parameter (i e when retrieving child categories for a given parent id ) parent category object an object with the same properties as the category objects in the categories array showing details of the parent category note that parent category is only present when a request is made using the parent id request parameter (i e when retrieving child categories for a given parent id ) parent category shows details of the category that is the parent of the category specified in parent id note parent category is not returned if the category specified in the parent id request parameter is is root=true category object an object with the same properties as the category objects in the categories array showing details of the single category requested by the id parameter note that category is only present when a request is made using the id request parameter (i e when retrieving details of a single category) example listing root categories in the example below we retrieve all top level (root) categories $ curl "https //api bigboxapi com/categories?api key=demo"const axios = require('axios'); axios get('https //api bigboxapi com/categories?api key=demo') then(response => { const apiresponse = response data; console log("categories ", json stringify(apiresponse, 0, 2); }) catch(error => { console error(error); });import requests import json params = { 'api key' 'demo' } api result = requests get('https //api bigboxapi com/categories', { params }) api response = api result json() print "categories ", json dumps(api response)\<?php $querystring = http build query(\[ 'api key' => 'demo' ]); $ch = curl init('https //api bigboxapi com/categories', $querystring); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $json = curl exec($ch); curl close($ch); $api result = json decode($json, true); print r($api result); ?> the categories api responds with the top level (root) categories in the categories property { "request info" { "success" true }, "categories" \[ { "id" "n 5yc1vzbv1w", "name" "appliances", "has children" true, "is root" true, "path" "appliances", "link" "https //www homedepot com/b/appliances/n 5yc1vzbv1w", "type" "standard", "domain" "homedepot com" }, { "id" "n 5yc1vzbqsi", "name" "cleaning", "has children" true, "is root" true, "path" "cleaning", "link" "https //www homedepot com/b/cleaning/n 5yc1vzbqsi", "type" "standard", "domain" "homedepot com" }, { "id" "n 5yc1vzc1jw", "name" "smart home", "has children" true, "is root" true, "path" "smart home", "link" "https //www homedepot com/b/smart home/n 5yc1vzc1jw", "type" "standard", "domain" "homedepot com" } ] } example listing child categories in the example below we retrieve child categories for a parent category with id n 5yc1vzbv1w $ curl "https //api bigboxapi com/categories?api key=demo\&parent id=n 5yc1vzbv1w"const axios = require('axios'); axios get('https //api bigboxapi com/categories?api key=demo\&parent id=n 5yc1vzbv1w') then(response => { const apiresponse = response data; console log("categories ", json stringify(apiresponse, 0, 2); }) catch(error => { console error(error); });import requests import json params = { 'api key' 'demo', 'parent id' 'n 5yc1vzbv1w' } api result = requests get('https //api bigboxapi com/categories', { params }) api response = api result json() print "categories ", json dumps(api response)\<?php $querystring = http build query(\[ 'api key' => 'demo', 'parent id' => 'n 5yc1vzbv1w' ]); $ch = curl init('https //api bigboxapi com/categories', $querystring); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $json = curl exec($ch); curl close($ch); $api result = json decode($json, true); print r($api result); ?> the categories api responds with the child categories for parent category with id n 5yc1vzbv1w in the categories property { "request info" { "success" true }, "current category" { "id" "n 5yc1vzbv1w", "name" "appliances", "has children" true, "is root" true, "path" "appliances", "link" "https //www homedepot com/b/appliances/n 5yc1vzbv1w", "type" "standard", "domain" "homedepot com" }, "categories" \[ { "id" "n 5yc1vzc3pi", "name" "refrigerators", "has children" false, "is root" false, "path" "appliances > refrigerators", "link" "https //www homedepot com/b/appliances refrigerators/n 5yc1vzc3pi", "parent id" "n 5yc1vzbv1w", "parent name" "appliances", "type" "standard", "domain" "homedepot com" }, { "id" "n 5yc1vzc3po", "name" "dishwashers", "has children" false, "is root" false, "path" "appliances > dishwashers", "link" "https //www homedepot com/b/appliances dishwashers/n 5yc1vzc3po", "parent id" "n 5yc1vzbv1w", "parent name" "appliances", "type" "standard", "domain" "homedepot com" }, { "id" "n 5yc1vzc3no", "name" "garbage disposals", "has children" false, "is root" false, "path" "appliances > garbage disposals", "link" "https //www homedepot com/b/appliances garbage disposals/n 5yc1vzc3no", "parent id" "n 5yc1vzbv1w", "parent name" "appliances", "type" "standard", "domain" "homedepot com" } ] } next steps categories api overview https //docs trajectdata com/bigboxapi/categories api/overview