eBay · Schema

CategoryTreeNode

This type contains information about all nodes of a category tree or subtree hierarchy, including and below the specified Category, down to the leaf nodes. It is a recursive structure.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
category object Contains details about the current category tree node.
categoryTreeNodeLevel integer 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
childCategoryTreeNodes array 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
leafCategoryTreeNode boolean 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 n
parentCategoryTreeNodeHref string 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
View JSON Schema on GitHub

JSON Schema

ebay-categorytreenode-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CategoryTreeNode",
  "title": "CategoryTreeNode",
  "type": "object",
  "properties": {
    "category": {
      "description": "Contains details about the current category tree node.",
      "$ref": "#/components/schemas/Category"
    },
    "categoryTreeNodeLevel": {
      "type": "integer",
      "description": "The absolute level of the current category tree node in the hierarchy of its category tree.<br><br><span class=\"tablenote\"> <strong>Note:</strong> The root node of any full category tree is always at level <code><b>0</b></code>. </span>",
      "format": "int32"
    },
    "childCategoryTreeNodes": {
      "type": "array",
      "description": "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.<br><br><i>Returned only if</i> the current category tree node is not a leaf node (the value of <b>leafCategoryTreeNode</b> is <code>false</code>).",
      "items": {
        "$ref": "#/components/schemas/CategoryTreeNode"
      }
    },
    "leafCategoryTreeNode": {
      "type": "boolean",
      "description": "A value of <code>true</code> indicates that the current category tree node is a leaf node (it has no child nodes). A value of <code>false</code> indicates that the current node has one or more child nodes, which are identified by the <b>childCategoryTreeNodes</b> array.<br><br><i>Returned only if</i> the value of this field is <code>true</code>."
    },
    "parentCategoryTreeNodeHref": {
      "type": "string",
      "description": "The href portion of the <b>getCategorySubtree</b> call that retrieves the subtree below the parent of this category tree node.<br><br><i>Not returned if</i> the current category tree node is the root node of its tree."
    }
  },
  "description": "This type contains information about all nodes of a category tree or subtree hierarchy, including and below the specified <b>Category</b>, down to the leaf nodes. It is a recursive structure."
}