Skip to main content

Item Filters are constraints applied to search queries, category browsing, or eBay store browsing. Filters provide better control over the search results by narrowing the range of items returned. The itemFilter node contains name/value pairs to describe specific filters. Item filters are optional input parameters.

<itemFilter>
  <Name/>
  <Value/>
</itemfilter>

In the following example, all items with free shipping are returned in the results:

<itemFilter>
  <Name>FreeShippingOnly</Name>
  <Value>true</Value>
</itemfilter>

When using the name/value pairs in the URL message format, an array notation is required for multiple filters, as shown in the following example (line breaks added for readability):

...
&itemFilter(0).name=Condition
&itemFilter(0).value=New
&itemFilter(1).name=MaxPrice
&itemFilter(1).value=50.0
&itemFilter(1).paramName=Currency
&itemFilter(1).paramValue=USD
...

Filters with Multiple Values

Some item filters can support multiple values. The search query applies an OR logic between the filter's multiple values. That is, items matching either criterion will be returned. Not all filters support multiple values. Specifying multiple values for a filter that does not support them returns an error.

The following filter results in items with either of the specified listing types being returned:

...
<itemFilter>
  <Name>ListingType</Name>
  <Value>FixedPrice</Value>
  <Value>AuctionWithBIN</Value>
</itemFilter>
...

When using the name/value pairs in the URL message format, an array notation is required for multiple filter values, as shown in the following example (line breaks added for readability):

...
&itemFilter(0).name=ListingType
&itemFilter(0).value(0)=FixedPrice
&itemFilter(0).value(1)=AuctionWithBIN
...

For a full list of Item Filter values, see the ItemFilterType definition.

Got thoughts? Click the feedback button – your insights help us improve!