GET
/category_tree/{category_tree_id}/fetch_item_aspects
Note: The General Availability (GA) version of the Taxonomy API has been released. Developers currently using the Beta version should make plans to migrate to the new GA version, as the Beta version will be decommissioned on March 31, 2021. Until that date, the Beta version documentation set can be accessed through the All API Documentation page.
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: This call can return a large payload, so the call returns the response as a gzipped JSON file. The open source Taxonomy SDK can be used to compare the aspect metadata that is returned in this response. The bulk download capability that this method provides, when combined with the Taxonomy SDK, brings transparency to the evolution of the metadata.
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: This call can return a large payload, so the call returns the response as a gzipped JSON file. The open source Taxonomy SDK can be used to compare the aspect metadata that is returned in this response. The bulk download capability that this method provides, when combined with the Taxonomy SDK, brings transparency to the evolution of the metadata.
Input
Resource URI (production)
GET https://api.ebay.com/commerce/taxonomy/v1/category_tree/{category_tree_id}/fetch_item_aspects
URI parameters
| Parameter | Type | Description |
|---|---|---|
| category_tree_id | string | The unique identifier of the eBay category tree being requested. 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 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):
https://api.ebay.com/oauth/api_scope
https://api.ebay.com/oauth/api_scope/metadata.insights
See OAuth access tokens for more information.
Note: The metadata.insights scope is conditional and is based on the App Check to gain access to the 'Buyer Demand Data'. Please refer to relevanceIndicator.
Output
Important: The response for this call is always a JSON GZIP file. The response is shown as JSON fields so that they can be explained.
{ /* GetCategoriesAspectResponse */
"categoryAspects" : [
}{ /* CategoryAspect */
]"aspects" : [
}{ /* Aspect */ }
]| Output container/field | Type | Description |
|---|---|---|
| categoryTreeId | string | The unique identifier of the eBay category tree being requested. Occurrence: Always |
| categoryTreeVersion | string | The version of the category tree that is returned in the categoryTreeId field. Occurrence: Always |
| categoryAspects | array of CategoryAspect | An array of aspects that are appropriate or necessary for accurately describing items in a particular leaf category. Occurrence: Always |
| categoryAspects.category | Category | The details that are appropriate or necessary to accurately define the category. Occurrence: Always |
| categoryAspects.category.categoryId | string | The unique identifier of the eBay category within its category tree. Note: The root node of a full default category tree includes the categoryId field, but its value should not be relied upon. It provides no useful information for application development. Occurrence: Always |
| categoryAspects.category.categoryName | string | The name of the category identified by categoryId. Occurrence: Always |
| categoryAspects.aspects | array of Aspect | A list of aspect metadata that is used to describe the items in a particular leaf category. Occurrence: Conditional |
| categoryAspects.aspects.aspectConstraint | AspectConstraint | Information about the formatting, occurrence, and support of this aspect. Occurrence: Always |
| categoryAspects.aspects.aspectConstraint.aspectApplicableTo | array of AspectApplicableToEnum | This value indicate if the aspect identified by the aspects.localizedAspectName field is a product aspect (relevant to catalog products in the category) or an item/instance aspect, which is an aspect whose value will vary based on a particular instance of the product. Occurrence: Conditional |
| categoryAspects.aspects.aspectConstraint.aspectDataType | AspectDataTypeEnum | The data type of this aspect. Occurrence: Always |
| categoryAspects.aspects.aspectConstraint.aspectEnabledForVariations | boolean | A value of true indicates that this aspect can be used to help identify item variations. Occurrence: Always |
| categoryAspects.aspects.aspectConstraint.aspectFormat | string | Returned only if the value of aspectDataType identifies a data type that requires specific formatting. Currently, this field provides formatting hints as follows:
Occurrence: Conditional |
| categoryAspects.aspects.aspectConstraint.aspectMaxLength | integer | The maximum length of the item/instance aspect's value. The seller must make sure not to exceed this length when specifying the instance aspect's value for a product. This field is only returned for instance aspects. Occurrence: Conditional |
| categoryAspects.aspects.aspectConstraint.aspectMode | AspectModeEnum | The manner in which values of this aspect must be specified by the seller (as free text or by selecting from available options). Occurrence: Always |
| categoryAspects.aspects.aspectConstraint.aspectRequired | boolean | A value of true indicates that this aspect is required when offering items in the specified category. Occurrence: Always |
| categoryAspects.aspects.aspectConstraint.aspectUsage | AspectUsageEnum | The enumeration value returned in this field will indicate if the corresponding aspect is recommended or optional. Note: This field is always returned, even for hard-mandated/required aspects (where aspectRequired: true). The value returned for required aspects will be RECOMMENDED, but they are actually required and a seller will be blocked from listing or revising an item without these aspects. Occurrence: Always |
| categoryAspects.aspects.aspectConstraint.expectedRequiredByDate | string | The expected date after which the aspect will be required. Note: The value returned in this field specifies only an approximate date, which may not reflect the actual date after which the aspect is required. Occurrence: Conditional |
| categoryAspects.aspects.aspectConstraint.itemToAspectCardinality | ItemToAspectCardinalityEnum | Indicates whether this aspect can accept single or multiple values for items in the specified category. Occurrence: Always |
| categoryAspects.aspects.aspectValues | array of AspectValue | A list of valid values for this aspect (for example: Red, Green, and Blue), along with any constraints on those values. Occurrence: Always |
| categoryAspects.aspects.aspectValues.localizedValue | string | The localized value of this aspect. Note: This value is always localized for the specified marketplace. Occurrence: Always |
| categoryAspects.aspects.aspectValues.valueConstraints | array of ValueConstraint | Not returned if the value of the localizedValue field can always be selected for this aspect of the specified category. Contains a list of the dependencies that identify when the value of the localizedValue field is available for the current aspect. Each dependency specifies the values of another aspect of the same category (a control aspect), for which the current value of the current aspect can also be selected by the seller. Example: A shirt is available in three sizes and three colors, but only the Small and Medium sizes come in Green. Thus for the Color aspect, the value Green is constrained by its dependency on Size (the control aspect). Only when the Size aspect value is Small or Medium, can the Color aspect value of Green be selected by the seller. Occurrence: Conditional |
| categoryAspects.aspects.aspectValues.valueConstraints.applicableForLocalizedAspectName | string | The name of the control aspect on which the current aspect value depends. Occurrence: Conditional |
| categoryAspects.aspects.aspectValues.valueConstraints.applicableForLocalizedAspectValues | array of string | Contains a list of the values of the control aspect on which this aspect's value depends. When the control aspect has any of the specified values, the current value of the current aspect will also be available. Occurrence: Conditional |
| categoryAspects.aspects.localizedAspectName | string | The localized name of this aspect (for example: Colour on the eBay UK site). Note: This name is always localized for the specified marketplace. Occurrence: Always |
| categoryAspects.aspects.relevanceIndicator | RelevanceIndicator | 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 aspect. Note: This container is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to 'Buyer Demand Data' in the Taxonomy API. Occurrence: Conditional |
| categoryAspects.aspects.relevanceIndicator.searchCount | integer | The number of recent searches (based on 30 days of data) for the aspect. Occurrence: Conditional |
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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 62000 | API_TAXONOMY | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 62004 | API_TAXONOMY | REQUEST | The specified category tree ID was not found. |
Warnings
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: Fetch Item Aspects for a Marketplace
This sample retrieves the item aspects for the specified eBay marketplace.
Input
The category_tree_id value is passed as a path parameter, and this value identifies the eBay marketplace.
GET
https://api.ebay.com/commerce/taxonomy/v1/category_tree/0/fetch_item_aspects
Output
The output is an HTTP status. If the call is successful, the gzipped JSON file containing the item aspects for the specified eBay marketplace is downloaded.