GetResearchResults XML Input Field Reference - eBay Market Data Documentation

GetResearchResults XML Input Field Reference

Other Versions: 1 | Printable Version
Last updated: 2006-11-06 11:40:50

Click on the fields below to view a detailed description and example input.

Common Fields
Field	Type	Summary	Req.
...SearchQuery.Pricing		Defines start and end price filters for resulting auctions.	no
...SearchQuery.Hours		Filters the search to only those listings that closed during certain hours of the day.	no
...Hours.Hour	integer	A single hour that will be searched for in the result set.	no
...Hours.EndHour	integer	Forms the range of hours that will be included in the search.	no
...Hours.StartHour	integer	Forms the range of hours that will be included in the search.	no
...SearchQuery.ListingFilters		This node contains filters for the search based on various listing promotions.	no
...ListingFilters.BuyItNow	boolean	Return only listings that used the Buy It Now feature.	no
...ListingFilters.Successful	boolean	Return only listings that were successful.	no
...ListingFilters.Bold	boolean	Return only listings that used the Bold feature.	no
...ListingFilters.FrontPageFeatured	boolean	Return only listings that used the Front-Page Featured feature.	no
...ListingFilters.CategoryFeatured	boolean	Return only listings that used the Category Featured feature.	no
...ListingFilters.GiftIcon	boolean	Return only listings that used the Gift Icon feature.	no
...ListingFilters.Gallery	boolean	Return only listings that used the Gallery feature.	no
...ListingFilters.GalleryFeatured	boolean	Return only listings that used the Gallery Featured feature.	no
...ListingFilters.PictureServices	boolean	Return only listings that used the Picture Services feature.	no
...ListingFilters.Reserve	boolean	Return only listings that used the Reserve Price feature.	no
...ListingFilters.Highlight	boolean	Return only listings that used the Highlight feature.	no
...ListingFilters.Scheduled	boolean	Return only listings that used the Scheduled Auction feature.	no
...ListingFilters.Subtitle	boolean	Return only listings that used the Subtitle feature.	no
...SearchQuery.ListingTypes		Contains filters for the various types of listings.	no
...ListingTypes.FixedPrice	boolean	Auctions listed as a Pure Fixed Price auction will be returned.	no
...ListingTypes.PersonalOffer	boolean	Auctions sold via a Personal Offer will be returned.	no
...ListingTypes.Store	boolean	Auctions listed in eBay stores will be returned.	no
...ListingTypes.Live	boolean	Live auctions will be returned.	no
...ListingTypes.Dutch	boolean	Auctions listed with the Dutch (multiple item) type will be returned.	no
...ListingTypes.Chinese	boolean	Auctions listed with the Chinese (regular bid) type will be returned.	no
...ResultSet.ReturnAllData	boolean	All possible result sets will be returned to the user.	no
...SearchQuery.SiteID	integer	eBay Site ID to search, assuming you have access.	no
...SearchQuery.Currency	string	Currency to return results in.	no
...SearchQuery.ListingsReturned		Determines how the Item List is formatted	no
...ListingsReturned.SortColumns		The columns ot sort the item list by	no
...SortColumns.Column	string	A column to sort the item list by	no
...ListingsReturned.Descending	boolean	Determines whether the item list will be sorted Descending or Ascending	no
...ListingsReturned.Limit	integer	Determines the number of listings to return	no
Call Specific Fields
Field	Type	Summary	Req.
GetResearchResults.Version	integer	The API Schema Version you wish to send and recieve results in.	no
GetResearchResults.RequesterCredentials		Contains the authorization keys required for every call.	yes
...RequesterCredentials.Token	string	One of three required authorization keys that must be included with every call.	yes
...RequesterCredentials.UserToken	string	One of three required authorization keys that must be included with every call.	yes
...RequesterCredentials.DeveloperName	string	One of three required authorization keys that must be included with every call.	yes
GetResearchResults.SearchQuery		Contains all the parameters of the search	yes
...SearchQuery.Keywords	string	The keyword or keywords you are searching for.	yes
...Pricing.StartPriceCeiling	float	The highest starting price for items you want to research.	no
...Pricing.StartPriceFloor	float	The lowest starting price for items you want to research.	no
...Pricing.EndPriceCeiling	float	The lowest closing price for items you want to research.	no
...Pricing.EndPriceFloor	float	The lowest closing price for items you want to research.	no
...SearchQuery.CategoryLimit		This node contains CategoryIDs to be searched.	no
...CategoryLimit.CategoryID	integer	The category in which to search for results.	no
...SearchQuery.Dates		Contains the date range for your search.	no
...Dates.StartDate	date	The first date in the range of dates that you are searching.	no
...Dates.EndDate	date	The last date in the range of dates that you are searching.	no
...Dates.DateRange	date range	Used to specific the number of days to search.	no
...Dates.Date	date	A single date you wish to search. You may include multiple instances of this tag.	no
...SearchQuery.DurationFilter	integer	Filters the results based on the duration of the auctions.	no
...SearchQuery.ListingLimit	integer	Causes the search to stop after it has found a specific number of listings.	no
...SearchQuery.ResultSet		This node specifies which sets of data are returned.	no
...ResultSet.ReturnHourlyData	boolean	This node specifies whether Hourly Analysis will be returned.	no
...ResultSet.ReturnPricingInformation	boolean	This node specifies whether Pricing Information will be returned.	no
...ResultSet.ReturnFeatureInformation	boolean	This node specifies whether Listing Promotion (Features) Information will be returned.	no
...ResultSet.ReturnDurationData	boolean	This node specifies whether Duration Data will be returned.	no
...ResultSet.ReturnListingTypes	boolean	This node specifies whether Listing Type Information will be returned.	no
...ResultSet.ReturnPriceBuckets	boolean	This node specifies whether Price Buckets will be returned.	no
...ResultSet.ReturnDailyData	boolean	This node specifies whether Daily Aggregates will be returned.	no
...ResultSet.ReturnCategoryInformation	boolean	This node specifies whether Top Category Information will be returned.	no
...ResultSet.ReturnItemList	boolean	This node specifies whether a sample of Items will be returned.	no
...ResultSet.ReturnKeywordData	boolean	This node specifies whether the PopularKeywords node will be returned.	no

No Comments Found