taxonomy APIv1_beta.2.0

getDefaultCategoryTreeId

GET
/get_default_category_tree_id
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.

Input

Resource URI (production)

GET https://api.ebay.com/commerce/taxonomy/v1_beta/get_default_category_tree_id?

URI parameters

ParameterTypeDescription
marketplace_idstringThe 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.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the client grant flow, using one scope from the following list:

https://api.ebay.com/oauth/api_scope

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
categoryTreeIdstringThe unique identifier of the eBay category tree for the specified marketplace.

Occurrence: Always

categoryTreeVersionstringThe 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.

Occurrence: Always

HTTP status codes

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.

StatusMeaning
200Success
204No content
400Bad Request
500Internal Server Error

Error codes

CodeDomainCategoryMeaning
62000API_TAXONOMYAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
62002API_TAXONOMYREQUESTMissing marketplace ID.
62003API_TAXONOMYREQUESTThe specified marketplace ID was not found.

Samples

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.

Sample 1: Get a default category tree ID

This sample identifies the eBay category tree that is used by default by a given eBay marketplace.

Input

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.
GET
https://api.ebay.com/commerce/taxonomy/v1_beta/get_default_category_tree_id?marketplace_id=EBAY_AT

Output

A successful call returns the category tree's ID and version.