ItemFilterType ( string )
Values that can be used for the itemFilter.name field.

Types that use ItemFilterType:

Enumeration Values
Value Description Which calls use this value *
AvailableTo Limits items to those available to the specified country only. Item filter LocatedIn cannot be used together with item filter AvailableTo.

Allowed values (string):
Expects the two-letter ISO 3166 country code to indicate the country where the item is located. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site:
http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
Condition Limits items to those that have the matching item condition. Only one value can be specified.

Allowed values (string):
New
The seller specified the Item Condition as New, or did not specify a condition. (Excludes items that the seller listed as Used.)
Used
The seller specified the Item Condition as Used, or did not specify a condition. (Excludes items that the seller listed as New.)

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
Currency Limits results to items listed with the specified currency only.

Allowed values (string):
For a list of allowed currency values, see currencyId Values.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
EndTimeFrom Limits the results to items ending on or after the specified time. Specify a time in the past. Item filter EndTimeFrom cannot be used together with item filter EndTimeTo.

Allowed values (dateTime):
Specify the time in GMT.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
EndTimeTo Limits the results to items ending on or before the specified time. Specify a time in the future. Item filter EndTimeFrom cannot be used together with item filter EndTimeTo.

Allowed values (dateTime):
Specify the time in GMT.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
ExcludeAutoPay If true, excludes all items requiring immediate payment. Default is false.

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
ExcludeSeller Specify one or more seller names. Search results will not include items from the specified sellers. Item filter ExcludeSeller cannot be used together with item filter Seller.

Allowed values (string):
Valid seller names.

Note: Multiple values are allowed. Up to 100 sellers can be specified.

Example:
 ...
&itemFilter(0).name=ExcludeSeller
&itemFilter(0).value(0)=seller01
&itemFilter(0).value(1)=seller02
&itemFilter(0).value(2)=seller03
...
findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
FeaturedOnly If true, search results will Return featured item listings only. Default is false.

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
FeedbackScoreMax Specifies the maximum feedback score of a seller whose items can be included in the response. If FeedbackScoreMin is also specified, the FeedbackScoreMax value must be greater than or equal to the FeedbackScoreMin value.

Allowed values (int):
Integer greater than or equal to 0.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
FeedbackScoreMin Specifies the mininum feedback score of a seller whose items can be included in the response. If FeedbackScoreMax is also specified, the FeedbackScoreMax value must be greater than or equal to the FeedbackScoreMin value.

Allowed values (int):
Integer greater than or equal to 0.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
FreeShippingOnly If true, the search results are limited to only items with free shipping to the site specified in the request (see Global ID Values). Default is false.

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
GetItFastOnly If true, the search results are limited to only Get It Fast listings. Default is false.

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
HideDuplicateItems If true, and there are duplicate items for an item in the search results, the subsequent duplicates will not appear in the results. Default is false.
Item listings are considered duplicates when all of the ollowing conditions are met:
1. Items are listed by the same seller
2. Items have exactly the same item title
3. Items have similar listing formats:
    - Auctions (Auction Items, Auction BIN items, Multi-Quantity Auctions, and Multi-Quantity Auctions BIN items)
    - Fixed Price (Fixed Price, Multi-quantity Fixed Price, Fixed Price with Best Offer, and Store Inventory Format items)
    - Classified Ads

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.

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
ListingType Filters items based listing type information. Default behavior is to return all matching items, except Store Inventory format listings.

Allowed values (string):
AdFormat
Retrieve matching Ad Format listings only.
Auction
Retrieve matching auction listings (i.e., listings eligible for competitive bidding at auction) only. Excludes auction items with Buy It Now.
AuctionWithBIN
Retrieve all matching auction listings, including auction items with Buy It Now.
Classified
Retrieves Classified Ad format listings only.
FixedPrice
Retrieve matching fixed price items only. Excludes Store Inventory format items.
StoreInventory
Retrieve Store Inventory format items only.
All
Retrieve matching items for any listing type.

Note: Multiple listing type values can be specified for this filter.

Example:
 ...
&itemFilter(0).name=ListingType
&itemFilter(0).value(0)=AuctionWithBIN
&itemFilter(0).value(1)=FixedPrice
&itemFilter(0).value(2)=StoreInventory
...

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
LocalPickupOnly If true, the search results are limited to only items which have local pickup available. Default is false.

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
LocalSearchOnly If true, returns only matching items with the Local Inventory Listing Options (LILO). Must be used together with the MaxDistance item filter, and the request must also specify buyerPostalCode. Currently, this is only available for the Motors site (global ID EBAY-MOTOR).

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
LocatedIn Limits the result set to just those items located in the specified country. Item filter AvailableTo cannot be used together with item filter LocatedIn.

