Skip to main content

GET/category_tree/{category_tree_id}/get_category_subtree

This call retrieves the details of all nodes of the category tree hierarchy (the subtree) below a specified category of a category tree. You identify the tree using the category_tree_id parameter, which was returned by the getDefaultCategoryTreeId call in the categoryTreeId field.

Note: This method can return a very large payload, so gzip compression is supported. To enable gzip compression, include the Accept-Encoding header and set its value to gzip as shown below:

  Accept-Encoding: gzip

Input

Resource URI

GET https://api.ebay.com/commerce/taxonomy/v1/category_tree/{category_tree_id}/get_category_subtree?

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

ParameterTypeDescription
category_tree_idstringThe unique identifier of the eBay category tree. The category tree ID for an eBay marketplace can be retrieved using the getDefaultCategoryTreeId method.

Occurrence: Required

category_idstringThe unique identifier of the category at the top of the subtree being requested. Metadata on this category and all its descendant categories are retrieved.

Note: If the category_id submitted identifies a leaf node of the tree, the call response will contain information about only that leaf node, which is a valid subtree.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
Accept-EncodingstringThis header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip.

For more information, refer to HTTP request headers.

Occurrence: Optional

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
categorySubtreeNodeCategoryTreeNode

Contains details of all nodes of the category subtree hierarchy below a specified node. This is a recursive structure.

Occurrence: Always

categorySubtreeNode.categoryCategory

Contains details about the current category tree node.

Occurrence: Always

categorySubtreeNode.category.categoryIdstring

The unique identifier of the eBay category within its category tree.

Note: The root node of a full default category tree includes the categoryId field, but its value should not be relied upon. It provides no useful information for application development.

Occurrence: Always

categorySubtreeNode.category.categoryNamestring

The name of the category identified by categoryId.

Occurrence: Always

categorySubtreeNode.categoryTreeNodeLevelinteger

The absolute level of the current category tree node in the hierarchy of its category tree.

Note: The root node of any full category tree is always at level 0.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodesarray of CategoryTreeNode

An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.

Returned only if the current category tree node is not a leaf node (the value of leafCategoryTreeNode is false).

Occurrence: Conditional

categorySubtreeNode.childCategoryTreeNodes.categoryCategory

Contains details about the current category tree node.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodes.category.categoryIdstring

The unique identifier of the eBay category within its category tree.

Note: The root node of a full default category tree includes the categoryId field, but its value should not be relied upon. It provides no useful information for application development.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodes.category.categoryNamestring

The name of the category identified by categoryId.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodes.categoryTreeNodeLevelinteger

The absolute level of the current category tree node in the hierarchy of its category tree.

Note: The root node of any full category tree is always at level 0.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodes.childCategoryTreeNodesarray of CategoryTreeNode

An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.

Returned only if the current category tree node is not a leaf node (the value of leafCategoryTreeNode is false).

Occurrence: Conditional

categorySubtreeNode.childCategoryTreeNodes.childCategoryTreeNodes.categoryCategory

Contains details about the current category tree node.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodes.childCategoryTreeNodes.category.categoryIdstring

The unique identifier of the eBay category within its category tree.

Note: The root node of a full default category tree includes the categoryId field, but its value should not be relied upon. It provides no useful information for application development.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodes.childCategoryTreeNodes.category.categoryNamestring

The name of the category identified by categoryId.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodes.childCategoryTreeNodes.categoryTreeNodeLevelinteger

The absolute level of the current category tree node in the hierarchy of its category tree.

Note: The root node of any full category tree is always at level 0.

Occurrence: Always

categorySubtreeNode.childCategoryTreeNodes.childCategoryTreeNodes.childCategoryTreeNodesarray of CategoryTreeNode

An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.

Returned only if the current category tree node is not a leaf node (the value of leafCategoryTreeNode is false).

Occurrence: Conditional

categorySubtreeNode.childCategoryTreeNodes.childCategoryTreeNodes.leafCategoryTreeNodeboolean

A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.

Returned only if the value of this field is true.

Occurrence: Conditional

categorySubtreeNode.childCategoryTreeNodes.childCategoryTreeNodes.parentCategoryTreeNodeHrefstring

The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.

Not returned if the current category tree node is the root node of its tree.

Occurrence: Conditional

categorySubtreeNode.childCategoryTreeNodes.leafCategoryTreeNodeboolean

A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.

Returned only if the value of this field is true.

Occurrence: Conditional

categorySubtreeNode.childCategoryTreeNodes.parentCategoryTreeNodeHrefstring

The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.

Not returned if the current category tree node is the root node of its tree.

Occurrence: Conditional

categorySubtreeNode.leafCategoryTreeNodeboolean

A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.

Returned only if the value of this field is true.

Occurrence: Conditional

categorySubtreeNode.parentCategoryTreeNodeHrefstring

The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.

Not returned if the current category tree node is the root node of its tree.

Occurrence: Conditional

categoryTreeIdstring

The unique identifier of the eBay category tree to which this subtree belongs.

Occurrence: Always

categoryTreeVersionstring

The version of the category tree identified by categoryTreeId. It's a good idea to cache this value for comparison so you can determine if this category tree has been modified in subsequent calls.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
400Bad Request
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
62000API_TAXONOMYAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
62004API_TAXONOMYREQUESTThe specified category tree ID was not found.
62005API_TAXONOMYREQUESTThe specified category ID does not belong to the specified category tree.
62006API_TAXONOMYREQUESTMissing category ID.
62008API_TAXONOMYREQUESTThe specified category ID is the root for the category tree. Please use {categoryTreeHref} to retrieve the entire tree.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get a subtree of a category tree

This sample retrieves the complete content of a subtree of an eBay category tree, using the category tree node that contains the specified category as the root of the desired subtree.

Input

Use the category_tree_id path parameter to specify the category tree, and use the category_id query parameter to specify the category in the category node at the top of the subtree being requested.

GEThttps://api.ebay.com/commerce/taxonomy/v1/category_tree/0/get_category_subtree?category_id=11450

Output

A successful call returns the complete category subtree specified, from the specified category node to all leaf nodes of the subtree. In this sample, the returned category subtree contains almost 600 categories, so the response shown here has most of the nodes removed for easier viewing.

Got thoughts? Click the feedback button – your insights help us improve!