CategoryType

Types that use CategoryType:

Calls that use one or more fields of CategoryType:

Fields

CategoryID ( string )
CategoryIDPath ( string )
CategoryLevel ( int )
CategoryName ( string )
CategoryNamePath ( string )
CategoryParentID ( string )
CategoryParentName ( string )
ItemCount ( int )
LeafCategory ( boolean )

CategoryID ( string ) [0..1]
The numeric ID of a category on eBay.

Use an ID of -1 to retrieve the root category and the top-level (level 1) meta categories. You can determine other CategoryIDs from the response from this call, or from a specific item (retrieved from another call like FindItemsAdvanced or GetSingleItem), or from the eBay website.
See the Field Index to learn which calls use CategoryID.

CategoryIDPath ( string ) [0..1]
The fully qualified category ID (e.g., 11700:20625:20635 for Home & Garden:Kitchen:Tools & Gadgets).
See the Field Index to learn which calls use CategoryIDPath.

CategoryLevel ( int ) [0..1]
The level where the category fits in the site's category hierarchy. For example, if this field has a value of 2, then the category is 2 levels below the root category.

Note that the value of CategoryLevel will always be 1 level below the level of the requested category. To retrieve a category's children, pass its CategoryID back into the request.

In the FindItemsAdvanced response, ItemCount indicates the total quantity of matching items in the category.

In the FindItemsAdvanced response, sibling categories (i.e., matching categories at the same level) are sorted by ItemCount, descending order.
See the Field Index to learn which calls use CategoryLevel.

CategoryName ( string ) [0..1]
Display name of the category as it would appear on the eBay Web site.
See the Field Index to learn which calls use CategoryName.

CategoryNamePath ( string ) [0..1]
The fully qualified category display name as it would appear on the eBay site (e.g., Home & Garden:Kitchen:Tools & Gadgets).
See the Field Index to learn which calls use CategoryNamePath.

CategoryParentID ( string ) [0..1]
Category ID identifying a category that is an ancestor of the category indicated in CategoryID.
See the Field Index to learn which calls use CategoryParentID.

CategoryParentName ( string ) [0..1]
Display name of the category indicated in CategoryParentID.
See the Field Index to learn which calls use CategoryParentName.

ItemCount ( int ) [0..1]
The total quantity of matching items in the category. In the FindItemsAdvanced response, matching categories at the same level (i.e., sibling categories) are sorted by ItemCount. That is, if the request specifies that fewer categories or subcategories should be returned, the ones with the most matching items are returned first.
See the Field Index to learn which calls use ItemCount.

LeafCategory ( boolean ) [0..1]
If true, indicates that the category indicated in CategoryID is a leaf category, in which items may be listed (if the category is not also expired or virtual).
See the Field Index to learn which calls use LeafCategory.

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

© 2005–2008 eBay, Inc. All rights reserved.