Allowed values (string):
Expects the two-letter ISO 3166 country code to indicate the country where the item is located. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site:
http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
LotsOnly If true, returns only matching listings for which the lot size is 2 or more. Default is false.

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
MaxBids Limits the results to items with bid counts less than or equal to the specified value. If MinBids is also specified, the MaxBids value must be greater than or equal to the MinBids value.

Allowed values (int):
Integer greater than or equal to 0.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
MaxDistance Specifies the maximum distance from the specified postal code (buyerPostalCode) to search for items. Must be used together with the LocalSearchOnly item filter, and the request must also specify buyerPostalCode. Currently, this is only available for the Motors site (global ID EBAY-MOTOR).

Allowed values (int):
Integer greater than or equal to 0 and less than 3000.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
MaxPrice Specifies the maximum current price an item can have to be included in the response. Optionally, you can also specify a currency ID, using the paramName and paramValue fields (e.g., ¶mName=Currency¶mValue=EUR). If using with MinPrice to specify a price range, the MaxPrice value must be greater than or equal to MinPrice.

Allowed values (decimal):
Decimal values greater than or equal to 0.0.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
MaxQuantity Limits the results to listings with a quantity less than or equal to the specified value. If MinQuantity is also specified, the MaxQuantity value must be greater than or equal to the MinQuantity value.

Allowed values (int):
Integer greater than or equal to 1.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
MinBids Limits the results to items with bid counts greater than or equal to the specified value. If MaxBids is also specified, the MaxBids value must be greater than or equal to the MinBids value.

Allowed values (int):
Integer greater than or equal to 0.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
MinPrice Specifies the minimum current price an item can have to be included in the response. Optionally, you can also specify a currency ID, using the paramName and paramValue fields (e.g., ¶mName=Currency¶mValue=EUR). If using with MaxPrice to specify a price range, the MaxPrice value must be greater than or equal to MinPrice.

Allowed values (decimal):
Decimal values greater than or equal to 0.0.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
MinQuantity Limits the results to listings with a quantity greater than or equal to the specified value. If MaxQuantity is also specified, the MaxQuantity value must be greater than or equal to the MinQuantity value.

Allowed values (int):
Integer greater than or equal to 1.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
PaymentMethod Limits results to items that accept the specified payment method.

Allowed values (string):
PayPal
PayPal payment method.
PaisaPay
PaisaPay payment method. The PaisaPay payment method is only for the India site (global ID EBAY-IN).
PaisaPayEMI
PaisaPayEscrow EMI (Equal Monthly Installment) payment method. The PaisaPayEscrowEMI payment method is only for the India site (global ID EBAY-IN).

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
Seller Specify one or more seller names. Search results will include items from the specified sellers only. Item filter ExcludeSeller cannot be used together with item filter Seller.

Allowed values (string):
Valid seller names.

Note: Multiple values are allowed. Up to 100 sellers can be specified.

Example:
 ...
&itemFilter(0).name=Seller
&itemFilter(0).value(0)=seller01
&itemFilter(0).value(1)=seller02
&itemFilter(0).value(2)=seller03
...
findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
SellerBusinessType Restricts the items to those that are from sellers whose business type is the specified value Limits items to those that have the matching item condition. Only one value can be specified.
This filter is applicable to UK, France, and Germany only. If the filter is used for any other site, an error is returned.
Allowed values (string):
Commercial
The seller is registered as a business on eBay.
Private
The seller is registered as an individual on eBay.

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
TopRatedSellerOnly If true, returns only matching items where the seller qualifies as a top-rated seller on the specified site. Site is specified with the global ID header or URL parameter. The default global ID value is EBAY-US (the eBay US site). Default for this filter is false.

The TopRatedSellerOnly item filter is supported for the following sites only: US (EBAY-US), Motors (EBAY-MOTOR), UK (EBAY-GB), IE (EBAY-IE), DE (EBAY-DE), AT (EBAY-AT), and CH (EBAY-CH).

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
WorldOfGoodOnly If true, returns only items listed in the World of Good marketplace. Defaults to false.

Allowed values (boolean):
true, false

findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
  * See the Enumeration Index to see exact use of each enumeration value in the API.

This document was generated with a customized version of the apireferencedocs tool.

© 2009 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.