This document maps the fields in FindItemsAdvanced, a Shopping 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 ...
Table 1: Mapping FindItemsAdvanced Input to findItemsAdvanced Input
| FindItemsAdvanced (Shopping API) | findItemsAdvanced (Finding API) | |
|---|---|---|
| Input Field | Input Field | itemFilter Name |
| BidCountMax | itemFilter | MaxBids |
| BidCountMin | itemFilter | MinBids |
| CategoryHistogramMaxParents | Use getHistograms. | — |
| CategoryHistogramMaxChildren | Use getHistograms. | — |
| CategoryID | categoryId | — |
| CategoryIDExclude | itemFilter | ExcludeCategory |
| CharityID | No direct equivalent. | — |
| Condition | itemFilter | Condition |
| Currency | itemFilter | Currency |
| DescriptionSearch | discriptionSearch | — |
| EndTimeFrom | itemFilter | EndTimeFrom |
| EndTimeTo | itemFilter | EndTimeTo |
| ExcludeFlag.AutoPay | itemFilter | ExcludeAutoPay |
| FeedbackScoreMax | itemFilter | FeedbackScoreMax |
| FeedbackScoreMin | itemFilter | FeedbackScoreMin |
| GroupMaxEntries | No direct equivalent. | — |
| GroupsMax | No direct equivalent. | — |
| HideDuplicatesItems | itemFilter | HideDuplicateItems |
| IncludeSelector | outPutSelector | — |
| ItemLocationRegion | No direct equivalent. | — |
| ItemsAvailableTo | itemFilter | AvailableTo |
| ItemsLocatedIn | itemFilter | LocatedIn |
| ItemSort.BestMachCategoryGroup | No direct equivalent. | — |
| ItemSort.BestMatch | sortOrder.BestMatch | — |
| ItemSort.BestMatchPlusEndTime | No direct equivalent. | — |
| ItemSort.BestMatchPlusPrice | No direct equivalent. | — |
| ItemSort.PricePlusShipping | sortOrder.PricePlusShippingLowest | — |
| ItemSort.BidCount with SortOrder.Ascending | sortOrder.BidCountFewest | — |
| ItemSort.BidCount with SortOrder.Descending | sortOrder.BidCountMost | — |
| ItemSort.CurrentBid | sortOrder.CurrentPrice | — |
| ItemSort.EndTime | sortOrder.EndTime | — |
| ItemSort.StartDate | sortOrder.StartDate | — |
| ItemType.AdFormat | itemFilter | Name.ListingType
Value.Classified |
| ItemType.AllFixedPriceItemTypes | itemFilter | Name.ListingType
Value.AuctionWithBIN Value.FixedPrice Value.StoreInventory |
| ItemType.AllItems | itemFilter | Name.ListingType
Value.All |
| ItemType.AllItemTypes | itemFilter | Name.ListingType Value.All |
| ItemType.AuctionItemsOnly | itemFilter | Name.ListingType
Value.Auction |
| ItemType.ClassifiedItemsOnly | itemFilter | Name.ListingType
Value.Classified |
| ItemType.ExcludeStoreInventory | Default behavior when no ListingType filter specified | — |
| ItemType.FixedPriceItem | itemFilter | Name.ListingType
Value.FixedPrice (excludies StoreInventory) |
| ItemType.FixedPriceExcludeStoreInventory | itemFilter | Name.ListingType
Value.FixedPrice |
| ItemType.StoreInventoryOnly | itemFilter | Name.ListingType
Value.StoreInventory |
| MaxDistance | itemFilter | MaxDistance |
| MaxEntries | paginationInput.entriesPerPage | — |
| MessageID | No direct equivalent. | — |
| ModTimeFrom | itemFilter | ModTimeFrom |
| PageNumber | paginationInput.pageNumber | — |
| PaymentMethod | itemFilter | PaymentMethod |
| PostalCode | buyerPostalCode | — |
| PreferredLocation | No direct equivalent. | — |
| PriceMax [attribute currencyID] | itemFilter | MaxPrice |
| PriceMin [attribute currencyID] | itemFilter | MinPrice |
| ProductID [attribute type] | Use findItemsByProduct. | — |
| Quantity | itemFilter | MaxQuantity, MinQuantity |
| QuantityOperator | itemFilter | MaxQuantity, MinQuantity |
| QueryKeywords | keywords | — |
| SearchFlag.AutoPay | No direct equivalent. | — |
| SearchFlag.Charity | itemFilter | CharityOnly |
| SearchFlag.Featured | itemFilter | FeaturedOnly |
| SearchFlag.FreeShipping | itemFilter | FreeShippingOnly |
| SearchFlag.GermanMotorsSearchable | No direct equivalent. | — |
| SearchFlag.GetItFast | itemFilter | GetItFastOnly |
| SearchFlag.LocalSearch | itemFilter | LocalSearchOnly |
| SearchFlag.Lot | itemFilter | LotsOnly |
| SearchFlag.NowAndNew | No direct equivalent. | — |
| SearchFlag.Picture | No direct equivalent. | — |
| SearchFlag.SuperFeatured | No direct equivalent. | — |
| SearchFlag.Gallery | No direct equivalent. | — |
| SellerBusinessType | itemFilter | SellerBusinessType |
| SellerID | itemFilter | Seller |
| SellerIDExclude | itemFilter | ExcludeSeller |
| ShippingLocation (use with PostalCode) | itemFilter | LocalSearchOnly |
| ShippingPostalCode | No direct equivalent. | — |
| SortOrder | sortOrder | — |
| StoreName | Use findItemsIneBayStores. | — |
| StoreSearch | Use findItemsIneBayStores. | — |
| X-EBAY-API-AFFILIATE-USER-ID (in header) | affiliate.customId | — |
| X-EBAY-API-TRACKING-ID (in header) | affiliate.trackingId | — |
| X-EBAY-API-TRACKING-PARTNER-CODE (in header) | affiliate.networkId | — |
Table 2: Mapping GetSearchResults Output to findItemsAdvanced Output
| FindItemsAdvanced (Shopping API) | findItemsAdvanced (Finding API) |
|---|---|
| Output Field | Output Field |
| Ack | ack |
| Build | No direct equivalent. |
| CategoryHistogram | 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. |
| ItemSearchURL | itemSearchURL |
| PageNumber | paginationOutput.pageNumber |
| SearchResult | searchResult [attribute count] |
| SearchResult.CategoryGroupIDPath | No direct equivalent. |
| SearchResult.CategoryGroupItemCount | No direct equivalent. |
| SearchResult.CategoryGroupNamePath | No direct equivalent. |
| SearchResult.ItemArray | No direct equivalent. |
| SearchResult.ItemArray.Item | searchResult.item |
| SearchResult.ItemArray.Item.AutoPay | searchResult.item.autoPay |
| SearchResult.ItemArray.Item.BestOfferEnabled | searchResult.item.listingInfo.bestOfferEnabled |
| SearchResult.ItemArray.Item.BidCount | searchResult.item.sellingStatus.bidCount |
| SearchResult.ItemArray.Item.BuyItNowAvailable | searchResult.item.listingInfo.buyItNowAvailable |
| SearchResult.ItemArray.Item.BuyItNowPrice [attribute currencyID] | searchResult.item.listingInfo.buyItNowPrice [attribute curencyId] |
| SearchResult.ItemArray.Item.Charity | No direct equivalent. |
| SearchResult.ItemArray.Item.Charity.CharityID | searchResult.item.charityId |
| SearchResult.ItemArray.Item.ConvertedBuyItNowPrice [attribute currencyID] | searchResult.item.listingInfo.convertedBuyItNowPrice [attribute currencyId] |
| SearchResult.ItemArray.Item.ConvertedCurrentPrice [attribute currencyID] | searchResult.item.sellingStatus.convertedCurrentPrice [attribute currencyId] |
| SearchResult.ItemArray.Item.Country | searchResult.item.country |
| SearchResult.ItemArray.Item.CurrentPrice [attribute currencyID] | searchResult.item.sellingStatus.currentPrice [attribute currencyId] |
| SearchResult.ItemArray.Item.DistanceFromBuyer | searchResult.item.distance [attribute unit] |
| SearchResult.ItemArray.Item.EndTime | searchResult.item.listingInfo.endTime |
| SearchResult.ItemArray.Item.GalleryURL | searchResult.item.galleryURL |
| SearchResult.ItemArray.Item.GermanMotorsSearchable | No direct equivalent. |
| SearchResult.ItemArray.Item.GetItFast | No direct equivalent. |
| SearchResult.ItemArray.Item.Gift | searchResult.item.listingInfo.gift |
| SearchResult.ItemArray.Item.IntegratedMerchantCreditCardEnabled | No direct equivalent. |
| SearchResult.ItemArray.Item.ItemID | searchResult.item.itemId |
| SearchResult.ItemArray.Item.ItemSpecifics | No direct equivalent. |
| SearchResult.ItemArray.Item.ItemSpecifics.NameValueList | No direct equivalent. |
| SearchResult.ItemArray.Item.ItemSpecifics.NameValueList.Name | No direct equivalent. |
| SearchResult.ItemArray.Item.ItemSpecifics.NameValueList.Value | No direct equivalent. |
| SearchResult.ItemArray.Item.ListingStatus | searchResult.item.sellingStatus.sellingState |
| SearchResult.ItemArray.Item.ListingType | searchResult.item.listingInfo.listingType |
| SearchResult.ItemArray.Item.Location | searchResult.item.location |
| SearchResult.ItemArray.Item.PaymentMethods | searchResult.item.paymentMethod |
| SearchResult.ItemArray.Item.PictureExists | No direct equivalent. |
| SearchResult.ItemArray.Item.PictureURL | No direct equivalent. |
| SearchResult.ItemArray.Item.PostalCode | searchResult.item.postalCode |
| SearchResult.ItemArray.Item.PrimaryCategoryID | searchResult.item.primaryCategory [attribute categoryId] |
| SearchResult.ItemArray.Item.PrimaryCategoryName | searchResult.item.primaryCategory.categoryName |
| SearchResult.ItemArray.Item.RecentListing | No direct equivalent. |
| SearchResult.ItemArray.Item.SecondaryCategoryID | searchResult.item.secondaryCategory [attribute categoryId] |
| SearchResult.ItemArray.Item.SecondaryCategoryName | searchResult.item.secondaryCategory.categoryName |
| SearchResult.ItemArray.Item.Seller | searchResult.item.sellerInfo |
| SearchResult.ItemArray.Item.Seller.FeedbackPrivate | No direct equivalent. |
| SearchResult.ItemArray.Item.Seller.FeedbackRatingStar | searchResult.item.sellerInfo.feedbackRatingStar |
| SearchResult.ItemArray.Item.Seller.FeedbackScore | searchResult.item.sellerInfo.feedbackScore |
| SearchResult.ItemArray.Item.Seller.PositiveFeedbackPercent | searchResult.item.sellerInfo.positiveFeedbackPercent |
| SearchResult.ItemArray.Item.Seller.UserID | searchResult.item.sellerInfo.sellerUserName |
| SearchResult.ItemArray.Item.ShippingCostSummary | searchResult.item.shipingInfo |
| SearchResult.ItemArray.Item.ShippingCostSummary.ListedShippingServiceCost [attribute currencyID] | No direct equivalent. |
| SearchResult.ItemArray.Item.ShippingCostSummary.ShippingServiceCost [attribute currencyID] | searchResult.item.shipingInfo.shippingServiceCost [attribute currencyId] |
| SearchResult.ItemArray.Item.ShippingCostSummary.ShippingType | searchResult.item.shipingInfo.shippingType |
| SearchResult.ItemArray.Item.ShipToLocations | searchResult.item.shipingInfo.shipToLocation |
| SearchResult.ItemArray.Item.Site | searchResult.item.globalId |
| SearchResult.ItemArray.Item.StartTime | searchResult.item.listingInfo.startTime |
| SearchResult.ItemArray.Item.Storefront | searchResult.item.storeInfo |
| SearchResult.ItemArray.Item.Storefront.StoreName | searchResult.item.storeInfo.storeName |
| SearchResult.ItemArray.Item.Storefront.StoreURL | searchResult.item.storeInfo.storeURL |
| SearchResult.ItemArray.Item.Subtitle | searchResult.item.subtitle |
| SearchResult.ItemArray.Item.TimeLeft | searchResult.item.sellingStatus.timeLeft |
| SearchResult.ItemArray.Item.Title | searchResult.item.title |
| SearchResult.ItemArray.Item.ViewItemURLForNaturalSearch | searchResult.item.viewItemURL |
| TotalInternationalExpansionItems | No direct equivalent. |
| TotalItems | paginationOutput.totalEntries |
| TotalPages | paginationOutput.totalPages |
| TotalStoreExpansionItems | No direct equivalent. |
| Timestamp | timestamp |
| Version | version |
This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.
Copyright © 2009–2013 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.