Finding API

Migration Guide for GetSearchResults to Finding Service findItemsAdvanced

This document maps the fields in GetSearchResults, a Trading API (release 695) call, to the equivalent fields in findItemsAdvanced, a Finding API (release 1.9.0) call.

In general, this document does not list enumeration values. However, to show the mappings to the findItemsAdvanced itemFilter element, some enumerations are included. Where included, enumeration values are shown in italics.

The findItemsAdvanced call incorporates the itemFilter field, which takes Name/Value pairs. In addition, some itemFilter fields also make use of parameter values, most notably with filters that use currency values. For example:

...
&itemFilter(0).name=MinBids&itemFilter(0).value(0)=20
&itemFilter(1).name=FeedbackScoreMin&itemFilter(1).value(0)=1000
&itemFilter(2).name=MaxPrice&itemFilter(2).value(0)=25.00
&itemFilter(2).paramName=Currency&itemFilter(2).paramValue(0)=USD
...

Although TicketFinder and ProductFinder functionality is not directly supported with the Finding API, you can mimic some of this functionality through aspect histograms and aspect filters.

Request Mapping

Table 1: Mapping GetSearchResults Input to findItemsAdvanced Input

GetSearchResults (Trading API) findItemsAdvanced (Finding API)
Input Field Input Field itemFilter Name
AdFormat itemFilter Name.ListingType
Value.Classified
AffilateTrackingDetails affiliate
AffiliateTrackingDetails.AffiliateUserID affiliate.customId
AffiliateTrackingDetails.TrackingID affiliate.trackingId
AffiliateTrackingDetails.TrackingPartnerCode affiliate.NetworkID
BidRange No direct equivalent.
BidRange.MaximumBidCount itemFilter MaxBids
BidRange.MinimumBidCount itemFilter MinBids
Categories Use getHistograms.
CategoryID categoryId
CharityID No direct equivalent.
DetailLevel outputSelector
EndTimeFrom itemFilter EndTimeFrom
EndTimeTo itemFilter EndTimeTo
ErrorLanguage No direct equivalent.
ExpandSearch No direct equivalent.
ExternalProductID Use findItemsByProduct.
FreeShipping itemFilter FreeShippingOnly
GranularityLevel outputSelector
Group No direct equivalent.
HideDuplicatesItems itemFilter HideDuplicateItems
IncludeCondition No direct equivalent.
IncludeFeedback No direct equivalent.
IncludeGetItFastItems itemFilter GetItFastOnly
ItemCondition itemFilter Condition
ItemTypeFilter.AllFixedPriceItemTypes itemFilter Name.ListingType
Value.AuctionWithBIN
Value.FixedPrice
ItemTypeFilter.AllItems itemFilter Name.ListingType
Value.All
ItemTypeFilter.AllItemTypes itemFilter Name.ListingType
Value.All
ItemTypeFilter.AuctionItemsOnly itemFilter Name.ListingType
Value.Auction
ItemTypeFilter.ClassifiedItemsOnly itemFilter Name.ListingType
Value.Classified
ItemTypeFilter.FixedPriceItem itemFilter Name.ListingType
Value.FixedPrice
LocalSearchPostalCode itemFilter LocalSearchOnly
Lot itemFilter LotsOnly
MaxRelatedSearchKeywords Use getSearchKeywordsRecommendation.
MessageID No direct equivalent.
ModTimeFrom itemFilter ModTimeFrom
MotorsGermanySearchable No direct equivalent.
Order.BestMatchCategoryGoup No direct equivalent.
Order.BestMatchSort sortOrder.BestMatch
Order.PricePlusShippingAsc sortOrder.PricePlusShippingLowest
Order.PricePlusShippingDesc sortOrder.PricePlusShippingHighest
Order.SortByBidCountAsc sortOrder.BidCountFewest
Order.SortByBidCountDesc sortOrder.BidCountMost
Order.SortByCountryAsc sortOrder.CountryAscending
Order.SortByCountryDesc sortOrder.CountryDescending
Order.SortByCurrentBid No direct equivalent.
Order.SortByCurrentBidAsc No direct equivalent.
Order.SortByCurrentBidDesc sortOrder.CurrentPriceHighest
Order.SortByDistanceAsc sortOrder.Distance
Order.SortByEndDate sortOrder.EndTime
Order.SortByEscrowAsc No direct equivalent.
Order.SortByEscrowDesc No direct equivalent.
Order.SortByListingDate sortOrder.StartTimeNewest
Order.SortByPayPalAsc No direct equivalent.
Order.SortByPayPalDesc No direct equivalent.
Order.StartDate sortOrder.StartTimeNewest
OutputSelector outputSelector
Pagination paginationInput
Pagination.EntriesPerPage paginationInput.entriesPerPage
Pagination.PageNumber paginationInput.pageNumber
PaymentMethod itemFilter PaymentMethod
PriceRangeFilter itemFilter
PriceRangeFilter.MaxPrice itemFilter MaxPrice
PriceRangeFilter.MinPrice itemFilter MinPrice
ProductID Use findItemsByProduct.
ProximitySearch itemFilter
ProximitySearch.MaxDistance itemFilter MaxDistance
ProximitySearch.PostalCode buyerPostalCode
Quantity itemFilter MaxQuantity, MinQuantity
QuantityOperator itemFilter MaxQuantity, MinQuantity
Query keywords
SearchFlags No direct equivalent.
SearchLocationFilter No direct equivalent.
SearchLocationFilter.CountryCode No direct equivalent.
SearchLocationFilter.Currency itemFilter Currency
SearchLocationFilter.ItemLocation.ItemAvailableIn itemFilter AvailableTo
SearchLocationFilter.ItemLocation.ItemLocatedIn itemFilter LocatedIn
SearchLocationFilter.SearchLocation.RegionID No direct equivalent.
SearchLocationFilter.SearchLocation.SiteLocation.SiteID No direct equivalent.
SearchRequest No direct equivalent.
SearchType No direct equivalent.
SellerBusinessType itemFilter SellerBusinessType
StoreSearchFilter Use findItemsIneBayStores.
TicketFinder No direct equivalent.
TotalOnly No direct equivalent.
UserIdFilter itemFilter
UserIdFilter.ExcludeSellers itemFilter ExcludeSeller
UserIdFilter.IncludeSellers itemFilter Seller
Version No direct equivalent.
WarningLevel No direct equivalent.

