ItemFilter

Reduce the number of items returned by a find request using itemFilters. Use the itemFilter container to specify itemFilter Name/Value pairs. You can include multiple itemFilters in a single request to refine your searches and to target specific items.

Types that use ItemFilter:

Calls that use one or more fields of ItemFilter:

Fields

name ( see ItemFilterType for possible values ) [1]
Specify the name of the item filter you want to use. The itemFilter name must have a corresponding value. You can apply multiple itemFilter Name/Value pairs in a single request. See the ItemFilterType type documentation for more information about the allowed values, usage rules, and dependencies.

Refer to the following samples to see itemFilters in action:
  Using itemFilters to define a price range
  Using itemFilters to search for used Buy It Now items
See the Field Index to learn which calls use name.

paramName ( token ) [0..1]
In addition to itemFilter Name/Value pairs, some itemFilters use an additional parameter Name/Value pair. Specifically, filters that use currency values (MaxPrice and MinPrice) make use of addition parameters. When you use these itemFilters, set paramName to Currency and provide the currency ID in paramValue.

For example, if you use the MaxPrice itemFilter, you will need to specify a parameter Name of Currency with a parameter Value that specifies the type of currency desired.

Note that for MaxPrice and MinPrice itemFilters, the default value for paramName is Currency.
See the Field Index to learn which calls use paramName.

paramValue ( string ) [0..1]
The currency value associated with the respective itemFilter parameter Name.

Usually paramName is set to Currency and paramValue is set to the currency type in which the monetary transaction occurs. For a list of possible currency enumeration values, see currencyId Values.

Note that for MaxPrice and MinPrice itemFilters, the default value for paramValue is USD.
See the Field Index to learn which calls use paramValue.

value ( string ) [1..*]
The value associated with the respective itemFilter Name.
See the Field Index to learn which calls use value.

Copyright © 2009–2012 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developer Network and API License Agreement.