eBay · Schema

CategorySuggestion

This type contains information about a suggested category tree leaf node that corresponds to keywords provided in the request. It includes details about each of the category's ancestor nodes extending up to the root of the category tree.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
category object Contains details about the suggested category.
categoryTreeNodeAncestors array An ordered list of category references that describes the location of the suggested category in the specified category tree. The list identifies the category's ancestry as a sequence of parent nodes,
categoryTreeNodeLevel integer The absolute level of the category tree node in the hierarchy of its category tree.

Note: The root node of any full category tree is always at level
relevancy string This field is reserved for internal or future use.
View JSON Schema on GitHub

JSON Schema

ebay-categorysuggestion-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CategorySuggestion",
  "title": "CategorySuggestion",
  "type": "object",
  "properties": {
    "category": {
      "description": "Contains details about the suggested category.",
      "$ref": "#/components/schemas/Category"
    },
    "categoryTreeNodeAncestors": {
      "type": "array",
      "description": "An ordered list of category references that describes the location of the suggested category in the specified category tree. The list identifies the category's ancestry as a sequence of parent nodes, from the current node's immediate parent to the root node of the category tree.<br><br><span class=\"tablenote\"> <strong>Note:</strong> The root node of a full default category tree includes <b>categoryId</b> and <b>categoryName</b> fields, but their values should not be relied upon. They provide no useful information for application development.</span>",
      "items": {
        "$ref": "#/components/schemas/AncestorReference"
      }
    },
    "categoryTreeNodeLevel": {
      "type": "integer",
      "description": "The absolute level of the 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"
    },
    "relevancy": {
      "type": "string",
      "description": "This field is reserved for internal or future use."
    }
  },
  "description": "This type contains information about a suggested category tree leaf node that corresponds to keywords provided in the request. It includes details about each of the category's ancestor nodes extending up to the root of the category tree."
}