taxonomy APIv1_beta.2.0

getCategoryTree

GET
/category_tree/{category_tree_id}
This call retrieves the complete category tree that is identified by the category_tree_id parameter. The value of category_tree_id was returned by the getDefaultCategoryTreeId call in the categoryTreeId field. The response contains details of all nodes of the specified eBay category tree, as well as the eBay marketplaces that use this category tree.

Note: This call can return a very large payload, so you are strongly advised to submit the request with the following HTTP header:

  Accept-Encoding: application/gzip

With this header (in addition to the required headers described under HTTP Request Headers), the call returns the response with gzip compression.

Input

Resource URI (production)

GET https://api.ebay.com/commerce/taxonomy/v1_beta/category_tree/{category_tree_id}

URI parameters

ParameterTypeDescription
category_tree_idstringThe unique identifier of the eBay category tree being requested.

Occurrence: Required

HTTP request headers

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

OAuth scope

This request requires an access token created with the client grant flow, using one scope from the following list:

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

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
applicableMarketplaceIdsarray of MarketplaceIdEnumA list of one or more identifiers of the eBay marketplaces that use this category tree.

Occurrence: Always

categoryTreeIdstringThe unique identifier of this eBay category tree.

Occurrence: Always

categoryTreeVersionstringThe version of this category tree. 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

rootCategoryNodeCategoryTreeNodeContains details of all nodes of the category tree hierarchy, starting with the root node and down to the leaf nodes. This is a recursive structure.

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

rootCategoryNode.categoryCategoryContains details about the current category tree node.

Occurrence: Always

rootCategoryNode.category.categoryIdstringThe 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

rootCategoryNode.category.categoryNamestringThe canonical name of the category identified by categoryId.

Note: Don't depend on category names to be unique within a given category tree.

Occurrence: Always

rootCategoryNode.categoryTreeNodeLevelintegerThe 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

rootCategoryNode.childCategoryTreeNodesarray of CategoryTreeNodeAn 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 the current category tree node is not a leaf node (the value of leafCategoryTreeNode is false).

Occurrence: Conditional

rootCategoryNode.childCategoryTreeNodes.categoryCategoryContains details about the current category tree node.

Occurrence: Always

rootCategoryNode.childCategoryTreeNodes.category.categoryIdstringThe 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

rootCategoryNode.childCategoryTreeNodes.category.categoryNamestringThe canonical name of the category identified by categoryId.

Note: Don't depend on category names to be unique within a given category tree.

Occurrence: Always

rootCategoryNode.childCategoryTreeNodes.categoryTreeNodeLevelintegerThe 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

rootCategoryNode.childCategoryTreeNodes.childCategoryTreeNodesarray of CategoryTreeNodeAn 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 the current category tree node is not a leaf node (the value of leafCategoryTreeNode is false).

Occurrence: Conditional

rootCategoryNode.childCategoryTreeNodes.childCategoryTreeNodes.categoryCategoryContains details about the current category tree node.

Occurrence: Always

rootCategoryNode.childCategoryTreeNodes.childCategoryTreeNodes.category.categoryIdstringThe 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

rootCategoryNode.childCategoryTreeNodes.childCategoryTreeNodes.category.categoryNamestringThe canonical name of the category identified by categoryId.

Note: Don't depend on category names to be unique within a given category tree.

Occurrence: Always

rootCategoryNode.childCategoryTreeNodes.childCategoryTreeNodes.categoryTreeNodeLevelintegerThe 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

rootCategoryNode.childCategoryTreeNodes.childCategoryTreeNodes.childCategoryTreeNodesarray of CategoryTreeNodeAn 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 the current category tree node is not a leaf node (the value of leafCategoryTreeNode is false).

Occurrence: Conditional

rootCategoryNode.childCategoryTreeNodes.childCategoryTreeNodes.leafCategoryTreeNodebooleanA 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

rootCategoryNode.childCategoryTreeNodes.childCategoryTreeNodes.parentCategoryTreeNodeHrefstringThe 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

rootCategoryNode.childCategoryTreeNodes.leafCategoryTreeNodebooleanA 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

rootCategoryNode.childCategoryTreeNodes.parentCategoryTreeNodeHrefstringThe 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

rootCategoryNode.leafCategoryTreeNodebooleanA 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

rootCategoryNode.parentCategoryTreeNodeHrefstringThe 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

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
404Not Found
500Internal Server Error

Error codes

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.

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 complete category tree

This sample retrieves the complete content of the specified category tree.

Input

Use the category_tree_id path parameter to specify the category tree to retrieve. It is not necessary to specify an eBay marketplace.
GET
https://api.ebay.com/commerce/taxonomy/v1_beta/category_tree/0

Output

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