http://developer.dataunison.com/pages/developers_area/ebay_research_api/api_call_reference/getresearchresults/getresearchresults_input/getresearchresults_xml_input_field_reference.html
©2004-2008 Advanced Economic Research Inc. | Back to HTML
GetResearchResults XML Input Field Reference
Click on the fields below to view a detailed description and example input.
Common Fields
FieldTypeSummaryReq.
...SearchQuery.PricingDefines start and end price filters for resulting auctions.no
...SearchQuery.HoursFilters the search to only those listings that closed during certain hours of the day.no
...Hours.HourintegerA single hour that will be searched for in the result set.no
...Hours.EndHourintegerForms the range of hours that will be included in the search.no
...Hours.StartHourintegerForms the range of hours that will be included in the search.no
...SearchQuery.ListingFiltersThis node contains filters for the search based on various listing promotions.no
...ListingFilters.BuyItNowbooleanReturn only listings that used the Buy It Now feature.no
...ListingFilters.SuccessfulbooleanReturn only listings that were successful.no
...ListingFilters.BoldbooleanReturn only listings that used the Bold feature.no
...ListingFilters.FrontPageFeaturedbooleanReturn only listings that used the Front-Page Featured feature.no
...ListingFilters.CategoryFeaturedbooleanReturn only listings that used the Category Featured feature.no
...ListingFilters.GiftIconbooleanReturn only listings that used the Gift Icon feature.no
...ListingFilters.GallerybooleanReturn only listings that used the Gallery feature.no
...ListingFilters.GalleryFeaturedbooleanReturn only listings that used the Gallery Featured feature.no
...ListingFilters.PictureServicesbooleanReturn only listings that used the Picture Services feature.no
...ListingFilters.ReservebooleanReturn only listings that used the Reserve Price feature.no
...ListingFilters.HighlightbooleanReturn only listings that used the Highlight feature.no
...ListingFilters.ScheduledbooleanReturn only listings that used the Scheduled Auction feature.no
...ListingFilters.SubtitlebooleanReturn only listings that used the Subtitle feature.no
...SearchQuery.ListingTypesContains filters for the various types of listings.no
...ListingTypes.FixedPricebooleanAuctions listed as a Pure Fixed Price auction will be returned.no
...ListingTypes.PersonalOfferbooleanAuctions sold via a Personal Offer will be returned.no
...ListingTypes.StorebooleanAuctions listed in eBay stores will be returned.no
...ListingTypes.LivebooleanLive auctions will be returned.no
...ListingTypes.DutchbooleanAuctions listed with the Dutch (multiple item) type will be returned.no
...ListingTypes.ChinesebooleanAuctions listed with the Chinese (regular bid) type will be returned.no
...ResultSet.ReturnAllDatabooleanAll possible result sets will be returned to the user.no
...SearchQuery.SiteIDintegereBay Site ID to search, assuming you have access.no
...SearchQuery.CurrencystringCurrency to return results in.no
...SearchQuery.ListingsReturnedDetermines how the Item List is formattedno
...ListingsReturned.SortColumnsThe columns ot sort the item list byno
...SortColumns.ColumnstringA column to sort the item list byno
...ListingsReturned.DescendingbooleanDetermines whether the item list will be sorted Descending or Ascendingno
...ListingsReturned.LimitintegerDetermines the number of listings to returnno
Call Specific Fields
FieldTypeSummaryReq.
GetResearchResults.VersionintegerThe API Schema Version you wish to send and recieve results in.no
GetResearchResults.RequesterCredentialsContains the authorization keys required for every call.yes
...RequesterCredentials.TokenstringOne of three required authorization keys that must be included with every call.yes
...RequesterCredentials.UserTokenstringOne of three required authorization keys that must be included with every call.yes
...RequesterCredentials.DeveloperNamestringOne of three required authorization keys that must be included with every call.yes
GetResearchResults.SearchQueryContains all the parameters of the searchyes
...SearchQuery.KeywordsstringThe keyword or keywords you are searching for.yes
...Pricing.StartPriceCeilingfloatThe highest starting price for items you want to research.no
...Pricing.StartPriceFloorfloatThe lowest starting price for items you want to research.no
...Pricing.EndPriceCeilingfloatThe lowest closing price for items you want to research.no
...Pricing.EndPriceFloorfloatThe lowest closing price for items you want to research.no
...SearchQuery.CategoryLimitThis node contains CategoryIDs to be searched.no
...CategoryLimit.CategoryIDintegerThe category in which to search for results.no
...SearchQuery.DatesContains the date range for your search.no
...Dates.StartDatedateThe first date in the range of dates that you are searching.no
...Dates.EndDatedateThe last date in the range of dates that you are searching.no
...Dates.DateRangedate rangeUsed to specific the number of days to search.no
...Dates.DatedateA single date you wish to search. You may include multiple instances of this tag.no
...SearchQuery.DurationFilterintegerFilters the results based on the duration of the auctions.no
...SearchQuery.ListingLimitintegerCauses the search to stop after it has found a specific number of listings.no
...SearchQuery.ResultSetThis node specifies which sets of data are returned.no
...ResultSet.ReturnHourlyDatabooleanThis node specifies whether Hourly Analysis will be returned.no
...ResultSet.ReturnPricingInformationbooleanThis node specifies whether Pricing Information will be returned.no
...ResultSet.ReturnFeatureInformationbooleanThis node specifies whether Listing Promotion (Features) Information will be returned.no
...ResultSet.ReturnDurationDatabooleanThis node specifies whether Duration Data will be returned.no
...ResultSet.ReturnListingTypesbooleanThis node specifies whether Listing Type Information will be returned.no
...ResultSet.ReturnPriceBucketsbooleanThis node specifies whether Price Buckets will be returned.no
...ResultSet.ReturnDailyDatabooleanThis node specifies whether Daily Aggregates will be returned.no
...ResultSet.ReturnCategoryInformationbooleanThis node specifies whether Top Category Information will be returned.no
...ResultSet.ReturnItemListbooleanThis node specifies whether a sample of Items will be returned.no
...ResultSet.ReturnKeywordDatabooleanThis node specifies whether the PopularKeywords node will be returned.no
See Also: GetResearchResults Input Schema, GetResearchResults Output Schema, GetResearchResults Output Field Reference