Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eBay Category_tree API

The Category_tree API from eBay — 8 operation(s) for category_tree.

eBay Category_tree API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Category_tree. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.

This API exposes 8 operations across 8 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version v1.9.2.

Requests are made against a single base URL, https://api.ebay.com{basePath}.

8 operations 8 paths 20 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.9.2
Base URL
https://api.ebay.com
Authentication
OAuth 2.0
Contact
eBay Inc,
Resource Areas
1

Authentication & Security 1

eBay Category_tree API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.

  • api_auth — The security definitions for this API. Please check individual operations for applicable scopes.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Category_tree 8
GET
/category_tree/{category_tree_id}/fetch_item_aspects
eBay Get Aspects for All Leaf Categories in a Marketplace
fetchItemAspects 1 param → 200400404500
GET
/get_default_category_tree_id
eBay Get a Default Category Tree ID
getDefaultCategoryTreeId 1 param → 200204400500
GET
/category_tree/{category_tree_id}
eBay Get a Category Tree
getCategoryTree 2 params → 200400404500
GET
/category_tree/{category_tree_id}/get_category_subtree
eBay Get a Category Subtree
getCategorySubtree 3 params → 200400404500
GET
/category_tree/{category_tree_id}/get_category_suggestions
eBay Get Suggested Categories
getCategorySuggestions 2 params → 200204400404500
GET
/category_tree/{category_tree_id}/get_item_aspects_for_category
This call returns a list of aspects that are appropriate or necessary for accurately describing items in the specified leaf category. Each aspect identifies an item attribute (for example, color,) fo…
getItemAspectsForCategory 2 params → 200204400404500
GET
/category_tree/{category_tree_id}/get_compatibility_properties
eBay Get Compatibility Properties
getCompatibilityProperties 2 params → 200204400404500
GET
/category_tree/{category_tree_id}/get_compatibility_property_values
eBay Get Compatibility Property Values
getCompatibilityPropertyValues 4 params → 200204400404500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are AspectConstraint (10 properties), CategoryTreeNode (5 properties), CategoryTree (4 properties), CategorySuggestion (4 properties). Each schema is shown below with its type and property counts.

CategoryTree
object
This type contains information about all nodes of a specified eBay category tree.
4 properties
GetCategoriesAspectResponse
object
3 properties
CompatibilityPropertyValue
object
This type is used by the compatibilityPropertyValues array that is returned in the getCompatibilityPropertyValues response. The compatibilityPropertyValues arr…
1 property
BaseCategoryTree
object
This type contains identifying information for the category tree associated with a particular eBay marketplace.
2 properties
CategoryTreeNode
object
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…
5 properties
CategorySuggestion
object
This type contains information about a suggested category tree leaf node that corresponds to keywords provided in the request. It includes details about each o…
4 properties
Aspect
object
This type contains information about an item attribute (for example, color) that is appropriate or necessary for accurately describing items in a particular le…
4 properties
AspectMetadata
object
This type is the container type for the response payload of the getItemAspectsForCategory call.
1 property
AspectValue
object
This type contains a valid value for an aspect, along with any constraints on the occurrence of that value.
2 properties
Category
object
This type contains information about a particular eBay category.
2 properties
CompatibilityProperty
object
This type is used by the compatibilityProperties array that is returned in the getCompatibilityProperties call. The compatibilityProperties container consists…
2 properties
CategorySubtree
object
This type contains information about a particular subtree of a specified eBay category tree. A category subtree consists of a non-root node of the category tre…
3 properties
GetCompatibilityMetadataResponse
object
This type is used by the base response of the getCompatibilityProperties method.
1 property
RelevanceIndicator
object
The relevance of this aspect. This field is returned if eBay has data on how many searches have been performed for listings in the category using this item asp…
1 property
AncestorReference
object
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 ca…
4 properties
AspectConstraint
object
This type contains information about the formatting, occurrence, and support of an aspect.
10 properties
CategoryAspect
object
2 properties
GetCompatibilityPropertyValuesResponse
object
The base response type of the getCompatibilityPropertyValues method.
1 property
ValueConstraint
object
This type contains a list of the dependencies that identify when a particular value is available for a given aspect of a given category. Each dependency specif…
2 properties
CategorySuggestionResponse
object
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,…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-category-tree-api-openapi.yml Raw ↑

Other APIs eBay publishes across the network.

eBay Advertising_eligibility API
eBay Bidding API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Custom_policy API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API
eBay Event_item API