API docs by Redocly

Taxonomy API (v1.0.0)

Download OpenAPI specification:Download

License: eBay API License Agreement

Use the Taxonomy API to discover the most appropriate eBay categories under which sellers can offer inventory items for sale, and the most likely categories under which buyers can browse or search for items to purchase. In addition, the Taxonomy API provides metadata about the required and recommended category aspects to include in listings, and also has two operations to retrieve parts compatibility information.

category_tree

Get Aspects for All Leaf Categories in a Marketplace

This call returns a complete list of aspects for all of the leaf categories that belong to an eBay marketplace. The eBay marketplace is specified through the category_tree_id URI parameter.

Note: A successful call returns a payload as a gzipped JSON file sent as a binary file using the content-type:application/octet-stream in the response. This file may be large (over 100 MB, compressed). Extract the JSON file from the compressed file with a utility that handles .gz or .gzip. The open source Taxonomy SDK can be used to compare the aspect metadata that is returned in this response. The Taxonomy SDK uses this method to surface changes (new, modified, and removed entities) between an updated version of a bulk downloaded file relative to a previous version.

Authorizations:
Client_Credentials
path Parameters
category_tree_id
required
string

The unique identifier of the eBay category tree being requested.

Responses

Response samples

Content type
application/json
{
  • "categoryTreeId": "string",
  • "categoryTreeVersion": "string",
  • "categoryAspects": [
    ]
}

Get a 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.

Authorizations:
Client_Credentials
query Parameters
marketplace_id
required
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.

header Parameters
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.

Valid Values:

  • For EBAY_CA in French:
    Accept-Language: fr-CA
  • For EBAY_BE in French:
    Accept-Language: fr-BE

Responses

Response samples

Content type
application/json
{
  • "categoryTreeId": "string",
  • "categoryTreeVersion": "string"
}

Get a Category Tree

This call retrieves the complete category tree that is identified by the category_tree_id parameter. The value of category_tree_id was returned by the getDefaultCategoryTreeId call in the categoryTreeId field. The response contains details of all nodes of the specified eBay category tree, as well as the eBay marketplaces that use this category tree.

Note: This call can return a very large payload, so you are strongly advised to submit the request with the following HTTP header:

  Accept-Encoding: application/gzip

With this header (in addition to the required headers described under HTTP Request Headers), the call returns the response with gzip compression.

Authorizations:
Client_Credentials
path Parameters
category_tree_id
required
string

The unique identifier of the eBay category tree being requested.

Responses

Response samples

Content type
application/json
{
  • "applicableMarketplaceIds": [
    ],
  • "categoryTreeId": "string",
  • "categoryTreeVersion": "string",
  • "rootCategoryNode": {
    }
}

Get a Category Subtree

This call retrieves the details of all nodes of the category tree hierarchy (the subtree) below a specified category of a category tree. You identify the tree using the category_tree_id parameter, which was returned by the getDefaultCategoryTreeId call in the categoryTreeId field.

Note: This call can return a very large payload, so you are strongly advised to submit the request with the following HTTP header:

  Accept-Encoding: application/gzip

With this header (in addition to the required headers described under HTTP Request Headers), the call returns the response with gzip compression.

Authorizations:
Client_Credentials
path Parameters
category_tree_id
required
string

The unique identifier of the eBay category tree from which a category subtree is being requested.

query Parameters
category_id
required
string

The unique identifier of the category at the top of the subtree being requested.

Note: If the category_id submitted identifies the root node of the tree, this call returns an error. To retrieve the complete tree, use this value with the getCategoryTree call.

If the category_id submitted identifies a leaf node of the tree, the call response will contain information about only that leaf node, which is a valid subtree.

Responses

Response samples

Content type
application/json
{
  • "categorySubtreeNode": {
    },
  • "categoryTreeId": "string",
  • "categoryTreeVersion": "string"
}

Get Suggested Categories

