/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::Call::GetCategories::GetCategoriesRequestType

NAME

eBay::API::XML::Call::GetCategories::GetCategoriesRequestType

DESCRIPTION

Retrieves the latest category hierarchy available on a given site. (By default, this is the site to which you submit the request.) You can retrieve all categories on the site, or you can use CategoryParent to retrieve one particular category and its subcategories.<br> <br> For each category, the call returns the category name, its unique ID (within the site to which you sent the request), and meta-data that helps you determine where the category fits in the hierarchy. eBay requires sellers to specify a category ID for most new listings. You can only list in leaf categories.<br> <br> The call also identifies a few eBay features that are only supported in some categories. For example, some categories support immediate payment (AutoPay), and some categories don't. For information about additional features that vary by category, use GetCategoryFeatures and/or GetCategory2CS.<br> <br> The API provides other calls that supplement GetCategories. For example, consider using GetSuggestedCategories to help the seller choose a category ID. In certain cases, it may be helpful to use GetCategoryMappings to update locally stored item data (although most applications can use the simpler CategoryMappingAllowed flag in AddItem for this purpose).

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::GetCategories::GetCategoriesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

setCategoryParent()

Specifies the ID of the highest-level category to return, along with its subcategories. If no parent category is specified, all categories are returned for the specified site. (Please do not pass a value of 0; zero (0) is an invalid value for CategoryParent.) To determine available category IDs, call GetCategories with no filters and use a DetailLevel value of ReturnAll. If you specify multiple parent categories, the hierarchy for each one is returned.

RequiredInput: No
Default: 
#    Argument: reference to an array  
                    of 'xs:string'

getCategoryParent()

# Returns: reference to an array of 'xs:string'

setCategorySiteID()

Specifies the eBay site for which to retrieve the category hierarchy. Use the numeric site code (e.g., 77 for eBay Germany). Only necessary if you want to retrieve category data for a site other than the site to which you are submitting the request.

RequiredInput: No
Default: The site ID of the request
#    Argument: 'xs:string'

getCategorySiteID()

# Returns: 'xs:string'

setLevelLimit()

Specifies the maximum depth of the category hierarchy to retrieve, where the top-level categories (meta-categories) are at level 1. Retrieves all category nodes with a category level less than or equal to this value. If not specified, retrieves categories at all applicable levels. As with all calls, the actual data returned will vary depending on how you configure other fields in the request (including DetailLevel).

RequiredInput: No
Default: 0
#    Argument: 'xs:int'

getLevelLimit()

# Returns: 'xs:int'

setViewAllNodes()

If false or omitted, retrieves only leaf categories. (You can only list in leaf categories.) If true, retrieves both leaf and internal (non-leaf) categories. As with all calls, the actual data returned will vary depending on how you configure other fields in the request.

RequiredInput: No
Default: false
#    Argument: 'xs:boolean'

isViewAllNodes()

# Returns: 'xs:boolean'