Input
Field Reference
Version
RequesterCredentials
Token
UserToken
DeveloperName
SearchQuery
SellerFilters
Seller
ExcludeSeller
Keywords
Pricing
PriceFloor
PriceCeiling
StartPriceFloor
StartPriceCeiling
CategoryLimit
CategoryID
Dates
Date
DateRange
EndDate
StartDate
ListingLimit
ResultSet
ReturnItemList
ReturnCategoryInformation
ReturnDailyData
ReturnPriceBuckets
ReturnListingTypes
ReturnDurationData
ReturnFeatureInformation
ReturnPricingInformation
ReturnHourlyData
ReturnAllData
SiteID
Currency
ListingsReturned
Limit
Descending
SortColumns
Column
DurationFilter
Hours
StartHour
EndHour
Hour
ListingFilters
BuyItNow
Successful
Bold
FrontPageFeatured
GiftIcon
Gallery
GalleryFeatured
PictureServices
Reserve
Highlight
Scheduled
Revenue
Subtitle
NoFeaturesUsed
ListingTypes
Chinese
Dutch
Live
Store
PersonalOffer
FixedPrice
Schema
Developers Area
Developer Forum
Developer Tools
Research API Signup
My Profile
Contact
GetSellerResearchResults Input Field Reference
Other Versions:
1
|
Printable Version
Last updated: 2006-07-07 14:12:36
Click on a field for a detailed explanation and example input.
Call Specific Fields
Field
Type
Summary
Req.
GetSellerResearchResults.Version
integer
The API Schema Version you wish to send and recieve results in.
no
GetSellerResearchResults.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
GetSellerResearchResults.SearchQuery
Contains all the parameters of the search
yes
...SearchQuery.SellerFilters
Allows specific sellers' auction's to be searched
no
...SellerFilters.Seller
string
Search for auctions listed by a specific seller
no
...SellerFilters.ExcludeSeller
string
Search for auctions NOT listed by the specified seller
no
...SearchQuery.Keywords
string
The keyword or keywords you are searching for.
yes
...SearchQuery.Pricing
Defines start and end price filters for resulting auctions.
no
...Pricing.EndPriceFloor
float
The lowest closing price for items you want to research.
no
...Pricing.EndPriceCeiling
float
The lowest closing price for items you want to research.
no
...Pricing.StartPriceFloor
float
The lowest starting price for items you want to research.
no
...Pricing.StartPriceCeiling
float
The highest starting 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.Date
date
A single date you wish to search. You may include multiple instances of this tag.
no
...Dates.DateRange
date range
Used to specific the number of days to search.
no
...Dates.EndDate
date
The last date in the range of dates that you are searching.
no
...Dates.StartDate
date
The first date in the range of dates that you are searching.
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.ReturnItemList
boolean
This node specifies whether a sample of Items will be returned.
no
...ResultSet.ReturnCategoryInformation
boolean
This node specifies whether Top Category Information will be returned.
no
...ResultSet.ReturnDailyData
boolean
This node specifies whether Daily Aggregates will be returned.
no
...ResultSet.ReturnPriceBuckets
boolean
This node specifies whether Price Buckets will be returned.
no
...ResultSet.ReturnListingTypes
boolean
This node specifies whether Listing Type Information will be returned.
no
...ResultSet.ReturnDurationData
boolean
This node specifies whether Duration Data will be returned.
no
...ResultSet.ReturnFeatureInformation
boolean
This node specifies whether Listing Promotion (Features) Information will be returned.
no
...ResultSet.ReturnPricingInformation
boolean
This node specifies whether Pricing Information will be returned.
no
...ResultSet.ReturnHourlyData
boolean
This node specifies whether Hourly Analysis 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.Limit
integer
Determines the number of listings to return
no
...ListingsReturned.Descending
boolean
Determines whether the item list will be sorted Descending or Ascending
no
...ListingsReturned.SortColumns
The columns ot sort the item list by
no
...SortColumns.Column
string
A column to sort the item list by
no
...SearchQuery.DurationFilter
integer
Filters the results based on the duration of the auction.
no
...SearchQuery.Hours
Filters the search to only those listings that closed during certain hours of the day.
no
...Hours.StartHour
integer
Forms the range of hours that will be included in the search.
no
...Hours.EndHour
integer
Forms the range of hours that will be included in the search.
no
...Hours.Hour
integer
A single hour that will be searched for in the result set.
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.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.MultiListed
integer
The total revenue generated by listings in the category
no
...ListingFilters.Subtitle
boolean
Return only listings that used the Subtitle feature.
no
...ListingFilters.NoFeaturesUsed
Return only listings that used no features.
no
...SearchQuery.ListingTypes
Contains filters for the various types of listings.
no
...ListingTypes.Chinese
boolean
Auctions listed with the Chinese (regular bid) type will be returned.
no
...ListingTypes.Dutch
boolean
Auctions listed with the Dutch (multiple item) type will be returned.
no
...ListingTypes.Live
boolean
Live auctions will be returned.
no
...ListingTypes.Store
boolean
Auctions listed in eBay stores will be returned.
no
...ListingTypes.PersonalOffer
boolean
Auctions sold via a Personal Offer will be returned.
no
...ListingTypes.FixedPrice
boolean
Auctions listed as a Pure Fixed Price auction will be returned.
no
See Also
:
GetSellerResearchResults Input Schema
,
GetSellerResearchResults Ouput Summary
No Comments Found
Post A Comment
Use of this Web site constitutes acceptance of the DataUnison
Terms
and
Privacy Policy
.
Copyright © 2005-2008
DataUnison
. All Rights Reserved.
eBay and the eBay Logo are Trademarks of eBay Inc.