Core APIs
...
Product API
Results

Product

2min

Product Results

When making a request with the type parameter 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 for a single product on Home Depot.

Home Improvement Product Page
Home Improvement Product Page


An example of the JSON object returned from an Product request is shown below:

JSON


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.
    • 
      1. link
      2. string
      3. 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:
    • 
      1. link
      2. string
      3. A link to the image.
    • 
      1. id
      2. string
      3. 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:
    • 
      1. link
      2. string
      3. A link to the video.
    • 
      1. id
      2. string
      3. A ID to the video.
    • 
      1. title
      2. string
      3. The title of the video.
    • 
      1. thumbnail
      2. string
      3. A URL to a still thumbnail image from the video.
    • 
      1. description
      2. string
      3. 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.
    • 
      1. name
      2. string
      3. The name of the specification i.e. "Batteries".
    • 
      1. value
      2. string
      3. The value of the specification i.e. "2 AA Batteries".
    • 
      1. group_name
      2. string
      3. 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.
    • 
      1. item_id
      2. string
      3. 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.
    • 
      1. link
      2. string
      3. 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.
    • 
      1. title
      2. string
      3. 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:
    • 
      1. name
      2. string
      3. The name of the category.
    • 
      1. link
      2. string
      3. 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:
    • 
      1. price
      2. number
      3. The price of the buybox winning offer.
    • 
      1. was_price
      2. number
      3. The was/strikethrough price of the buybox winning offer.
    • 
      1. unit
      2. string
      3. The unit of measure of the buybox winning offer (i.e. "each").
    • 
      1. currency
      2. string
      3. The currency of the buybox winning offer, i.e. USD .
    • 
      1. currency_symbol
      2. string
      3. 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:
    • 
      1. pickup
      2. boolean
      3. Set to true if the pickup-from-store fulfillment channel is available ( pickup_info will be present with further details), false otherwise.
    • 
      1. pickup_info
      2. object
      3. 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.
    • 
      1. ship_to_home
      2. boolean
      3. Set to true if the ship-to-home fulfillment channel is available ( ship_to_home_info will be present with further details), false otherwise.
    • 
      1. ship_to_home_info
      2. object
      3. 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.
    • 
      1. scheduled_delivery
      2. boolean
      3. Set to true if the scheduled-delivery fulfillment channel is available ( scheduled_delivery_info will be present with further details), false otherwise.
    • 
      1. scheduled_delivery_info
      2. object
      3. 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.
    • 
      1. ship_to_store
      2. boolean
      3. Set to true if the ship-to-store fulfillment channel is available ( ship_to_store_info will be present with further details), false otherwise.
    • 
      1. ship_to_store_info
      2. object
      3. 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

Updated 06 Aug 2024
Did this page help you?