Class CategoryType

class CategoryType
Contains details about a category.

Defined in com/ebay/shoppingservice/CategoryType.js

Property Summary
String categoryID
The numeric ID of a category on eBay.
String categoryIDPath
The fully qualified category ID (e.g., 11700:20625:20635 for Home & Garden:Kitchen:Tools & Gadgets).
Number categoryLevel
The level where the category fits in the site's category hierarchy.
String categoryName
Display name of the category as it would appear on the eBay Web site.
String categoryNamePath
The fully qualified category display name as it would appear on the eBay site (e.g., Home & Garden:Kitchen:Tools & Gadgets).
String categoryParentID
Category ID identifying a category that is an ancestor of the category indicated in CategoryID.
String categoryParentName
Display name of the category indicated in CategoryParentID.
Number itemCount
The total quantity of matching items in the category.
Boolean leafCategory
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).

Constructor Summary
CategoryType(Object props)

Property Details

property String categoryID

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.

property String categoryIDPath

The fully qualified category ID (e.g., 11700:20625:20635 for Home & Garden:Kitchen:Tools & Gadgets).

property Number categoryLevel

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.

property String categoryName

Display name of the category as it would appear on the eBay Web site.

property String categoryNamePath

The fully qualified category display name as it would appear on the eBay site (e.g., Home & Garden:Kitchen:Tools & Gadgets).

property String categoryParentID

Category ID identifying a category that is an ancestor of the category indicated in CategoryID.

property String categoryParentName

Display name of the category indicated in CategoryParentID.

property Number itemCount

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.

property Boolean leafCategory

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).

Constructor Details

constructor CategoryType

CategoryType(Object props)

Parameters:
props