---
title: Search
slug: bigboxapi/homedepot-product-data-api/results/search
docTags:
createdAt: 2024-07-22T08:01:06.003Z
---
# Search Results
When making a request with the `type` [parameter](https://docs.trajectdata.com/bigboxapi/homedepot-product-data-api/parameters/search) set to `type=search` BigBox API will return search results from Home Depot.
Search results are retrieved from the [search results page](https://www.homedepot.com/s/lawn+mower) on Home Depot.
An example of the JSON object returned from a Search request is shown below:
```json
{
"request_info": {
"success": true,
"credits_used": 1,
"credits_remaining": 999
},
"request_metadata": {
"created_at": "2020-01-01T00:00:00.000Z",
"processed_at": "2020-01-01T00:00:00.000Z",
"total_time_taken": 2.15,
"homedepot_url": "https://www.homedepot.com/s/lawn+mower?NCNI-5"
},
"request_parameters": {
"type": "search",
"search_term": "lawn mower",
"sort_by": "best_seller"
},
"search_results": [
{
"position": 1,
"product": {
"title": "Honda 21 in. 3-in-1 Variable Speed Gas Walk Behind Self Propelled Lawn Mower with Auto Choke",
"link": "https://www.homedepot.com/p/Honda-21-in-3-in-1-Variable-Speed-Gas-Walk-Behind-Self-Propelled-Lawn-Mower-with-Auto-Choke-HRN216VKA/314013158",
"is_bestseller": true,
"brand": "Honda",
"favorite_count": 1053,
"item_id": "314013158",
"store_sku": "1004556576",
"model_number": "HRN216VKA",
"images": [
"https://images.thdstatic.com/productImages/b805cb94-f0f9-4800-bf93-2070a92a8704/svn/honda-self-propelled-lawn-mowers-hrn216vka-64_1000.jpg",
"https://images.thdstatic.com/productImages/2da3aa20-c521-4191-8855-32c65af1ec4e/svn/honda-self-propelled-lawn-mowers-hrn216vka-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/b805cb94-f0f9-4800-bf93-2070a92a8704/svn/honda-self-propelled-lawn-mowers-hrn216vka-64_1000.jpg",
"rating": 4.5,
"ratings_total": 5192,
"collection": {
"id": "Family-312406020",
"name": "Family-312406020",
"link": "https://www.homedepot.com/collection/Outdoors/Honda-Lawn-Mowers-Collection/Family-312406020?omsid=314013158"
},
"features": [
{
"name": "Power Type",
"value": "Gas"
},
{
"name": "Cutting Width (in.)",
"value": "21 inches"
},
{
"name": "Size of Yard",
"value": "1/4 - 1/2 Acre"
},
{
"name": "Engine Make",
"value": "Honda Engine"
},
{
"name": "Features",
"value": "Mulching Lawn Mower"
}
]
},
"fulfillment": {
"pickup": false,
"ship_to_store": true,
"ship_to_home": true,
"scheduled_delivery": false,
"ship_to_store_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 2427,
"in_stock": true
},
"ship_to_home_info": {
"in_stock": true,
"stock_level": 9999
}
},
"offers": {
"primary": {
"price": 469,
"regular_price": 549,
"symbol": "$",
"currency": "USD"
}
}
},
{
"position": 2,
"product": {
"title": "RYOBI 40V HP Brushless 20 in. Cordless Battery Walk Behind Push Mower with 6.0 Ah Battery and Charger",
"link": "https://www.homedepot.com/p/RYOBI-40V-HP-Brushless-20-in-Cordless-Battery-Walk-Behind-Push-Mower-with-6-0-Ah-Battery-and-Charger-RY401170VNM/317061059",
"is_bestseller": true,
"is_top_rated": true,
"brand": "RYOBI",
"item_id": "317061059",
"store_sku": "1006431841",
"model_number": "RY401170VNM",
"images": [
"https://images.thdstatic.com/productImages/63e8deea-ed6d-442d-8d0c-5a061c301bff/svn/ryobi-push-lawn-mowers-ry401170vnm-64_1000.jpg",
"https://images.thdstatic.com/productImages/06034308-37ee-4a31-bcc2-94862828c43d/svn/ryobi-push-lawn-mowers-ry401170vnm-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/63e8deea-ed6d-442d-8d0c-5a061c301bff/svn/ryobi-push-lawn-mowers-ry401170vnm-64_1000.jpg",
"rating": 4.7,
"ratings_total": 835,
"features": [
{
"name": "Power Type",
"value": "Battery"
},
{
"name": "Cutting Width (in.)",
"value": "20 inches"
},
{
"name": "Voltage (v)",
"value": "40v"
},
{
"name": "Size of Yard",
"value": "1/4 - 1/2 Acre"
},
{
"name": "Battery Run Time (min.)",
"value": "48"
}
]
},
"fulfillment": {
"pickup": true,
"ship_to_store": false,
"ship_to_home": true,
"scheduled_delivery": false,
"pickup_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 9,
"in_stock": true
},
"ship_to_home_info": {
"in_stock": true,
"stock_level": 9999
}
},
"offers": {
"primary": {
"price": 299,
"symbol": "$",
"currency": "USD"
}
}
},
{
"position": 3,
"product": {
"title": "RYOBI 40V HP Brushless 21 in. Cordless Battery Walk Behind Self-Propelled Lawn Mower with (2) 6.0 Ah Batteries and Charger",
"link": "https://www.homedepot.com/p/RYOBI-40V-HP-Brushless-21-in-Cordless-Battery-Walk-Behind-Self-Propelled-Lawn-Mower-with-2-6-0-Ah-Batteries-and-Charger-RY401140US/314600837",
"is_exclusive": true,
"brand": "RYOBI",
"item_id": "314600837",
"store_sku": "1005788802",
"model_number": "RY401140US",
"images": [
"https://images.thdstatic.com/productImages/6edf6453-7ea4-4e52-9478-b4fc3cf850e6/svn/ryobi-self-propelled-lawn-mowers-ry401140us-64_1000.jpg",
"https://images.thdstatic.com/productImages/06034308-37ee-4a31-bcc2-94862828c43d/svn/ryobi-self-propelled-lawn-mowers-ry401140us-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/6edf6453-7ea4-4e52-9478-b4fc3cf850e6/svn/ryobi-self-propelled-lawn-mowers-ry401140us-64_1000.jpg",
"rating": 4.5,
"ratings_total": 1766,
"features": [
{
"name": "Cutting Width (in.)",
"value": "21 inches"
},
{
"name": "Power Type",
"value": "Battery"
},
{
"name": "Size of Yard",
"value": "1/2 - 1 Acre"
},
{
"name": "Features",
"value": "Mulching Lawn Mower"
},
{
"name": "Rear Wheel Height (in.)",
"value": "High Wheel"
}
]
},
"fulfillment": {
"pickup": false,
"ship_to_store": true,
"ship_to_home": true,
"scheduled_delivery": false,
"ship_to_store_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 408,
"in_stock": true
},
"ship_to_home_info": {
"in_stock": true,
"stock_level": 9999
}
},
"offers": {
"primary": {
"price": 499,
"regular_price": 549,
"symbol": "$",
"currency": "USD"
}
}
},
{
"position": 4,
"product": {
"title": "Toro Flex-Force 22 in. 60-Volt Cordless 2-Tool Combo Kit Recycler Mower & 14 in./16 in. String Trimmer - Charger/2 Batteries",
"link": "https://www.homedepot.com/p/Toro-Flex-Force-22-in-60-Volt-Cordless-2-Tool-Combo-Kit-Recycler-Mower-14-in-16-in-String-Trimmer-Charger-2-Batteries-66351/320792383",
"sponsored": true,
"brand": "Toro",
"item_id": "320792383",
"model_number": "66351",
"images": [
"https://images.thdstatic.com/productImages/a3dd1331-9abd-4908-bde8-d24048693089/svn/toro-self-propelled-lawn-mowers-66351-64_1000.jpg",
"https://images.thdstatic.com/productImages/ea72f0b1-c2dd-4595-b90d-a3bc764953e9/svn/toro-self-propelled-lawn-mowers-66351-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/a3dd1331-9abd-4908-bde8-d24048693089/svn/toro-self-propelled-lawn-mowers-66351-64_1000.jpg",
"rating": 0,
"ratings_total": 0,
"features": [
{
"name": "Cutting Width (in.)",
"value": "22 inches"
},
{
"name": "Power Type",
"value": "Battery"
},
{
"name": "Size of Yard",
"value": "1/4 - 1/2 Acre"
},
{
"name": "Rear Wheel Height (in.)",
"value": "High Wheel"
},
{
"name": "Drive Type",
"value": "Rear-wheel Drive"
}
]
},
"fulfillment": {
"pickup": false,
"ship_to_store": true,
"ship_to_home": true,
"scheduled_delivery": false,
"ship_to_store_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 158,
"in_stock": true
},
"ship_to_home_info": {
"in_stock": true,
"stock_level": 9999
}
},
"offers": {
"primary": {
"price": 798.99,
"symbol": "$",
"currency": "USD"
}
}
},
{
"position": 5,
"product": {
"title": "RYOBI 40V HP Brushless 21 in. Cordless Battery Walk Behind Dual-Blade Self-Propelled Mower with (2) 6.0 Ah Batteries & Charger",
"link": "https://www.homedepot.com/p/RYOBI-40V-HP-Brushless-21-in-Cordless-Battery-Walk-Behind-Dual-Blade-Self-Propelled-Mower-with-2-6-0-Ah-Batteries-Charger-RY401150US/314428494",
"is_top_rated": true,
"is_exclusive": true,
"brand": "RYOBI",
"item_id": "314428494",
"store_sku": "1005788757",
"model_number": "RY401150US",
"images": [
"https://images.thdstatic.com/productImages/ede5f12d-4e02-4de1-8719-c77d0b32f0a8/svn/ryobi-self-propelled-lawn-mowers-ry401150us-64_1000.jpg",
"https://images.thdstatic.com/productImages/06034308-37ee-4a31-bcc2-94862828c43d/svn/ryobi-self-propelled-lawn-mowers-ry401150us-e4_1000.jpg"
],
"primary_image": "https://images.thdstatic.com/productImages/ede5f12d-4e02-4de1-8719-c77d0b32f0a8/svn/ryobi-self-propelled-lawn-mowers-ry401150us-64_1000.jpg",
"rating": 4.4,
"ratings_total": 1078,
"features": [
{
"name": "Cutting Width (in.)",
"value": "21 inches"
},
{
"name": "Power Type",
"value": "Battery"
},
{
"name": "Size of Yard",
"value": "1/2 - 1 Acre"
},
{
"name": "Features",
"value": "Mulching Lawn Mower"
},
{
"name": "Rear Wheel Height (in.)",
"value": "High Wheel"
}
]
},
"fulfillment": {
"pickup": true,
"ship_to_store": false,
"ship_to_home": false,
"scheduled_delivery": true,
"pickup_info": {
"store_id": "6242",
"store_state": "Stamford",
"store_name": "CT",
"stock_level": 4,
"in_stock": true
},
"scheduled_delivery_info": {
"in_stock": false,
"stock_level": 11
}
},
"offers": {
"primary": {
"price": 599,
"symbol": "$",
"currency": "USD"
}
}
}
],
"breadcrumbs": [
{
"name": "Outdoors",
"link": "https://www.homedepot.com/b/Outdoors/N-5yc1vZbx82"
},
{
"name": "Outdoor Power Equipment",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment/N-5yc1vZbx5c"
},
{
"name": "Lawn Mowers",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/N-5yc1vZc5ar"
}
],
"related_queries": [
{
"query": "dewalt cordless screwdriver"
},
{
"query": "dewalt screwdriver"
},
{
"query": "cordless screwdriver"
},
{
"query": "milwaukee electric screwdriver"
},
{
"query": "dewalt gyroscopic screwdriver"
},
{
"query": "cordless electric screwdriver"
},
{
"query": "dewalt drill"
},
{
"query": "electric screwdriver"
}
],
"facets": [
{
"name": "Availability",
"display_name": "Availability",
"values": [
{
"display_name": "Show Unavailable Products",
"value": "bwo5s",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Show-Unavailable-Products/N-5yc1vZc5arZbwo5s?NCNI-5",
"count": 0,
"active": false
}
]
},
{
"name": "Category",
"display_name": "Category",
"values": [
{
"display_name": "Lawn Mower Parts",
"value": "2fkp8zm",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Lawn-Mower-Parts/N-5yc1vZ2fkp8zm",
"count": 341,
"active": false
},
{
"display_name": "Self Propelled Lawn Mowers",
"value": "c5ap",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Self-Propelled-Lawn-Mowers/N-5yc1vZc5ap",
"count": 114,
"active": false
},
{
"display_name": "Push Lawn Mowers",
"value": "c5ah",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Push-Lawn-Mowers/N-5yc1vZc5ah",
"count": 72,
"active": false
},
{
"display_name": "Reel Lawn Mowers",
"value": "c5av",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Reel-Lawn-Mowers/N-5yc1vZc5av",
"count": 20,
"active": false
},
{
"display_name": "Field Mowers",
"value": "c5aq",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Field-Mowers/N-5yc1vZc5aq",
"count": 7,
"active": false
},
{
"display_name": "Commercial Lawn Mowers",
"value": "c7gx",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Commercial-Lawn-Mowers/N-5yc1vZc7gx",
"count": 6,
"active": false
},
{
"display_name": "Robotic Lawn Mowers",
"value": "c5at",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers-Robotic-Lawn-Mowers/N-5yc1vZc5at",
"count": 6,
"active": false
}
]
},
{
"name": "Battery Run Time (min.)",
"display_name": "Battery Run Time (min.)",
"values": [
{
"display_name": "60",
"value": "1z183mn",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/60/N-5yc1vZc5arZ1z183mn",
"count": 30,
"active": false
},
{
"display_name": "0",
"value": "1z183nb",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/0/N-5yc1vZc5arZ1z183nb",
"count": 18,
"active": false
},
{
"display_name": "40",
"value": "1z183lz",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/40/N-5yc1vZc5arZ1z183lz",
"count": 14,
"active": false
},
{
"display_name": "70",
"value": "1z183mv",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/70/N-5yc1vZc5arZ1z183mv",
"count": 14,
"active": false
},
{
"display_name": "45",
"value": "1z183m1",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/45/N-5yc1vZc5arZ1z183m1",
"count": 8,
"active": false
},
{
"display_name": "0.0",
"value": "1z1czwc",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/00/N-5yc1vZc5arZ1z1czwc",
"count": 7,
"active": false
},
{
"display_name": "43",
"value": "1z1p8ko",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/43/N-5yc1vZc5arZ1z1p8ko",
"count": 7,
"active": false
},
{
"display_name": "30",
"value": "1z183ln",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/30/N-5yc1vZc5arZ1z183ln",
"count": 6,
"active": false
},
{
"display_name": "50",
"value": "1z183mc",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/50/N-5yc1vZc5arZ1z183mc",
"count": 6,
"active": false
},
{
"display_name": "1",
"value": "1z1rutf",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/1/N-5yc1vZc5arZ1z1rutf",
"count": 3,
"active": false
},
{
"display_name": "240",
"value": "1z183ne",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/240/N-5yc1vZc5arZ1z183ne",
"count": 3,
"active": false
},
{
"display_name": "25",
"value": "1z183lf",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/25/N-5yc1vZc5arZ1z183lf",
"count": 3,
"active": false
},
{
"display_name": "120",
"value": "1z183oy",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/120/N-5yc1vZc5arZ1z183oy",
"count": 2,
"active": false
},
{
"display_name": "20",
"value": "1z183lb",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/20/N-5yc1vZc5arZ1z183lb",
"count": 2,
"active": false
},
{
"display_name": "48",
"value": "1z1b6d4",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/48/N-5yc1vZc5arZ1z1b6d4",
"count": 2,
"active": false
},
{
"display_name": "90",
"value": "1z183nn",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/90/N-5yc1vZc5arZ1z183nn",
"count": 2,
"active": false
},
{
"display_name": "0.00",
"value": "1z1narh",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/000/N-5yc1vZc5arZ1z1narh",
"count": 1,
"active": false
},
{
"display_name": "180",
"value": "1z183kp",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/180/N-5yc1vZc5arZ1z183kp",
"count": 1,
"active": false
},
{
"display_name": "42",
"value": "1z1a9wt",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/42/N-5yc1vZc5arZ1z1a9wt",
"count": 1,
"active": false
},
{
"display_name": "75",
"value": "1z183mw",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/75/N-5yc1vZc5arZ1z183mw",
"count": 1,
"active": false
}
]
},
{
"name": "Voltage (v)",
"display_name": "Voltage (v)",
"values": [
{
"display_name": "18v",
"value": "1z17p5w",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/18v/N-5yc1vZc5arZ1z17p5w",
"count": 39,
"active": false
},
{
"display_name": "40v",
"value": "1z17owe",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/40v/N-5yc1vZc5arZ1z17owe",
"count": 27,
"active": false
},
{
"display_name": "60v",
"value": "1z17ozo",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/60v/N-5yc1vZc5arZ1z17ozo",
"count": 26,
"active": false
},
{
"display_name": "36v",
"value": "1z17p7b",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/36v/N-5yc1vZc5arZ1z17p7b",
"count": 18,
"active": false
},
{
"display_name": "120v",
"value": "1z17owx",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/120v/N-5yc1vZc5arZ1z17owx",
"count": 15,
"active": false
},
{
"display_name": "20v",
"value": "1z17otq",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/20v/N-5yc1vZc5arZ1z17otq",
"count": 14,
"active": false
},
{
"display_name": "28v",
"value": "1z17pk4",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/28v/N-5yc1vZc5arZ1z17pk4",
"count": 2,
"active": false
},
{
"display_name": "56v",
"value": "1z17ovl",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/56v/N-5yc1vZc5arZ1z17ovl",
"count": 2,
"active": false
},
{
"display_name": "62v",
"value": "1z1bur8",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/62v/N-5yc1vZc5arZ1z1bur8",
"count": 2,
"active": false
},
{
"display_name": "12v",
"value": "1z17p15",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/12v/N-5yc1vZc5arZ1z17p15",
"count": 1,
"active": false
},
{
"display_name": "80v",
"value": "1z1c2pv",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/80v/N-5yc1vZc5arZ1z1c2pv",
"count": 1,
"active": false
}
]
},
{
"name": "Engine Make",
"display_name": "Engine Make",
"values": [
{
"display_name": "OEM Branded Engine",
"value": "1z1s3yy",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/OEM-Branded-Engine/N-5yc1vZc5arZ1z1s3yy",
"count": 63,
"active": false
},
{
"display_name": "Briggs and Stratton Engine",
"value": "1z1s3vq",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Briggs-and-Stratton-Engine/N-5yc1vZc5arZ1z1s3vq",
"count": 35,
"active": false
},
{
"display_name": "Ryobi Engine",
"value": "1z1s477",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Ryobi-Engine/N-5yc1vZc5arZ1z1s477",
"count": 7,
"active": false
},
{
"display_name": "Honda Engine",
"value": "1z1s3xx",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Honda-Engine/N-5yc1vZc5arZ1z1s3xx",
"count": 5,
"active": false
},
{
"display_name": "Troy-Bilt Engine",
"value": "1z1s4cc",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Troy-Bilt-Engine/N-5yc1vZc5arZ1z1s4cc",
"count": 2,
"active": false
},
{
"display_name": "Kawasaki Engine",
"value": "1z1s49r",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Kawasaki-Engine/N-5yc1vZc5arZ1z1s49r",
"count": 1,
"active": false
},
{
"display_name": "Stanley Engine",
"value": "1z1t3pz",
"link": "https://www.homedepot.com/b/Outdoors-Outdoor-Power-Equipment-Lawn-Mowers/Stanley-Engine/N-5yc1vZc5arZ1z1t3pz",
"count": 1,
"active": false
}
]
}
],
"pagination": {
"total_results": 562,
"total_pages": 24,
"current": {
"page": 1,
"link": "https://www.homedepot.com/s/lawn%20mower?NCNI-5"
},
"next": {
"page": 2,
"link": "https://www.homedepot.com/s/lawn%20mower?NCNI-5=&Nao=24"
}
},
"location_info": {
"store_id": "6242",
"store_name": "Stamford",
"zipcode": "06902"
}
}
```
BigBox API returns the following properties for Search requests:
| *`Property`* | *`Type`* | *`Description`* |
| ------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *`search_results`*
| *`array`*
| An array of Search Result objects, containing each of the product results shown on the Search Results page. The Search Result object has the following properties:
- `position`
- `number`
- The position of the result on the search results page.
- `redirected_product_page`
- `boolean`
- Set to `true` when the `search_term` used in the search request causes Home Depot to redirect to an individual product landing page. Typically this is the case when searching for a term that only yields one result.
**Product Object**
The product object contains details about the product within the search result. The `product` object has the following properties:
- `title`
- `string`
- The product title.
- `link`
- `string`
- The URL to the product page.
- `brand`
- `string`
- The brand name of the product, if shown.
- `item_id`
- `string`
- The product item id. Pass the `item_id` into a `type=product` request to get product-level data about the product.
- `store_sku`
- `string`
- The product store SKU ID.
- `model_number`
- `string`
- The model number of the product, if shown.
- `is_bestseller`
- `boolean`
- Set to `true` if the product is flagged as a Bestseller.
- `is_top_rated`
- `boolean`
- Set to `true` if the product is flagged as a Top Rated product.
- `is_exclusive`
- `boolean`
- Set to `true` if the product is flagged as an Exclusive product.
- `primary_image`
- `string`
- The primary image URL associated with the product.
- `images`
- `array`
- An array of image URLs for the product.
- `sponsored`
- `boolean`
- Set to true when the search result is sponsored.
- `rating`
- `number`
- The customer rating of this product, out of 5.
- `ratings_total`
- `number`
- The total number of customer ratings this product has received.
- `favorite_count`
- `number`
- The number of favorite ratings this product has received.
- `features`
- `array`
- An array of objects contain objects with a `name` `value` pairs representing the product features.
- `collection`
- `object`
- Present if the product is part of a collection. Contains `id` , `name` and `link` properties.
**Offers Object**
The offers object contains details about the product offers. The `offers` object has the following properties:
- `primary`
- `object`
- **Primary Offer Object
**
The primary offer object contains details about the primary offer for the product and has the following properties:
-
1. `price`
2. `number`
3. The price of the primary offer.
-
1. `regular_price`
2. `number`
3. The regular, non-discounted, price of the primary offer.
-
1. `currency`
2. `string`
3. The currency of the primary offer, i.e. `USD` .
-
1. `symbol`
2. `string`
3. The currency synbol of the primary offer.
**Fulfillment Object**
The fulfillment object contains details about the product delivery and pickup options. The `fulfillment` object has the following properties:
- `pickup`
- `boolean`
- Set to `true` if the pickup-from-store fulfillment channel is available ( `pickup_info` will be present with further details), `false` otherwise.
- `pickup_info`
- `object`
- Populated when `pickup=true` . Contains a `in_stock` boolean set to true when the product is in stock in store for pickup, `stock_level` indicating the quantity available for pickup and further properties detailing the store address.
- `ship_to_home`
- `boolean`
- Set to `true` if the ship-to-home fulfillment channel is available ( `ship_to_home_info` will be present with further details), `false` otherwise.
- `ship_to_home_info`
- `object`
- Populated when `ship_to_home=true` . Contains a `in_stock` boolean set to true when the product is available for ship to home and `stock_level` indicating the quantity available for ship to home.
- `scheduled_delivery`
- `boolean`
- Set to `true` if the scheduled-delivery fulfillment channel is available ( `scheduled_delivery_info` will be present with further details), `false` otherwise.
- `scheduled_delivery_info`
- `object`
- Populated when `scheduled_delivery=true` . Contains a `in_stock` boolean set to true when the product is available for scheduled delivery and `stock_level` indicating the quantity available for schedule delivery.
- `ship_to_store`
- `boolean`
- Set to `true` if the ship-to-store fulfillment channel is available ( `ship_to_store_info` will be present with further details), `false` otherwise.
- `ship_to_store_info`
- `object`
- Populated when `ship_to_store=true` . Contains a `in_stock` boolean set to true when the product is available for ship-to-store and `stock_level` indicating the quantity available for ship-to-store and further properties detailing the store address. |
| *`related_queries`*
| *`array`*
| **Related Queries Object**
An array containing details of any related queries shown on the search result page. Each object in the `related_queries` array contains the following properties:
- `query`
- `string`
- The related query search term text. |
| *`facets`*
| *`array`*
| **Facet Object**
An array containing details of any available search facets (refinements) shown on the search result page. You can use the facets returned here to refine your query by supplying `link` from a given facet value to the `url` [request parameter](https://docs.trajectdata.com/bigboxapi/homedepot-product-data-api/parameters/search) (remember to URL-encode the `link` before passing it to the `url` request parameter). Each object in the `facets` array contains the following properties:
- `name`
- `string`
- The name of the facet (can be used in the `facets` request parameter).
- `display_name`
- `string`
- The display name of the facet (i.e. the user-facing name).
- `values`
- `array`
- **Facet Values Array
**
The facet values array shows the values of the given facet, along with the number of products matching that facet value.
-
1. `value`
2. `string`
3. The value of the facet (can be used in the `facets` request parameter).
-
1. `display_name`
2. `string`
3. The display name of the facet value (i.e. the user-facing name of the facet value).
-
1. `count`
2. `number`
3. The count of the number of products that match this facet value in the current search results.
-
1. `active`
2. `boolean`
3. Set to `true` when this facet value is currently active in the current set of results.
-
1. `link`
2. `string`
3. The URL to use to request results filtered to this facet. **Note** You can use the `link` to the `url` [request parameter](https://docs.trajectdata.com/bigboxapi/homedepot-product-data-api/parameters/search) (remember to URL-encode the `link` before passing it to the `url` request parameter). |
| *`pagination`*
| *`object`*
| **Pagination Object**
An object containing details of the current results page and the total number of pages that are available. To paginate you should specify the page number in your request's `page` [parameter](https://www.bigboxapi.com/docs/homedepot-product-data-api/parameters/search).
- `current`
- `object`
- **Current Page Object
**
Contains details of the current page
-
1. `page`
2. `number`
3. The current page number.
-
1. `link`
2. `string`
3. The current page URL.
- `next`
- `object`
- **Next Page Object
**
Contains details of the next page
-
1. `page`
2. `number`
3. The next page number.
-
1. `link`
2. `string`
3. The next page URL.
- `total_pages`
- `number`
- The total number of pages shown as being available.
- `total_results`
- `number`
- The total number of search results shown as being available.
|
| *`location_info`*
| *`object`*
| **Location Info Object**
An object containing details of the location in which the request was run. You can control the store used using the `customer_zipcode` request parameter.
- `store_id`
- `string`
- The ID of the store the request was run.
- `store_name`
- `string`
- The name of the store the request was run.
- `zipcode`
- `string`
- The zipcode of the store the request was run. |
***
**Next Steps**
[Search Parameters](https://docs.trajectdata.com/bigboxapi/homedepot-product-data-api/parameters/search)