RequestCategoriesType
A set of parameters that control the retrieval of categories (not items) that match a search query. In GetSearchResults, at least one child element must be specified in order to retrieve matching categories. If empty or not present, no matching category information is returned.

Types that use RequestCategoriesType:

Call that uses one or more fields of RequestCategoriesType:

Fields

CategoriesOnly ( boolean ) [0..1]
Filter to retrieve matching categories but not matching items or buying guides. If true, only matching categories are returned (with no item or buying guide details). If false or not present, matching items and matching categories are both returned, along with buying guide details (if any). If TotalOnly and Categories.CategoriesOnly are both specified in the request and their values are inconsistent with each other, TotalOnly overrides Categories.CategoriesOnly. That is, if TotalOnly is true and Categories.CategoriesOnly is false, the results include matching categories but no item data or buying guides. If TotalOnly is false and Categories.CategoriesOnly is true, the results include matching categories, item data, and buying guides.
See the Field Index to learn which calls use CategoriesOnly.

DemandData ( boolean ) [0..1]
If you specify that DemandData is true, then the categories returned will be sorted based on Best Match. The most relevant categories will be returned first.
See the Field Index to learn which calls use DemandData.

Levels ( int ) [0..1]
Filter to control the deepest matching category level to return. If you specify 0, no category data is returned. If you specify a negative number, the results are unpredictable.
See the Field Index to learn which calls use Levels.

MaxCategories ( int ) [0..1]
Maximum quantity of matching categories to return at the first level of the category hierarchy (CategoryLevel 1).
See the Field Index to learn which calls use MaxCategories.

MaxSubcategories ( int ) [0..1]
Maximum quantity of matching subcategories to return at each lower level of the hierarchy.
See the Field Index to learn which calls use MaxSubcategories.

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

© 2005–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.