A given eBay marketplace might use multiple category trees, but one of those trees is considered to be the default for that marketplace. This call retrieves a reference to the default category tree associated with the specified eBay marketplace ID. The response includes only the tree's unique identifier and version, which you can use to retrieve more details about the tree, its structure, and its individual category nodes.
This method is supported in Sandbox environment. To access the endpoint, just replace the
api.ebay.com root URI with
|marketplace_id||string||The ID of the eBay marketplace for which the category tree ID is being requested. For a list of supported marketplace IDs, see Marketplaces with Default Category Trees. |
All requests made to eBay REST operations require you to provide the
Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
|Accept-Language||string||A header used to indicate the natural language the seller prefers for the response.|
This specifies the language that the seller wants to use when the field values provided in the request body are displayed to consumers.
Note: For details, see Accept-Language in HTTP request headers.
Occurrence: Strongly Recommended
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
This call has no response headers.
The unique identifier of the eBay category tree for the specified marketplace.
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 calls.
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|62000||API_TAXONOMY||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|62002||API_TAXONOMY||REQUEST||Missing marketplace ID.|
|62003||API_TAXONOMY||REQUEST||The specified marketplace ID was not found.|
This call has no warnings.
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
This sample identifies the eBay category tree that is used by default by a given eBay marketplace.
Use the marketplace_id query parameter to specify the eBay marketplace for which to retrieve the category tree ID. For a list of supported marketplaces and their IDs, see Marketplaces with Default Category Trees.
A successful call returns the category tree's ID and version.