This call returns an array of category tree leaf nodes in the specified category tree that are considered by eBay to most closely correspond to the query string q. Returned with each suggested node is a localized name for that category (based on the Accept-Language header specified for the call), and details about each of the category's ancestor nodes, extending from its immediate parent up to the root of the category tree.

Note: This call can return a large payload, so you are advised to submit the request with the following HTTP header:

  Accept-Encoding: application/gzip

With this header (in addition to the required headers described under HTTP Request Headers), the call returns the response with gzip compression.

You identify the tree using the category_tree_id parameter, which was returned by the getDefaultCategoryTreeId call in the categoryTreeId field.

Important: This call is not supported in the Sandbox environment. It will return a response payload in which the categoryName fields contain random or boilerplate text regardless of the query submitted.

Authorizations:
Client_Credentials
path Parameters
category_tree_id
required
string

The unique identifier of the eBay category tree for which suggested nodes are being requested.

query Parameters
q
required
string

A quoted string that describes or characterizes the item being offered for sale. The string format is free form, and can contain any combination of phrases or keywords. eBay will parse the string and return suggested categories for the item.

Responses

Response samples

Content type
application/json
{
  • "categorySuggestions": [
    ],
  • "categoryTreeId": "string",
  • "categoryTreeVersion": "string"
}

getItemAspectsForCategory

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) for which the seller will be required or encouraged to provide a value (or variation values) when offering an item in that category on eBay.

For each aspect, getItemAspectsForCategory provides complete metadata, including:

  • The aspect's data type, format, and entry mode
  • Whether the aspect is required in listings
  • Whether the aspect can be used for item variations
  • Whether the aspect accepts multiple values for an item
  • Allowed values for the aspect
Use this information to construct an interface through which sellers can enter or select the appropriate values for their items or item variations. Once you collect those values, include them as product aspects when creating inventory items using the Inventory API.

Authorizations:
Client_Credentials
path Parameters
category_tree_id
required
string

The unique identifier of the eBay category tree from which the specified category's aspects are being requested.

query Parameters
category_id
required
string

The unique identifier of the leaf category for which aspects are being requested.

Note: If the category_id submitted does not identify a leaf node of the tree, this call returns an error.

Responses

Response samples

Content type
application/json
{
  • "aspects": [
    ]
}

Get Compatibility Properties

This call retrieves the compatible vehicle aspects that are used to define a motor vehicle that is compatible with a motor vehicle part or accessory. The values that are retrieved here might include motor vehicle aspects such as 'Make', 'Model', 'Year', 'Engine', and 'Trim', and each of these aspects are localized for the eBay marketplace.

The category_tree_id value is passed in as a path parameter, and this value identifies the eBay category tree. The category_id value is passed in as a query parameter, as this parameter is also required. The specified category must be a category that supports parts compatibility.

At this time, this operation only supports parts and accessories listings for cars, trucks, and motorcycles (not boats, power sports, or any other vehicle types). Only the following eBay marketplaces support parts compatibility:

  • eBay US (Motors and non-Motors categories)
  • eBay Canada (Motors and non-Motors categories)
  • eBay UK
  • eBay Germany
  • eBay Australia
  • eBay France
  • eBay Italy
  • eBay Spain

Authorizations:
Client_Credentials
path Parameters
category_tree_id
required
string

This is the unique identifier of category tree. The following is the list of category_tree_id values and the eBay marketplaces that they represent. One of these ID values must be passed in as a path parameter, and the category_id value, that is passed in as query parameter, must be a valid eBay category on that eBay marketplace that supports parts compatibility for cars, trucks, or motorcyles.

  • eBay US: 0
  • eBay Motors US: 100
  • eBay Canada: 2
  • eBay UK: 3
  • eBay Germany: 77
  • eBay Australia: 15
  • eBay France: 71
  • eBay Italy: 101
  • eBay Spain: 186

