Trading_GetStoreRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_GetStoreRequestType.h Trading_GetStoreRequestType.m |
Overview
Retrieves configuration information for the eBay store owned by the specified
UserID, or by the caller.
@ingroup EBayAPIInterface
Tasks
-
categoryStructureOnly
If this is set to True, only the category structure of the store is
property
returned. If this is not specified or set to False, the complete store
configuration is returned. -
rootCategoryID
Specifies the category ID for the topmost category to return (along with
property
the subcategories under it, the value of the LevelLimit property
determining how deep). This tag is optional. If RootCategoryID is not
specified, then the category tree starting at that root Category is
returned. -
levelLimit
Specifies the limit for the number of levels of the category hierarchy
property
to return, where the given root category is level 1 and its children are
level 2. Only categories at or above the level specified are returned.
This tag is optional. If LevelLimit is not set, the complete category
hierarchy is returned. Stores support category hierarchies up to 3
levels only. -
userID
Specifies the user whose store data is to be returned. If not specified,
property
then the store returned is that for the requesting user.
Properties
categoryStructureOnly
If this is set to True, only the category structure of the store is
returned. If this is not specified or set to False, the complete store
configuration is returned.
@property (nonatomic, retain) NSNumber *categoryStructureOnly
Discussion
If this is set to True, only the category structure of the store is
returned. If this is not specified or set to False, the complete store
configuration is returned.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetStoreRequestType.h
levelLimit
Specifies the limit for the number of levels of the category hierarchy
to return, where the given root category is level 1 and its children are
level 2. Only categories at or above the level specified are returned.
This tag is optional. If LevelLimit is not set, the complete category
hierarchy is returned. Stores support category hierarchies up to 3
levels only.
@property (nonatomic, retain) NSNumber *levelLimit
Discussion
Specifies the limit for the number of levels of the category hierarchy
to return, where the given root category is level 1 and its children are
level 2. Only categories at or above the level specified are returned.
This tag is optional. If LevelLimit is not set, the complete category
hierarchy is returned. Stores support category hierarchies up to 3
levels only.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetStoreRequestType.h
rootCategoryID
Specifies the category ID for the topmost category to return (along with
the subcategories under it, the value of the LevelLimit property
determining how deep). This tag is optional. If RootCategoryID is not
specified, then the category tree starting at that root Category is
returned.
@property (nonatomic, retain) NSNumber *rootCategoryID
Discussion
Specifies the category ID for the topmost category to return (along with
the subcategories under it, the value of the LevelLimit property
determining how deep). This tag is optional. If RootCategoryID is not
specified, then the category tree starting at that root Category is
returned.
type : NSNumber, wrapper for primitive long
Declared In
Trading_GetStoreRequestType.h
userID
Specifies the user whose store data is to be returned. If not specified,
then the store returned is that for the requesting user.
@property (nonatomic, retain) NSString *userID
Discussion
Specifies the user whose store data is to be returned. If not specified,
then the store returned is that for the requesting user.
type : NSString, wrapper for primitive string
Declared In
Trading_GetStoreRequestType.h