This doc page has moved! You should be automatically redirected to the resources page for the eBay Browse API. If you are not redirected automatically, follow this link to the Browse API.

eBay Browse API

Search for Items Call Filter Usage Details

The following table lists the filter types (in alphabetical order), explains how to use the filter and its syntax.

Filter name Syntax Description
buyingOptions filter=buyingOptions:{FIXED_PRICE} Only items using the specified buying formats are returned. Multiple values can be used for this filter and are separated by the pipe symbol - '|'.

Valid Values:
  • FIXED_PRICE    (basic fixed-price and auctions with the Buy It Now feature)
  • AUCTION    (auctions without the Buy It Now feature)
conditionIds filter=conditionIds:{1000|1500} Only items with the specified condition Id are returned. For more information on item conditions for some popular eBay categories, see the Item Condition IDs and Names. Multiple values can be used for this filter and are separated by the pipe symbol - '|'.
conditions filter=conditions:{NEW} Only items in the specified conditions are returned. Item condition values can vary by category. For more information on item conditions for some popular eBay categories, see the Item conditions by category help topic. Multiple values can be used for this filter and are separated by the pipe symbol - '|'.

Valid Values:
  • NEW
  • USED
  • UNSPECIFIED
deliveryCountry filter=deliveryCountry:US Only items that can be shipped to the specified country are returned.

Restriction: This filter is ignored when used with the pickupCountry, pickupPostalCode, pickupRadius, and pickupRadiusUnit filters.

Valid Values: Two-digit Country Codes (ISO 3166 standard)
deliveryOptions filter=deliveryOptions:{SELLER_ARRANGED_LOCAL_PICKUP} Only local pickup items are returned.

Requirement: This filter must be used along with the pickupCountry, pickupPostalCode, pickupRadius, and pickupRadiusUnit filters.

Valid Values:
  • SELLER_ARRANGED_LOCAL_PICKUP
deliveryPostalCode filter=deliveryPostalCode:95125 Only items that can be shipped to the specified postal/zip code are returned.

Requirement: This filter must be used along with the deliveryCountry filter.

Restriction: This filter is ignored when used with the pickupCountry, pickupPostalCode, pickupRadius, and pickupRadiusUnit filters.
excludeSellers filter=excludeSellers:{rpsseller|bigSales} Any items from the specified sellers are not returned in the response. Multiple values can be used for this filter and are separated by the pipe symbol - '|'.

Valid Values: The sellers' eBay user ID.
excludeCategoryIds filter=excludeCategoryIds:{15032|31387} Any item in the specified categories will not be returned. Multiple values can be used for this filter and are separated by the pipe symbol - '|'

Valid Values: eBay category Ids
itemEndDate filter=itemEndDate:[2016-11-14T07:47:48Z.. 2016-12-14T07:47:48Z] Only items scheduled to end within the specified date-time range are returned. The first date-time value is the start of the range and the second date-time value is the end of the range. The start and end range value are separated by two dots ('..').

It is possible to only use a start range value or only use an end range value. If only a start range value is used, every listing ending after that is returned. If only a end range value is used, every listing ending before that is returned.
  • If only specifying a start range value, the two dots ('..') are not needed (e.g. filter=itemEndDate:[2016-11-14T07:47:48Z])).
  • If only specifying the end range value, the two dots ('..') are required before the end range value (e.g. filter=itemEndDate:[..2016-12-14T07:47:48Z]).
Valid Values: UTC Format (ISO 8601 standard)
itemStartDate filter=itemStartDate:[2016-11-14T07:47:48Z.. 2016-12-14T07:47:48Z] Only items scheduled to start within the specified date-time range are returned. The first date-time value is the start of the range and the second date-time value is the end of the range. The start and end range value are separated by two dots ('..').

It is possible to only use a start range value or only use an end range value. If only a start range value is used, every listing starting after that is returned. If only a end range value is used, every listing starting before that is returned.
  • If only specifying a start range value, the two dots ('..') are not needed (e.g. filter=itemEndDate:[2016-11-14T07:47:48Z])).
  • If only specifying the end range value, the two dots ('..') are required before the end range value (e.g. filter=itemEndDate:[..2016-12-14T07:47:48Z]).
Valid Values: UTC Format (ISO 8601 standard)
itemLocationCountry filter=itemLocationCountry:US Only items located in the specified country are returned.