query Parameters
category_id
required
string

The unique identifier of an eBay category. This eBay category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcyles. The getAutomotivePartsCompatibilityPolicies method of the Selling Metadata API can be used to retrieve all eBay categories for an eBay marketplace that supports parts compatibility cars, trucks, or motorcyles. The getAutomotivePartsCompatibilityPolicies method can also be used to see if one or more specific eBay categories support parts compatibility.

Responses

Response samples

Content type
application/json
{
  • "compatibilityProperties": [
    ]
}

Get Compatibility Property Values

This call retrieves applicable compatible vehicle property values based on the specified eBay marketplace, specified eBay category, and filters used in the request. Compatible vehicle properties are returned in the compatibilityProperties.name field of a getCompatibilityProperties response.

One compatible vehicle property applicable to the specified eBay marketplace and eBay category is specified through the required compatibility_property filter. Then, the user has the option of further restricting the compatible vehicle property values that are returned in the response by specifying one or more compatible vehicle property name/value pairs through the filter query parameter.

See the documentation in URI parameters section for more information on using the compatibility_property and filter query parameters together to customize the data that is retrieved.

Authorizations:
Client_Credentials
path Parameters
category_tree_id
required
string

This is the unique identifier of the category tree. The following is the list of category_tree_id values and the eBay marketplaces that they represent. One of these ID values must be passed in as a path parameter, and the category_id value, that is passed in as query parameter, must be a valid eBay category on that eBay marketplace that supports parts compatibility for cars, trucks, or motorcyles.

  • eBay US: 0
  • eBay Motors US: 100
  • eBay Canada: 2
  • eBay UK: 3
  • eBay Germany: 77
  • eBay Australia: 15
  • eBay France: 71
  • eBay Italy: 101
  • eBay Spain: 186

query Parameters
compatibility_property
required
string

One compatible vehicle property applicable to the specified eBay marketplace and eBay category is specified in this required filter. Compatible vehicle properties are returned in the compatibilityProperties.name field of a getCompatibilityProperties response.

For example, if you wanted to retrieve all vehicle trims for a 2018 Toyota Camry, you would set this filter as follows: compatibility_property=Trim; and then include the following three name/value filters through one filter parameter: filter=Year:2018,Make:Toyota,Model:Camry. So, putting this all together, your URI would look something like this:

GET https://api.ebay.com/commerce/
taxonomy/v1/category_tree/100/
get_compatibility_property_values?
category_id=6016&compatibility_property=Trim
&filter=filter=Year:2018,Make:Toyota,Model:Camry

category_id
required
string

The unique identifier of an eBay category. This eBay category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcyles. The getAutomotivePartsCompatibilityPolicies method of the Selling Metadata API can be used to retrieve all eBay categories for an eBay marketplace that supports parts compatibility cars, trucks, or motorcyles. The getAutomotivePartsCompatibilityPolicies method can also be used to see if one or more specific eBay categories support parts compatibility.

filter
string

One or more compatible vehicle property name/value pairs are passed in through this query parameter. The compatible vehicle property name and corresponding value are delimited with a colon (:), such as filter=Year:2018, and multiple compatible vehicle property name/value pairs are delimited with a comma (,).

For example, if you wanted to retrieve all vehicle trims for a 2018 Toyota Camry, you would set the compatibility_property filter as follows: compatibility_property=Trim; and then include the following three name/value filters through one filter parameter: filter=Year:2018,Make:Toyota,Model:Camry. So, putting this all together, your URI would look something like this:

GET https://api.ebay.com/commerce/
taxonomy/v1/category_tree/100/
get_compatibility_property_values?
category_id=6016&compatibility_property=Trim
&filter=filter=Year:2018,Make:Toyota,Model:Camry
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/taxonomy/types/txn:ConstraintFilter

Responses

Response samples

Content type
application/json
{
  • "compatibilityPropertyValues": [
    ]
}