Class FindItemsRequestType

Extends AbstractRequestType

class FindItemsRequestType
Searches for items based on a query or seller ID. If you use keywords, this call returns items that contain the keywords in the title. A maximum of 50 items is returned.

If you are not using the BestMatch search option, the API search results may not match the search results returned by the eBay website. Summary: Searches for items based on a query or a seller ID. If you use keywords, this call returns items that contain the keywords in the title. A maximum of 50 items is returned. RelatedCalls: FindItemsAdvanced, GetSingleItem, GetItemStatus, GetShippingCosts

Defined in com/ebay/shoppingservice/FindItemsRequestType.js

Property Summary
Specifies whether or not to remove duplicate items from search results.
Sorts search results based on the value you specify.
Number maxEntries
Specifies the maximum number of entries to return in a single call.
String postalCode
Specifies the postal code where the buyer is located.
A query that specifies a string for searching titles of items on eBay.
Array sellerID
The ID of a specific seller.
Specify this value if you want search results to be filtered so that the items returned do not include items sold by a specific seller or by specific sellers.
Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort.

Properties inherited from AbstractRequestType
messageID

Constructor Summary
FindItemsRequestType(Object props)

Property Details

property Boolean hideDuplicateItems

Specifies whether or not to remove duplicate items from search results. When set to true, and there are duplicate items for an item in the search results, the subsequent duplicates will not appear in the results. Item listings are considered duplicates in the following conditions:

For Auctions, items must also have the same price and number of bids to be considered duplicates.
Filtering of duplicate item listings is not supported on all sites.


property SimpleItemSortCodeType itemSort

Sorts search results based on the value you specify. See the SortOrder field for values that specify whether results are returned in ascending or descending order. (By default, results are returned in descending order.)


property Number maxEntries

Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value you specify, the lower number is returned.


property String postalCode

Specifies the postal code where the buyer is located.


property String queryKeywords

A query that specifies a string for searching titles of items on eBay. If you are using a URL, then to search for multiple words, use "%20". For example, use Harry%20Potter to search for items containing those words in any order. You can incorporate wildcards into a multi-word search, as in the following: ap*%20ip*. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. FindItems requires that you specify either QueryKeywords, SellerID, or both.


property Array sellerID

The ID of a specific seller. Specify this value if you want search results to be filtered so that the items returned are only items sold by a specific seller or by specific sellers. SellerID is an unbounded field. If you are using a URL, and you want to specify multiple values, use a comma. For example, to specify FavSellerBlue and FavSellerGreen, specify SellerID=FavSellerBlue,FavSellerGreen. The value you specify in SellerID is ignored if it is invalid. You can specify a maximum of 100 sellers.


property Array sellerIDExclude

Specify this value if you want search results to be filtered so that the items returned do not include items sold by a specific seller or by specific sellers. The SellerIDExclude input field need not be used if you specified the SellerID input field. SellerIDExclude is an unbounded field. If you are using a URL, and you want to specify multiple values, use a comma. For example, if you want to specify FavSellerBlue and FavSellerGreen, specify SellerIDExclude=FavSellerBlue,FavSellerGreen. You can specify a maximum of 100 sellers.


property SortOrderCodeType sortOrder

Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort. The default is descending order. For example, in the case of the (default) ItemSort value of BestMatch, the most relevant items are returned first, because the default SortOrder value is Descending. If you specify an ItemSort value of EndTime (to sort items by end time), and a SortOrder value of Ascending, then items ending in less time (from the time of the call) are returned before items ending in more time.


Constructor Details

constructor FindItemsRequestType

FindItemsRequestType(Object props)

Parameters:
props