Core APIs
...
Results
Customer Feedback

Questions

2min

Questions Results

When making a request with the type parameter set to type=questions BigBox API will return all Customer Questions for the product specified in the item_id or url parameter.

Questions are retrieved from the customer questions page for a single product on Home Depot.

Customer Questions Page
Customer Questions Page


An example of the JSON object returned from a Questions request is shown below:

JSON


BigBox API returns the following properties for Questions requests:

Property

Type

Description

questions

array

An array of Review objects, containing each of the Customer Questions shown on the Customer Questions page. The Review object has the following properties:

  • id
  • string
  • The unique, Home Depot-assigned, ID of the customer question. This can be used by your app to flag whether you have previously processed this question on a prior request.



  • title
  • string
  • The question body text.



  • date
  • string
  • The date of the review.



  • total_answers
  • number
  • The total number of answers this question has received.



  • images
  • array
  • An array of image objects containing the questioner-supplied images accompanying the question. Each item in the array contains an id and link property.



  • profile
  • object
  • Questioner Profile Object The profile object contains details about the author of the question.
    • 
      1. author_name
      2. string
      3. The username of the author of the review.



  • answers
  • array
  • Answers Object The answers array contains details about the answers to the question.
    • 
      1. id
      2. string
      3. The ID of the answer.
    • 
      1. answer
      2. string
      3. The body text of the answer.
    • 
      1. images
      2. array
      3. An array of image objects containing the any images accompanying the answer. Each item in the array contains an id and link property.



  • is_featured
  • boolean
  • Set to true when this is a featured answer.



  • is_brand_answer
  • boolean
  • Set to true when this is a brand answer.



  • date
  • string
  • The date the answer was submitted.



  • positive_feedback
  • number
  • The number of positive feedback reports this answer has received.



  • profile
  • object
  • An object containing details of the user profile that provided the answer. Contains author_name and author_id string properties.

pagination

object

Pagination Object An object containing details of the current page and the total number of pages that are available. To paginate you should specify the page number in your request's page parameter.

  • current_page
  • number
  • The current page number.



  • next_page
  • number
  • The next page number, if a next page of results is available.



  • total_pages
  • number
  • The total number of pages of results.

Next Steps      Questions Parameters