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
Resource URI (production)
|category_tree_id||string||The unique identifier of the eBay category tree from which the specified category's aspects are being requested. |
|category_id||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.
HTTP request headers
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.
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.
|aspects||array of Aspect||A list of item aspects (for example, color) that are appropriate or necessary for accurately describing items in a particular leaf category. Each category has a different set of aspects and different requirements for aspect values. Sellers are required or encouraged to provide one or more acceptable values for each aspect when offering an item in that category on eBay. |
|aspects.aspectConstraint||AspectConstraint||Information about the formatting, occurrence, and support of this aspect. |
|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. |
|aspects.aspectConstraint.aspectDataType||AspectDataTypeEnum||The data type of this aspect. |
|aspects.aspectConstraint.aspectEnabledForVariations||boolean||A value of |
|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: |
|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. |
|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). |
|aspects.aspectConstraint.aspectRequired||boolean||A value of |
|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
|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.
|aspects.aspectConstraint.itemToAspectCardinality||ItemToAspectCardinalityEnum||Indicates whether this aspect can accept single or multiple values for items in the specified category. |
|aspects.aspectValues||array of AspectValue||A list of valid values for this aspect (for example: |
|aspects.aspectValues.localizedValue||string||The localized value of this aspect.|
Note: This value is always localized for the specified marketplace.
|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.
|aspects.aspectValues.valueConstraints.applicableForLocalizedAspectName||string||The name of the control aspect on which the current aspect value depends. |
|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. |
|aspects.localizedAspectName||string||The localized name of this aspect (for example: |
Note: This name is always localized for the specified marketplace.
|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.
|aspects.relevanceIndicator.searchCount||integer||The number of recent searches (based on 30 days of data) for the aspect. |
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.|
|62004||API_TAXONOMY||REQUEST||The specified category tree ID was not found.|
|62005||API_TAXONOMY||REQUEST||The specified category ID does not belong to specified category tree.|
|62006||API_TAXONOMY||REQUEST||Missing category ID.|
|62008||API_TAXONOMY||REQUEST||The specified category ID is the root for the category tree.|
|62009||API_TAXONOMY||REQUEST||The specified category ID must be a leaf category.|
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 aspects for a leaf category
67726, including each aspect's data type, format, entry mode, cardinality, and support. It also returns a list of valid values for each aspect, including any constraints on the applicability of each value.
Sample 2: Get the expected required by date for an aspect
Note: The category specified in this sample is a test category used for example purposes only.
178090, including the expected date after which each aspect will be required, if available.