Inherits from Trading_AbstractRequestType : NSObject
Declared in Trading_GetCategoriesRequestType.h
Trading_GetCategoriesRequestType.m

Overview

Retrieves the latest eBay category hierarchy for a given eBay site.
Information returned for each category includes the category name
and the unique ID for the category (unique within the eBay site for which
categories are retrieved). A category ID is a required input when you list most items.

@ingroup EBayAPIInterface

Tasks

  •   categorySiteID

    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 from which you are
    submitting the request.




    NOTE: If you are using the GetCategories call with eBay Motors, you
    must set the Site ID in the Request Header to 0, and then set
    the CategorySiteID to 100. These are both required fields when
    using GetCategories with eBay Motors.

         property
  •   categoryParent

    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.

         property
  •   levelLimit

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

         property
  •   viewAllNodes

    This flag controls whether all eBay categories (that satisfy input filters) are
    returned, or only leaf categories (you can only list items in leaf categories)
    are returned. The default value is ‘true’, so if this field is omitted, all eBay
    categories will be returned. If you only want to retrieve leaf categories,
    include this flag and set it to ‘false’. The actual data returned will vary
    depending on how you configure other fields in the request.

         property

Properties

categoryParent

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.

@property (nonatomic, retain) NSMutableArray *categoryParent

Discussion

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.

entry type : NSString, wrapper for primitive string

Declared In

Trading_GetCategoriesRequestType.h

categorySiteID

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 from which you are
submitting the request.




NOTE: If you are using the GetCategories call with eBay Motors, you
must set the Site ID in the Request Header to 0, and then set
the CategorySiteID to 100. These are both required fields when
using GetCategories with eBay Motors.

@property (nonatomic, retain) NSString *categorySiteID

Discussion

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 from which you are
submitting the request.




NOTE: If you are using the GetCategories call with eBay Motors, you
must set the Site ID in the Request Header to 0, and then set
the CategorySiteID to 100. These are both required fields when
using GetCategories with eBay Motors.

type : NSString, wrapper for primitive string

Declared In

Trading_GetCategoriesRequestType.h

levelLimit

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

@property (nonatomic, retain) NSNumber *levelLimit

Discussion

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

type : NSNumber, wrapper for primitive int

Declared In

Trading_GetCategoriesRequestType.h

viewAllNodes

This flag controls whether all eBay categories (that satisfy input filters) are
returned, or only leaf categories (you can only list items in leaf categories)
are returned. The default value is ‘true’, so if this field is omitted, all eBay
categories will be returned. If you only want to retrieve leaf categories,
include this flag and set it to ‘false’. The actual data returned will vary
depending on how you configure other fields in the request.

@property (nonatomic, retain) NSNumber *viewAllNodes

Discussion

This flag controls whether all eBay categories (that satisfy input filters) are
returned, or only leaf categories (you can only list items in leaf categories)
are returned. The default value is ‘true’, so if this field is omitted, all eBay
categories will be returned. If you only want to retrieve leaf categories,
include this flag and set it to ‘false’. The actual data returned will vary
depending on how you configure other fields in the request.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetCategoriesRequestType.h