Questions

3min

Questions Parameters
﻿GET  /request
The Questions Parameters are applicable when making a request with  type=questions  to retrieve customer Questions for a single product on Home Depot - the product is specified using either the  item_id  or  url  parameter (where the  url  parameter contains a link to a Home Depot product page). The parameters should be appended as querystring parameters to the Home Depot Product Data API GET HTTP request.
Questions are retrieved from the customer questions page for a single product on Home Depot.
Customer Questions Page
﻿
For example, to request questions sorted by most helpful ( sort_by=most_helpful ), for the Item ID  317061059 , the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.bigboxapi.com/request?api_key=demo&type=questions&item_id=317061059&sort_by=most_helpful
https://api.bigboxapi.com/request?api_key=demo&type=questions&item_id=317061059&sort_by=most_helpful
﻿
﻿
Questions Parameters
The following parameters are available for all requests made when  type=questions  in addition to the Common Parameters.
Parameter
Required
Description
item_id 

required 

The Home Depot Item ID to retrieve Questions for.

Note : If the  item_id  parameter is supplied then the  url  parameter is ignored.
gtin 

optional 

The GTIN/ISBN/UPC code to look up a matching product on Home Depot for to retrieve questions for. If the  gtin  parameter is supplied then the  item_id  parameter is ignored. GTIN-based requests work by looking up the GTIN/ISBN/UPC on Home Depot first, then retrieving the questions for the first matching  item_id .
url 

optional 

The Home Depot questions-page URL to retrieve Questions from.
sort_by 
optional 
Determines the sort order of questions to return. Valid values are:
newest_to_oldest 
Returns questions ordered from newest to oldest.
﻿
oldest_to_newest 
Returns questions ordered from oldest to newest.
﻿
most_answered 
Returns questions with most answers first.
﻿
most_helpful 
Returns questions with the most helpful questions first.
﻿
featured_questions 
Returns featured questions first.
﻿
can_you_answer 
Returns questions returned under the "can you answer these questions" filter first (questions with no answer yet).
﻿
﻿
﻿
﻿
search_term 

optional 

search term to use to search questions.
﻿
﻿
page 

optional 

The current page of questions to retrieve. Inspect the  pagination.total_pages  property in the Questions results to see how many pages of questions are available.

Note  the maximum number of questions per page is  10  (this is a Home Depot limit).
max_page 

optional 

Use the  max_page  parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response.

See the Pagination docs for more information.
Next Steps
     Questions Results﻿

Parameter	Required	Description
item_id	required	The Home Depot Item ID to retrieve Questions for. Note : If the item_id parameter is supplied then the url parameter is ignored.
gtin	optional	The GTIN/ISBN/UPC code to look up a matching product on Home Depot for to retrieve questions for. If the gtin parameter is supplied then the item_id parameter is ignored. GTIN-based requests work by looking up the GTIN/ISBN/UPC on Home Depot first, then retrieving the questions for the first matching item_id .
url	optional	The Home Depot questions-page URL to retrieve Questions from.
sort_by	optional	Determines the sort order of questions to return. Valid values are: newest_to_oldest Returns questions ordered from newest to oldest. oldest_to_newest Returns questions ordered from oldest to newest. most_answered Returns questions with most answers first. most_helpful Returns questions with the most helpful questions first. featured_questions Returns featured questions first. can_you_answer Returns questions returned under the "can you answer these questions" filter first (questions with no answer yet).
search_term	optional	search term to use to search questions.
page	optional	The current page of questions to retrieve. Inspect the pagination.total_pages property in the Questions results to see how many pages of questions are available. Note the maximum number of questions per page is 10 (this is a Home Depot limit).
max_page	optional	Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response. See the Pagination docs for more information.

Updated 07 Aug 2024

Did this page help you?

Reviews