eBay · Schema

CategorySuggestionResponse

This type contains an array of suggested category tree nodes that are considered by eBay to most closely correspond to the keywords provided in a query string, from a specified category tree.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
categorySuggestions array Contains details about one or more suggested categories that correspond to the provided keywords. The array of suggested categories is sorted in order of eBay's confidence of the relevance of each cat
categoryTreeId string The unique identifier of the eBay category tree from which suggestions are returned.
categoryTreeVersion string 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 cal
View JSON Schema on GitHub

JSON Schema

ebay-categorysuggestionresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CategorySuggestionResponse",
  "title": "CategorySuggestionResponse",
  "type": "object",
  "properties": {
    "categorySuggestions": {
      "type": "array",
      "description": "Contains details about one or more suggested categories that correspond to the provided keywords. The array of suggested categories is sorted in order of eBay's confidence of the relevance of each category (the first category is the most relevant).<br><br><span class=\"tablenote\"> <strong><span style=\"color:red\">Important:</span></strong> This call is not supported in the Sandbox environment. It will return a response payload in which the <b>categoryName</b> fields contain random or boilerplate text regardless of the query submitted. </span>",
      "items": {
        "$ref": "#/components/schemas/CategorySuggestion"
      }
    },
    "categoryTreeId": {
      "type": "string",
      "description": "The unique identifier of the eBay category tree from which suggestions are returned."
    },
    "categoryTreeVersion": {
      "type": "string",
      "description": "The version of the category tree identified by <b>categoryTreeId</b>. 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."
    }
  },
  "description": "This type contains an array of suggested category tree nodes that are considered by eBay to most closely correspond to the keywords provided in a query string, from a specified category tree."
}