Core APIs
...
Home Depot Product Data API
Reference

CSV Fields

1min

CSV Fields Reference

BigBox API can return data in CSV format by specifying the output=csv request parameter. When setting output=csv the csv_fields parameter determines the fields to include in the CSV result.

CSV fields should be specified as a comma seperated list of field names, with nested fields being expressed in dot notation .

Here's an example of the csv_fields parameter:

csv_fields= Below is a full list of all of the supported CSV Fields shown under their group.

Field Group

Fields in Group

request

type url page max_page item_id gtin sort_by search_term category_id customer_zipcode min_price max_price reviewer_type five_star four_star three_star two_star one_star

product

title item_id store_sku upc model_number link main_image.link rating ratings_total brand brand_link description aisle bay buybox_winner.price buybox_winner.unit buybox_winner.currency_symbol buybox_winner.fulfillment.pickup buybox_winner.fulfillment.ship_to_store buybox_winner.fulfillment.ship_to_store_info.store_id buybox_winner.fulfillment.ship_to_store_info.store_state buybox_winner.fulfillment.ship_to_store_info.store_name buybox_winner.fulfillment.ship_to_store_info.in_stock buybox_winner.fulfillment.ship_to_store_info.stock_level buybox_winner.fulfillment.ship_to_store_info.price buybox_winner.fulfillment.ship_to_store_info.start_date buybox_winner.fulfillment.ship_to_store_info.end_date buybox_winner.fulfillment.ship_to_home buybox_winner.fulfillment.ship_to_home_info.store_id buybox_winner.fulfillment.ship_to_home_info.store_name buybox_winner.fulfillment.ship_to_home_info.in_stock buybox_winner.fulfillment.ship_to_home_info.stock_level buybox_winner.fulfillment.ship_to_home_info.price buybox_winner.fulfillment.ship_to_home_info.start_date buybox_winner.fulfillment.ship_to_home_info.end_date buybox_winner.fulfillment.ship_to_home_info.delivery_date_name buybox_winner.fulfillment.scheduled_delivery

reviews

position id title body rating positive_feedback negative_feedback source.is_external_source source.author_id source.author_name source.verified_purchase

questions

position id title total_answers date profile.author_name

search_results

position product.title product.item_id product.store_sku product.link product.primary_image product.rating product.ratings_total offers.primary.price offers.primary.currency

category_results

position product.title product.item_id product.store_sku product.link product.primary_image product.rating product.ratings_total offers.primary.price offers.primary.currency