Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:GetCategoriesRequestType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 14 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 4 elements
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:DetailLevel*, ns:ErrorLanguage?, ns:MessageID?, ns:Version?, ns:EndUserIP?, ns:ErrorHandling?, ns:InvocationID?, ns:OutputSelector*, ns:WarningLevel?, ns:BotBlock?, {any}*, ns:CategorySiteID?, ns:CategoryParent*, ns:LevelLimit?, ns:ViewAllNodes?
</...>
All Direct / Indirect Based Elements (1):
ns:GetCategoriesRequest
Known Usage Locations
Annotation
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.
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:GetCategoriesRequestType
XML Source (w/o annotations (5); see within schema source)
<xs:complexType name="GetCategoriesRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<xs:sequence>
<xs:element minOccurs="0" name="CategorySiteID" type="xs:string"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="CategoryParent" type="xs:string"/>
<xs:element minOccurs="0" name="LevelLimit" type="xs:int"/>
<xs:element minOccurs="0" name="ViewAllNodes" type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 4/15)
ns:CategoryParent
Type:
xs:string, predefined, simple content
This field is used if the user wishes to retrieve category hierarchy information on one or more specific eBay categories, and optionally, one or more levels of each category's children (if a category has one or more levels of children). For example, if you wanted to view the entire category hierarchy under the Home & Garden L1 category, you would include this field and set its value to 11700. As long as the LevelLimit field is omitted, all of Home & Garden's child categories are returned. If you only wanted to see the next level (L2s) of Home & Garden categories, you would include the LevelLimit field and set its value to 2, allowing the L1 category (Home & Garden) and all of its L2 categories to appear in the response.

If you wanted to see all of the Category IDs for the eBay site's L1 categories, you could omit the CategoryParent field but include the LevelLimit field and set its value to 1.

Note: Numerous Category IDs may be specified under multiple CategoryParent fields in a GetCategories request, but if multiple CategoryParent fields are used, the specified Category IDs should all be at the same level (L1, L2, L3, etc.).
XML Representation Summary
<ns:CategoryParent>
   
Content: 
{ xs:string }
</ns:CategoryParent>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="CategoryParent" type="xs:string"/>
ns:CategorySiteID
Type:
xs:string, predefined, simple content
This field is used if the user wants to retrieve category data for another eBay site (other than the one specified in the X-EBAY-API-SITEID request header).

If the user wishes to retrieve category data for the US eBay Motors site, the user must set the Site ID in the X-EBAY-API-SITEID request header to 0, and then set this field's value to 100.
XML Representation Summary
<ns:CategorySiteID>
   
Content: 
{ xs:string }
</ns:CategorySiteID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CategorySiteID" type="xs:string"/>
ns:LevelLimit
Type:
xs:int, predefined, simple content
This field is used if the user wants to control the maximum depth of the category hierarchy to retrieve, or in other words, how many levels of eBay categories that are returned in the response. If this field is omitted, every eBay category from the root on down will be returned, or, if a CategoryParent category is specified, the specified category and all of its children (down to the leaf categories) are returned.

If the CategoryParent is not used, but the LevelLimit field is used and set to 1, only the top-level categories (also known as L1 categories) are returned in the response.
XML Representation Summary
<ns:LevelLimit>
   
Content: 
{ xs:int }
</ns:LevelLimit>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="LevelLimit" type="xs:int"/>
ns:ViewAllNodes
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:ViewAllNodes>
   
Content: 
{ xs:boolean }
</ns:ViewAllNodes>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ViewAllNodes" type="xs:boolean"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.