Core APIs
...
Product API
Results
Product
2min
product results when making a request with the type parameter https //docs trajectdata com/backyardapi/home improvement product data api/parameters/product set to type=product backyard api will return product details for the product specified in either the item id or the url parameter product details are retrieved from the product page https //www homedepot com/p/317061059 for a single product on home depot an example of the json object returned from an product request is shown below { "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 001z", "total time taken" 0 1, "homedepot url" "https //www homedepot com/p/317061059" }, "request parameters" { "engine" "homedepot", "type" "product", "item id" "317061059" }, "product" { "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", "brand" "ryobi", "brand link" "https //www homedepot com/b/outdoors outdoor power equipment lawn mowers push lawn mowers/ryobi/n 5yc1vzm5dzc5ah", "title" "ryobi 40v hp brushless 20 in cordless battery walk behind push mower with 6 0 ah battery and charger", "upc" "046396037169", "item id" "317061059", "parent id" "882655384", "store sku" "1006431841", "model number" "ry401170vnm", "description" "ryobi continues to lead the industry in cordless mower innovation with their 40v hp 20 in brushless push mower combining 40v lithium ion battery power with brushless technology this mower delivers gas like power, without the hassle of gas, oil, or maintenance the high capacity 6 0 ah battery provides extended run time and instant power at the push of a button with the 3 in 1 mowing functions you can choose between bagging, mulching, or side discharge functions right out of the box select your ideal grass height with the 7 position single point height adjustment the easy lift bag removal allows you to quickly and easily empty the grass catcher bag and get back to work with folding handles, this mower easily folds down when the job is done and can be stored vertically making it ideal for compact spaces ", "is bestseller" true, "is top rated" true, "aisle" "52", "bay" "011", "collection" { "id" "family 308879048", "name" "family 308879048", "link" "https //www homedepot com/collection/outdoors/ryobi 40 volt collection/family 308879048?omsid=317061059" }, "feature bullets" \[ "includes 40v 6 0 ah battery and a quick charger", "3 in 1 capable right out of the box", "works with all ryobi 40v batteries" ], "feature bullets count" 3, "descriptive attributes" \[ "high performance brushless motor delivers maximum performance for gas like power", "push button for hassle free starting", "up to 48 minutes of runtime, ideal for 1/2 acre or less", "7 position, single point height adjustment from 1 5 in to 4 in ", "3 in 1 mulching, bagging and side discharge capable right out of the box", "easy lift bag removal", "folding handles for compact vertical storage", "on board battery storage compartment for easy battery exchange", "6 0 ah high capacity battery for extended run time", "includes quick charger for 2x faster charging", "5 year tool warranty, 3 year battery warranty" ], "variants" \[ { "title" "white 38 in 64 in", "link" "https //www homedepot com/p/home decorators collection white cordless room darkening 2 5 in premium faux wood blind for window 38 in w x 64 in l 10793478378586/301406711", "item id" "301406711" }, { "title" "gray 29 5 in 64 in", "link" "https //www homedepot com/p/home decorators collection driftwood gray cordless room darkening 2 5 in premium faux wood blind for window 29 5 in w x 64 in l 10793478381326/301406710", "item id" "301406710" } ], "descriptive attributes count" 14, "images" \[ { "link" "https //images thdstatic com/productimages/63e8deea ed6d 442d 8d0c 5a061c301bff/svn/ryobi push lawn mowers ry401170vnm 64 1000 jpg", "type" "primary" }, { "link" "https //images thdstatic com/productimages/06034308 37ee 4a31 bcc2 94862828c43d/svn/ryobi push lawn mowers ry401170vnm e1 1000 jpg", "type" "image left view" }, { "link" "https //images thdstatic com/productimages/f7b5f873 f7ca 400a b5df d7f338743245/svn/ryobi push lawn mowers ry401170vnm 40 1000 jpg", "type" "image right view" }, { "link" "https //images thdstatic com/productimages/3da668c3 3d5b 4508 87f6 700c6e6681f3/svn/ryobi push lawn mowers ry401170vnm a0 1000 jpg", "type" "image top view" }, { "link" "https //images thdstatic com/productimages/5317a55a d3e2 4ff4 a668 d6f45e76752e/svn/ryobi push lawn mowers ry401170vnm 1d 1000 jpg", "type" "image bottom view" }, { "link" "https //images thdstatic com/productimages/b7c36076 3358 46fc 9d1e e51e8c3bd0ac/svn/ryobi push lawn mowers ry401170vnm 66 1000 jpg", "type" "image back view" }, { "link" "https //images thdstatic com/productimages/0d2651b9 f713 42d6 a5d5 4503832b7b6a/svn/ryobi push lawn mowers ry401170vnm 77 1000 jpg", "type" "image open view" }, { "link" "https //images thdstatic com/productimages/7dfaf8a4 2818 449f ba88 f0b777999a4b/svn/ryobi push lawn mowers ry401170vnm c3 1000 jpg", "type" "image alternate view" }, { "link" "https //images thdstatic com/productimages/f896c50e f29d 46be af2a 9562e3a1722a/svn/ryobi push lawn mowers ry401170vnm 4f 1000 jpg", "type" "image alternate view 2" }, { "link" "https //images thdstatic com/productimages/2dad2206 d356 4fb2 8c37 33282dd81476/svn/ryobi push lawn mowers ry401170vnm 1f 1000 jpg", "type" "image alternate view 3" }, { "link" "https //images thdstatic com/productimages/cd083757 5d0b 4f8a 8ab6 013c316d3f39/svn/ryobi push lawn mowers ry401170vnm 44 1000 jpg", "type" "image alternate view 4" }, { "link" "https //images thdstatic com/productimages/857c441a b78e 4c61 a8c8 74137f447e83/svn/ryobi push lawn mowers ry401170vnm fa 1000 jpg", "type" "image alternate view 5" }, { "link" "https //images thdstatic com/productimages/ddfed769 c6ad 4eb9 a964 6c78ae69bd50/svn/ryobi push lawn mowers ry401170vnm 76 1000 jpg", "type" "image alternate view 6" }, { "link" "https //images thdstatic com/productimages/258875ba e76c 4c60 9504 3e2450d705bf/svn/ryobi push lawn mowers ry401170vnm d4 1000 jpg", "type" "image catalog view" }, { "link" "https //images thdstatic com/productimages/34320099 ed94 499d a848 b763fe8caf5c/svn/ryobi push lawn mowers ry401170vnm 31 1000 jpg", "type" "image life style" } ], "main image" { "link" "https //images thdstatic com/productimages/63e8deea ed6d 442d 8d0c 5a061c301bff/svn/ryobi push lawn mowers ry401170vnm 64 1000 jpg", "type" "primary" }, "has 360 view" true, "videos" \[ { "link" "https //bcbolt446c5271 a akamaihd net/media/v1/pmp4/static/clear/1834613806001/41577581 4f64 4b32 82eb 94de94d26349/e6a1964d 1cd5 49ee 9b8c 31b9658a46cf/main mp4?akamai token=exp=1656322192 acl=/media/v1/pmp4/static/clear/1834613806001/41577581 4f64 4b32 82eb 94de94d26349/e6a1964d 1cd5 49ee 9b8c 31b9658a46cf/main mp4 hmac=339338f3db96885f2bb7aaf0f19d0487f3d5db08c0ceb3cfa77a7c13fa9b731e\&pubid=66036796001", "title" "push mower demo", "id" "6299398228001", "thumbnail" "https //cf images us east 1 prod boltdns net/v1/jit/1834613806001/41577581 4f64 4b32 82eb 94de94d26349/main/160x90/15s829ms/match/image jpg?pubid=66036796001", "description" "showing the benefits of ry401170vnm through usage" }, { "link" "https //bcbolt446c5271 a akamaihd net/media/v1/pmp4/static/clear/1834613806001/c48104aa 2dc0 477c 936d f329e813bc7d/dd87d2ae 0ce2 478b 825e bc389fe21bd2/main mp4?akamai token=exp=1656316754 acl=/media/v1/pmp4/static/clear/1834613806001/c48104aa 2dc0 477c 936d f329e813bc7d/dd87d2ae 0ce2 478b 825e bc389fe21bd2/main mp4 hmac=6d2d846664d850dd04f932273820c63c19a38f8ffa1684147329357c676fc70b\&pubid=66036796001", "title" "how to ry401170 ry401180", "id" "6302878467001", "thumbnail" "https //cf images us east 1 prod boltdns net/v1/jit/1834613806001/c48104aa 2dc0 477c 936d f329e813bc7d/main/160x90/1m25s56ms/match/image jpg?pubid=66036796001", "description" "how to video for 20 in mowers" } ], "ratings total" 103, "rating" 4 5, "specifications" \[ { "group name" "details", "name" "amperage (amps)", "value" "0" }, { "group name" "details", "name" "assembly required", "value" "no" }, { "group name" "details", "name" "battery amp hours", "value" "6 ah" }, { "group name" "details", "name" "battery run time (min )", "value" "48" }, { "group name" "details", "name" "battery type", "value" "lithium ion" }, { "group name" "details", "name" "battery/charger", "value" "(1) 6 ah battery & charger included" }, { "group name" "details", "name" "ca (carb) compliant", "value" "not carb compliant" }, { "group name" "details", "name" "charge time (hours)", "value" "1 5" }, { "group name" "details", "name" "charger included", "value" "charger included" }, { "group name" "details", "name" "cutting height options", "value" "7 position" }, { "group name" "details", "name" "cutting options", "value" "bag,mulch,side discharge" }, { "group name" "details", "name" "deck material", "value" "polymer composite" }, { "group name" "details", "name" "deck type", "value" "fabricated" }, { "group name" "details", "name" "engine make", "value" "oem branded engine" }, { "group name" "details", "name" "engine torque (ft lb )", "value" "0" }, { "group name" "details", "name" "features", "value" "adjustable cutting height,adjustable handlebar,bagger,brushless motor,collapsible,foldable handle,mulching lawn mower,no oil change required,residential,single lever height adjustment,tool free adjustments" }, { "group name" "details", "name" "included", "value" "bagger,battery(s),charger,wheels" }, { "group name" "details", "name" "lawn mower type", "value" "push mower" }, { "group name" "details", "name" "maximum cutting height (in )", "value" "4" }, { "group name" "details", "name" "minimum cutting height (in )", "value" "1 5" }, { "group name" "details", "name" "mower size type", "value" "standard" }, { "group name" "details", "name" "number of batteries required", "value" "1" }, { "group name" "details", "name" "number of blades", "value" "1" }, { "group name" "details", "name" "number of handlebar positions", "value" "2" }, { "group name" "details", "name" "number of total batteries included", "value" "1" }, { "group name" "details", "name" "power type", "value" "battery" }, { "group name" "details", "name" "product weight (lb )", "value" "43 lb" }, { "group name" "details", "name" "recommended terrain", "value" "flat,sloped" }, { "group name" "details", "name" "refurbished", "value" "no" }, { "group name" "details", "name" "returnable", "value" "90 day" }, { "group name" "details", "name" "size of yard", "value" "1/4 1/2 acre" }, { "group name" "details", "name" "start type", "value" "push button start" }, { "group name" "details", "name" "tools included", "value" "battery,charger" }, { "group name" "details", "name" "voltage (v)", "value" "40v" }, { "group name" "details", "name" "walk behind mower type", "value" "manual push" }, { "group name" "warranty / certifications", "name" "certifications and listings", "value" "ul certified" }, { "group name" "warranty / certifications", "name" "manufacturer warranty", "value" "5 year limited tool warranty, 3 year limited battery warranty" }, { "group name" "dimensions", "name" "assembled depth (in )", "value" "62 5 in" }, { "group name" "dimensions", "name" "assembled height (in )", "value" "39 in" }, { "group name" "dimensions", "name" "assembled width (in )", "value" "21 5 in" }, { "group name" "dimensions", "name" "blade length (in )", "value" "20" }, { "group name" "dimensions", "name" "cutting width (in )", "value" "20 inches" }, { "group name" "dimensions", "name" "front wheel size (in )", "value" "8" }, { "group name" "dimensions", "name" "mower deck width (in )", "value" "20" }, { "group name" "dimensions", "name" "rear wheel height (in )", "value" "high wheel" }, { "group name" "dimensions", "name" "rear wheel size (in )", "value" "10" } ], "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" }, { "name" "push lawn mowers", "link" "https //www homedepot com/b/outdoors outdoor power equipment lawn mowers push lawn mowers/n 5yc1vzc5ah" } ], "buybox winner" { "price" 299, "currency symbol" "$", "currency" "usd", "unit" "each", "fulfillment" { "pickup" true, "ship to store" false, "ship to home" true, "scheduled delivery" true, "pickup info" { "store id" "0121", "store state" "cumberland", "store name" "ga", "in stock" false, "stock level" 0 }, "scheduled delivery info" { "in stock" true, "stock level" 1, "price" 35, "start date" "2022 05 31", "end date" "2022 05 31", "delivery date name" "tomorrow" }, "ship to home info" { "store id" "8119", "store name" "ga", "in stock" true, "stock level" 1539, "price" 0, "start date" "2022 06 02", "end date" "2022 06 02", "delivery date name" "later" } } } } } backyard api returns the following properties for product requests property type description product object an object containing details of the primary product shown on the product page title string the product name item id string the home improvement item id for the product parent id string the home improvement parent id for the product store sku string the product store sku id model number string the model number of the product, if shown upc string the upc of the product, if shown aisle string the in store aisle, if this product is an in store product you can control the store chosen using the customer zipcode request parameter bay string the in store bay, if this product is an in store product you can control the store chosen using the customer zipcode request parameter link string the product page link main image object main image object the main image object contains primary image shown when the product page was loaded link string a link to the main image images array images array the images property contains an array of image objects containing the product images the image object has the following properties link string a link to the image id string a id to the image videos array videos array the videos property contains an array of video objects containing the product videos, if shown the video object has the following properties link string a link to the video id string a id to the video title string the title of the video thumbnail string a url to a still thumbnail image from the video description string a description of the video has 360 view boolean set to true when a 360 degree view is available for the product specifications array specifications array the specifications array contains details of the product specifications as shown in the specifications tables name string the name of the specification i e "batteries" value string the value of the specification i e "2 aa batteries" group name string the group name of the specification 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 description string the full text description of the product feature bullets array an array of strings containing the feature bulletpoints shown on the top right of the product page feature bullets count number the length of the feature bullets array descriptive attributes array an array of strings containing the descriptive attributes of the product descriptive attributes count number the length of the descriptive attributes array rating number the overall rating of the product, out of 5 ratings total number the total number of customer ratings the product has received favorite count number the number of favorite ratings this product has received collection object present if the product is part of a collection contains id , name and link properties brand string the product brand name (if available) brand link string a link to the product's brand landing page (if available) variants array variants array the variants array contains details of variants of the current product as shown on the product page item id string the item id of the variant product can be passed in to a subsequent type=product request in the item id parameter to retrieve product details of the variant link string the url to the product page of the variant product can be passed in to a subsequent type=product request in the url parameter in url encoded form to retrieve product details of the variant title string the variant title breadcrumbs array breadcrumbs array an array containing details of the category breadcrumbs in the title section the page (if shown) each object in the breadcrumbs array contains the following properties name string the name of the category link string a link to the category buybox winner object buybox winner object the "buybox" describes the winning offer for the product the buybox winner object contains details of the winning offer and has the following properties price number the price of the buybox winning offer was price number the was/strikethrough price of the buybox winning offer unit string the unit of measure of the buybox winning offer (i e "each") currency string the currency of the buybox winning offer, i e usd currency symbol string the currency symbol of the buybox winning offer fulfillment object the fulfillment object contains details the buybox winning product offer fulfillment method it 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 next steps product parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/product