Restrictions: Valid Values: Two-digit Country Codes (ISO 3166 standard)
maxDeliveryCost filter=maxDeliveryCost:0 Only items with free shipping are returned. Note: The only value supported is zero.
paymentMethods filter=paymentMethods:{CREDIT_CARD} Only items that offer payment by credit card are returned. Currently, only CREDIT_CARD is supported.
pickupCountry filter=pickupCountry:US This filter, along with the three other pickup filters, sets the local pickup radius. Only items that are available through local pickup and within the pickup radius set by the user are retrieved.

Requirement: The call must include all the pickup filters (pickupCountry, pickupPostalCode, pickupRadius, and pickupRadiusUnit) and the deliveryOptions filter.

Valid Values: Two-digit Country Codes (ISO 3166 standard)
pickupPostalCode filter=pickupPostalCode:95125 This filter, along with the three other pickup filters, sets the local pickup radius. Only items that are available through local pickup and within the pickup radius set by the user are retrieved. The pickupPostalCode value is generally the postal code of the buyer's address.

Requirement: The call must include all the pickup filters (pickupCountry, pickupPostalCode, pickupRadius, and pickupRadiusUnit) and the deliveryOptions filter.
pickupRadius filter=pickupRadius:25 This filter, along with the three other pickup filters, sets the local pickup radius. Only items that are available through local pickup and within the pickup radius set by the user are retrieved. The pickupRadius value defines the distance that the buyer is willing to travel (in miles or km) from the postal code defined in the pickupPostalCode filter to pick up the item.

Requirement: The call must include all the pickup filters (pickupCountry, pickupPostalCode, pickupRadius, and pickupRadiusUnit) and the deliveryOptions filter.
pickupRadiusUnit filter=pickupRadiusUnit:mi This filter, along with the three other pickup filters, sets the local pickup radius. Only items that are available through local pickup and within the pickup radius set by the user are retrieved. The pickupRadiusUnit defines the distance measurement unit used for the pickup radius.

Requirement: The call must include all the pickup filters (pickupCountry, pickupPostalCode, pickupRadius, and pickupRadiusUnit) and the deliveryOptions filter.

Valid Values:
  • mi
  • km
price filter=price:[10..50] Only items with prices within the specified price range are returned. This filter supports double data type values. The first double value is the lower monetary value and the second double value is the higher monetary value.

If the filter in the example was actually used, only items priced from $10.00 to $50.00 would be returned. The lower and higher monetary value are separated by two dots ('..'). It is possible to only use a lower monetary value or only use a higher monetary value. If only a lower monetary value is used, every item priced at or above that price is returned. If only a higher monetary value is used, every item priced below or at that price is returned.
  • If only specifying a lower monetary value, the two dots ('..') are not needed (e.g. filter=price:[10]).
  • If only specifying a higher monetary value, the two dots ('..') are required before the higher monetary value (e.g. filter=price:[..50]).
Requirement: This filter must be used along with the priceCurrency filter.
priceCurrency filter=priceCurrency:USD Assigns the currency tied to the price. The three-digit Currency codes - ISO 4217 standard is used.

Restriction: This filter is only needed if the price (range) filter is used.
returnsAccepted filter=returnsAccepted:true When set to "true", only items that can be returned to the seller are included in the results. If this is null, items are returned regardless of the seller's return policy.

Valid Values: true
sellerAccountTypes filter=sellerAccountTypes:{INDIVIDUAL}
  or
filter=sellerAccountTypes:{BUSINESS}
Only items from the specified seller account type are returned in the response. The seller account type indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, they have a business account. If they register for a private account, they have an individual account. This designation is required by the tax laws in some countries.

This filter is supported on the following sites.
EBAY_AT (Austria)
EBAY_BE (Belgium)
EBAY_CH (Switzerland)
EBAY_DE (Germany)
EBAY_ES (Spain)
EBAY_FR (France)
EBAY_GB (Great Britain)
EBAY_IE (Ireland)
EBAY_IT (Italy)
EBAY_PL (Poland)


Restriction: You can filter by either BUSINESS or INDIVIDUAL. But you cannot filter by both.

Valid Values:
  • BUSINESS
  • INDIVIDUAL
sellers filter=sellers:{rpsseller|bigSales} Only items from the specified sellers are returned in the response. Multiple values can be used for this filter and are separated by the pipe symbol '|'.

Valid Values: The sellers' eBay user ID.