eBay Shopping APIVersion 1145

CategoryType

This type is used by each eBay category that is returned in the response of the GetCategoryInfo call. This type is used by the Category container, and consists of high-level details of a category, including its category ID value and information on its parent category, child categories, and its level in the eBay site's category hierarchy.

Type that uses CategoryType:

Call that uses CategoryType:

Fields



CategoryID ( string ) [0..1]
The numeric identifier of a category on an eBay marketplace. For the root category of an eBay marketplace, the value will be -1.

This field is always returned with each Category container.
See the Field Index to learn which calls use CategoryID.

CategoryIDPath ( string ) [0..1]
The eBay category ID path for the eBay category, including the category ID for the corresponding category and the category IDs for all ancestor categories, all the way to the top-level (category Level 1) eBay category. Each eBay category ID is separated with a colon (:). An example is shown below:

<CategoryIDPath>11450:1059:185100:15687</CategoryIDPath>

This field is always returned for any eBay category, but is not returned for the root (Level 0) of an eBay marketplace.
See the Field Index to learn which calls use CategoryIDPath.

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

This field is always returned with each Category container.
See the Field Index to learn which calls use CategoryLevel.

CategoryName ( string ) [0..1]
The display name of the category as it would appear on the eBay marketplace. For the root category of an eBay marketplace, the value will be Root.

This field is always returned with each Category container.
See the Field Index to learn which calls use CategoryName.

CategoryNamePath ( string ) [0..1]
The fully-qualified category name path for the eBay category, including the display name for the category and the display name for all ancestor categories, all the way to the top-level (category Level 1) eBay category. Each eBay category name is separated with a colon (:). An example is shown below:

<CategoryNamePath>Clothing, Shoes & Accessories:Men's Clothing:Shirts:T-Shirts</CategoryNamePath>

This field is always returned for any eBay category, but is not returned for the root (Level 0) of an eBay marketplace.
See the Field Index to learn which calls use CategoryNamePath.

CategoryParentID ( string ) [0..1]
The unique identifier of the category's parent category. Note that -1 is returned for Level 1 categories, and 0 is returned for the root category of an eBay marketplace.

This field is always returned with each Category container.
See the Field Index to learn which calls use CategoryParentID.

CategoryParentName ( string ) [0..1]
Not used by any call.

This field is deprecated. Instead, the name of the category's parent category can be derived from the CategoryNamePath field
See the Field Index to learn which calls use CategoryParentName.

ItemCount ( int ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use ItemCount.

LeafCategory ( boolean ) [0..1]
This boolean field indicates if the corresponding category is a leaf category. eBay listings can only be created in leaf categories. If the value is true, the eBay category is a leaf category.

This field is always returned with each Category container.
See the Field Index to learn which calls use LeafCategory.