Response Mapping

Table 2: Mapping GetSearchResults Output to findItemsAdvanced Output

FindItemsAdvanced (Shopping API)
Output Field
findItemsAdvanced (Finding API)
Output Field
Ack ack
AllCategoriesExpansionArray No direct equivalent.
Build No direct equivalent.
BuyingGuideDetails No direct equivalent.
CategoryArray categoryHistogramContainer
CorrelationID No direct equivalent.
DuplicateItems No direct equivalent.
Errors errorMessage.error
Errors.ErrorClassification errorMessage.error.category
Errors.ErrorCode errorMessage.error.errorId
Errors.ErrorParameters [attribute ParamID] errorMessage.error.parameter [attribute name]
Errors.ErrorParameters.Value errorMessage.error.parameter
Errors.LongMessage errorMessage.error.message
Errors.SeverityCode errorMessage.error.severity
Errors.ShortMessage No direct equivalent.
FilterRemovedExpansionArray No direct equivalent.
HardExpirationWarning No direct equivalent.
HasMoreItems No direct equivalent.
InternationalExpansionArray No direct equivalent.
ItemsPerPage paginationOutput.entriesPerPage
PageNumber paginationOutput.pageNumber
PaginationResult paginationOutput
PageinationResult.TotalNumberOfEntries paginationOutput.totalEntries
PaginationResult.TotalNumberOfPages paginationOutput.totalPages
RelatedSearchKeywordArray No direct equivalent.
SearchResultItemArray (count) searchResult [attribute count]
SearchResultItemArray.searchResultItem No direct equivalent.
SearchResultItemArray.searchResultItem.Item searchResult.item
SearchResultItemArray.SearchResultItem.Item.AttributeSetArray No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.BestOfferEnabled searchResult.item.listingInfo.bestOfferEnabled
SearchResultItemArray.SearchResultItem.Item.BuyerGuaranteePrice No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.BuyerProtection No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.BuyItNowPrice searchResult.item.listingInfo.buyItNowPrice [attribute curencyId]
SearchResultItemArray.SearchResultItem.Item.Country searchResult.item.country
SearchResultItemArray.SearchResultItem.Item.Currency curencyId attribute
SearchResultItemArray.SearchResultItem.Item.Distance No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.Distance.DistanceMeasurement searchResult.item.distance
SearchResultItemArray.SearchResultItem.Item.Distance.DistanceUnit searchResult.item.distance [attribute unit]
SearchResultItemArray.SearchResultItem.Item.GiftIcon searchResult.item.listingInfo.gift
SearchResultItemArray.SearchResultItem.Item.GroupCategoryID No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.ItemID searchResult.item.itemId
SearchResultItemArray.SearchResultItem.Item.ListingDetails searchResult.item.listingInfo
SearchResultItemArray.SearchResultItem.Item.ListingDetails.ConvertedBuyItNowPrice searchResult.item.listingInfo.convertedBuyItNowPrice [attribute currencyId]
SearchResultItemArray.SearchResultItem.Item.ListingDetails.ConvertedStartPrice No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.ListingDetails.EndTime searchResult.item.listingInfo.endTime
SearchResultItemArray.SearchResultItem.Item.ListingDetails.SellerBusinessType No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.ListingDetails.StartTime searchResult.item.listingInfo.startTime
SearchResultItemArray.SearchResultItem.Item.ListingDetails.ViewItemURL No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.ListingDetails.ViewItemURLForNaturalSearch searchResult.item.viewItemURL
SearchResultItemArray.SearchResultItem.Item.ListingDuration searchResult.item.listingInfo.endTime minus startTime
SearchResultItemArray.SearchResultItem.Item.ListingEnhancement No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.ListingType searchResult.item.listingInfo.listingType
SearchResultItemArray.SearchResultItem.Item.LocalListing searchResult.item.location plus postalCode
SearchResultItemArray.SearchResultItem.Item.MotorsGermanySearchable No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.PaymentMethods searchResult.item.paymentMethod
SearchResultItemArray.SearchResultItem.Item.PictureDetails No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.PictureDetails.GalleryType No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.PictureDetails.GalleryURL searchResult.item.galleryURL
SearchResultItemArray.SearchResultItem.Item.PictureDetails.PhotoDisplay No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.PostalCode searchResult.item.postalCode
SearchResultItemArray.SearchResultItem.Item.PrimaryCategory searchResult.item.primaryCategory.categoryName
SearchResultItemArray.SearchResultItem.Item.PrimaryCategory.CategoryID searchResult.item.primaryCategory [attribute categoryId]
SearchResultItemArray.SearchResultItem.Item.SearchDetails No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.SearchDetails.BuyItNowEnabled searchResult.item.listingInfo.buyItNowAvailable
SearchResultItemArray.SearchResultItem.Item.SearchDetails.Picture No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.SearchDetails.RecentListing No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.SecondaryCategory searchResult.item.secondaryCategory.categoryName
SearchResultItemArray.SearchResultItem.Item.SecondaryCategory.CategoryID searchResult.item.secondaryCategory [attribute categoryId]
SearchResultItemArray.SearchResultItem.Item.Seller searchResult.item.sellerInfo
SearchResultItemArray.SearchResultItem.Item.Seller.FeedbackScore searchResult.item.sellerInfo.feedbackScore
SearchResultItemArray.SearchResultItem.Item.Seller.PositiveFeedbackPercent searchResult.item.sellerInfo.positiveFeedbackPercent
SearchResultItemArray.SearchResultItem.Item.Seller.UserID searchResult.item.sellerInfo.sellerUserName
SearchResultItemArray.SearchResultItem.Item.SellingStatus searchResult.item.sellingStatus
SearchResultItemArray.SearchResultItem.Item.SellingStatus.BidCount searchResult.item.sellingStatus.bidCount
SearchResultItemArray.SearchResultItem.Item.SellingStatus.ConvertedCurrentPrice searchResult.item.sellingStatus.convertedCurrentPrice [attribute currencyId]
SearchResultItemArray.SearchResultItem.Item.SellingStatus.CurrentPrice searchResult.item.sellingStatus.currentPrice [attribute currencyId]
SearchResultItemArray.SearchResultItem.Item.ShippingDetails searchResult.item.shipingInfo
SearchResultItemArray.SearchResultItem.Item.ShippingDetails.DefaultShippingCost searchResult.item.shipingInfo.shippingServiceCost [attribute currencyId]
SearchResultItemArray.SearchResultItem.Item.ShippingDetails.ShippingType searchResult.item.shipingInfo.shippingType
SearchResultItemArray.SearchResultItem.Item.Site searchResult.item.globalId
SearchResultItemArray.SearchResultItem.Item.Storefront searchResult.item.storeInfo
SearchResultItemArray.SearchResultItem.Item.Storefront.StoreCategory2ID No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.Storefront.StoreCategoryID No direct equivalent.
SearchResultItemArray.SearchResultItem.Item.Storefront.StoreName searchResult.item.storeInfo.storeName
SearchResultItemArray.SearchResultItem.Item.Storefront.StoreURL searchResult.item.storeInfo.storeURL
SearchResultItemArray.SearchResultItem.Item.Title searchResult.item.title
SearchResultItemArray.SearchResultItem.ItemSpecific No direct equivalent.
SearchResultItemArray.SearchResultItem.ItemSpecific.NameValueList No direct equivalent.
SearchResultItemArray.SearchResultItem.ItemSpecific.NameValueList.Name No direct equivalent.
SearchResultItemArray.SearchResultItem.ItemSpecific.NameValueList.Value No direct equivalent.
SearchResultItemArray.SearchResultItem.SearchResultValues No direct equivalent.
SpellingSuggestion No direct equivalent.
StoreExpansionArray No direct equivalent.
Timestamp timestamp
Version version


Copyright © 2009–2016 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.