eBay · Schema

AncestorReference

This type contains information about one of the ancestors of a suggested category. An ordered list of these references describes the path from the suggested category to the root of the category tree it belongs to.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
categoryId string The unique identifier of the eBay ancestor category.

Note: The root node of a full default category tree includes the categoryId field, but its
categoryName string The name of the ancestor category identified by categoryId.
categorySubtreeNodeHref string The href portion of the getCategorySubtree call that retrieves the subtree below the ancestor category node.
categoryTreeNodeLevel integer The absolute level of the ancestor category node in the hierarchy of its category tree.

Note: The root node of any full category tree is always at leve
View JSON Schema on GitHub

JSON Schema

ebay-ancestorreference-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AncestorReference",
  "title": "AncestorReference",
  "type": "object",
  "properties": {
    "categoryId": {
      "type": "string",
      "description": "The unique identifier of the eBay ancestor category.<br><br><span class=\"tablenote\"> <strong>Note:</strong> The root node of a full default category tree includes the <b>categoryId</b> field, but its value should not be relied upon. It provides no useful information for application development.</span>"
    },
    "categoryName": {
      "type": "string",
      "description": "The name of the ancestor category identified by <b>categoryId</b>."
    },
    "categorySubtreeNodeHref": {
      "type": "string",
      "description": "The href portion of the <b>getCategorySubtree</b> call that retrieves the subtree below the ancestor category node."
    },
    "categoryTreeNodeLevel": {
      "type": "integer",
      "description": "The absolute level of the ancestor category 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"
    }
  },
  "description": "This type contains information about one of the ancestors of a suggested category. An ordered list of these references describes the path from the suggested category to the root of the category tree it belongs to."
}