Core APIs
...
Target Product Data API
Reference

CSV Fields

1min

CSV Fields Reference

RedCircle 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 tcin gtin sort_by search_term

category_id url customer_zipcode page

max_page delivery_type include_out_of_stock

facets reviewer_type review_stars

review_media_type store_stock_zipcode

only_in_stock

product

title link brand brand_link tcin

dpci upc description aisle

main_image.link rating ratings_total weight

dimensions specifications specifications_flat

buybox_winner.price.value

buybox_winner.was_price.value

buybox_winner.availability.raw

buybox_winner.availability.in_stock

buybox_winner.seller.name buybox_winner.seller.id

buybox_winner.seller.link

buybox_winner.fulfillment.type

buybox_winner.fulfillment.pickup

buybox_winner.fulfillment.pickup_info.ready_in_minutes

buybox_winner.fulfillment.pickup_info.stock_level

buybox_winner.fulfillment.delivery_from_store

buybox_winner.fulfillment.shipping

buybox_winner.fulfillment.shipping_info.stock_level

reviews

id title body date rating

positive_feedback negative_feedback

source.is_external_source source.external_source

source.author_id source.author_name

source.syndication_source source.verified_purchase

search_results

position product.title product.tcin

product.dpci product.link product.main_image

product.brand product.brand_link

product.class_id product.department_id

product.rating product.ratings_total

product.sponsored offers.primary.price

offers.primary.max_price offers.primary.min_price

offers.primary.currency

offers.primary.regular_price fulfillment.type

seller.name seller.id

category_results

position product.title product.tcin

product.dpci product.link product.main_image

product.brand product.brand_link

product.class_id product.department_id

product.rating product.ratings_total

offers.primary.price offers.primary.max_price

offers.primary.min_price offers.primary.currency

offers.primary.regular_price fulfillment.type

seller.name seller.id

store_stock_results

position store_id store_name stock_level

address city state zipcode phone

distance