ItemFilter

Reduce the number of items returned by a request using itemFilters. Use the itemFilter container to specify itemFilter Name/Value pairs.

Types that use ItemFilter:

Calls that use ItemFilter:

Fields

name ( ItemFilterType ) [1]

Name of the item filter from the set of allowed filters. The Merchandising API supports a World of Good item filter only.

See the Field Index to learn which calls use name.

paramName ( token ) [0..1]

In addition to filter Name/Value pairs, some item filters use an additional parameter Name/Value pair.

For example, if you use the WorldOfGoodOnly item filter, you can optionally specify a parameter name of WOGCategory with a parameter value that specifies the World of Good category. This restricts the item recommendations to items available in the specified World of Good category only.

Note: To locate a specific World of Good category, go to the worldofgood.ebay.com home page. Top-level categories are listed under Shop by Category on the left-hand side of the page. Click the category you want to use to restrict your search results. The resultant URL contains the category ID as a numeric value, appearing before "/list" at the end of the URL (e.g., http://worldofgood.ebay.com/Belts-Hats-Scarves-Shawls/40/list). If a category has children categories, they will be displayed under the Category on the left-hand side of the page. The numeric category ID can be determined from the URL for child categories in the same fashion.

See the Field Index to learn which calls use paramName.

paramValue ( string ) [0..1]

The value for the parameter name used in an item filter.

For example, if your item filter is WorldOfGoodOnly (true), you can further restrict the item recommendations in the response to items available in a specific World of Good category. In this case, the paramter name is set to WOGCategory and the parameter values is a numeric World of Good category ID.

See the Field Index to learn which calls use paramValue.

value ( string ) [1..*]

The value associated with the respective item filter name.

See the Field Index to learn which calls use value.