|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.
|category_tree_id||string||The unique identifier of the eBay category tree from which the specified category's aspects are being requested. |
This request requires an access token created with the client credentials grant flow, using one scope from the following list:
See OAuth access tokens for more information.
|aspects||array of Aspect||A list of item attributes (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||Contains 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.itemToAspectCardinality||ItemToAspectCardinalityEnum||Indicates whether this aspect can accept single or multiple values for items in the specified category. |
|aspects.aspectValues||array of AspectValue||Contains 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. There is no canonical version of this value.
|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. There is no canonical aspect name.
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.
For more on errors, plus additional common error codes, see Handling errors.
|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.|
|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.
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.