CSV Fields
Backyard 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 sort_by search_term customer_zipcode review_stars min_price max_price |
product | title item_id link brand brand_link upc item_number model_number description feature_bullets feature_bullets_count descriptive_attributes descriptive_attributes_count images main_image.src main_image.link videos has_360_view ratings_total rating specifications variants breadcrumbs buybox_winner.price buybox_winner.symbol buybox_winner.currency buybox_winner.was_price buybox_winner.discount buybox_winner.unit buybox_winner.fulfillment.pickup_info.store_id buybox_winner.fulfillment.pickup_info.store_name buybox_winner.fulfillment.pickup_info.store_state buybox_winner.fulfillment.pickup_info.in_stock buybox_winner.fulfillment.pickup_info.stock_level buybox_winner.fulfillment.scheduled_delivery_info.in_stock buybox_winner.fulfillment.scheduled_delivery_info.stock_level buybox_winner.fulfillment.scheduled_delivery_info.lead_time buybox_winner.fulfillment.scheduled_delivery_info.consolidation_date 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 |
reviews | position id item_id title body campaign_id rating positive_feedback negative_feedback date source.external_source source.is_external_source source.author_name source.verified_purchase |
questions | position id question total_answers date profile.author_name answers.id answers.answer answers.is_brand_answer answers.date answers.total_feedback answers.positive_feedback answers.negative_feedback answers.profile.author_name |
search_results | position product.title product.link product.brand product.ratings_total product.rating product.item_id product.model_number product.primary_image product.collection.link product.collection.type product.collection.id product.feature_bullets_count product.feature_bullets offers.primary.price offers.primary.symbol offers.primary.currency offers.primary.regular_price offers.primary.discount offers.primary.promotion_raw fulfillment.pickup fulfillment.ship_to_home fulfillment.scheduled_delivery fulfillment.pickup_info.store_name fulfillment.pickup_info.stock_level fulfillment.pickup_raw fulfillment.delivery_raw |