Skip to content

Taxonomy API — client.commerce.taxonomy

Version v1.1.1 · base path /commerce/taxonomy/v1 · async twin: the same methods on AsyncEbayClient, awaited.

Operations

Bases: BaseResource

fetch_item_aspects

fetch_item_aspects(category_tree_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.GetCategoriesAspectResponse
fetch_item_aspects(category_tree_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
fetch_item_aspects(category_tree_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.GetCategoriesAspectResponse | httpx.Response

Get Aspects for All Leaf Categories in a Marketplace

get_default_category_tree_id

get_default_category_tree_id(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.BaseCategoryTree
get_default_category_tree_id(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_default_category_tree_id(*, marketplace_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.BaseCategoryTree | httpx.Response

Get a Default Category Tree ID

get_category_tree

get_category_tree(category_tree_id: str, *, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.CategoryTree
get_category_tree(category_tree_id: str, *, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_category_tree(category_tree_id: str, *, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.CategoryTree | httpx.Response

Get a Category Tree

get_category_subtree

get_category_subtree(category_tree_id: str, *, category_id: str, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.CategorySubtree
get_category_subtree(category_tree_id: str, *, category_id: str, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_category_subtree(category_tree_id: str, *, category_id: str, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.CategorySubtree | httpx.Response

Get a Category Subtree

get_category_suggestions

get_category_suggestions(category_tree_id: str, *, q: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.CategorySuggestionResponse
get_category_suggestions(category_tree_id: str, *, q: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_category_suggestions(category_tree_id: str, *, q: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.CategorySuggestionResponse | httpx.Response

Get Suggested Categories

get_item_aspects_for_category

get_item_aspects_for_category(category_tree_id: str, *, category_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.AspectMetadata
get_item_aspects_for_category(category_tree_id: str, *, category_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_aspects_for_category(category_tree_id: str, *, category_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.AspectMetadata | httpx.Response

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.

get_compatibility_properties

get_compatibility_properties(category_tree_id: str, *, category_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.GetCompatibilityMetadataResponse
get_compatibility_properties(category_tree_id: str, *, category_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_compatibility_properties(category_tree_id: str, *, category_id: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.GetCompatibilityMetadataResponse | httpx.Response

Get Compatibility Properties

get_compatibility_property_values

get_compatibility_property_values(category_tree_id: str, *, compatibility_property: str, category_id: str, filter: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.GetCompatibilityPropertyValuesResponse
get_compatibility_property_values(category_tree_id: str, *, compatibility_property: str, category_id: str, filter: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_compatibility_property_values(category_tree_id: str, *, compatibility_property: str, category_id: str, filter: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.GetCompatibilityPropertyValuesResponse | httpx.Response

Get Compatibility Property Values

get_expired_categories

get_expired_categories(category_tree_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_taxonomy_models.ExpiredCategories
get_expired_categories(category_tree_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_expired_categories(category_tree_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_taxonomy_models.ExpiredCategories | httpx.Response

This method retrieves the mappings of expired leaf categories in the specified category tree to their corresponding active leaf categories. Note that in some cases, several expired categories are mapped to a single active category. Note: This method only returns information about categories that have been mapped (i.e., combined categories and split categories).

Models

AncestorReference

Bases: EbayModel

category_id class-attribute instance-attribute

category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay ancestor category. 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.')

category_name class-attribute instance-attribute

category_name = Field(None, alias='categoryName', description='The name of the ancestor category identified by categoryId .')

category_subtree_node_href class-attribute instance-attribute

category_subtree_node_href = Field(None, alias='categorySubtreeNodeHref', description='The href portion of the getCategorySubtree call that retrieves the subtree below the ancestor category node.')

category_tree_node_level class-attribute instance-attribute

category_tree_node_level = Field(None, alias='categoryTreeNodeLevel', description='The absolute level of the ancestor category node in the hierarchy of its category tree. Note: The root node of any full category tree is always at level 0 .')

AspectAdvancedDataTypeEnum

Bases: OpenStrEnum

numeric_range class-attribute instance-attribute

numeric_range = 'NUMERIC_RANGE'

AspectApplicableToEnum

Bases: OpenStrEnum

item class-attribute instance-attribute

item = 'ITEM'

product class-attribute instance-attribute

product = 'PRODUCT'

AspectDataTypeEnum

Bases: OpenStrEnum

date class-attribute instance-attribute

date = 'DATE'

number class-attribute instance-attribute

number = 'NUMBER'

string class-attribute instance-attribute

string = 'STRING'

string_array class-attribute instance-attribute

string_array = 'STRING_ARRAY'

AspectModeEnum

Bases: OpenStrEnum

free_text class-attribute instance-attribute

free_text = 'FREE_TEXT'

selection_only class-attribute instance-attribute

selection_only = 'SELECTION_ONLY'

AspectUsageEnum

Bases: OpenStrEnum

recommended class-attribute instance-attribute

recommended = 'RECOMMENDED'

optional class-attribute instance-attribute

optional = 'OPTIONAL'

BaseCategoryTree

Bases: EbayModel

category_tree_id class-attribute instance-attribute

category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the eBay category tree for the specified marketplace.')

category_tree_version class-attribute instance-attribute

category_tree_version = Field(None, alias='categoryTreeVersion', description="The 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.")

Category

Bases: EbayModel

category_id class-attribute instance-attribute

category_id = Field(None, alias='categoryId', description='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.')

category_name class-attribute instance-attribute

category_name = Field(None, alias='categoryName', description='The name of the category identified by categoryId .')

CategorySuggestion

Bases: EbayModel

category class-attribute instance-attribute

category = Field(None, description='Contains details about the suggested category.')

category_tree_node_ancestors class-attribute instance-attribute

category_tree_node_ancestors = Field(None, alias='categoryTreeNodeAncestors', description="An ordered list of category references that describes the location of the suggested category in the specified category tree. The list identifies the category's ancestry as a sequence of parent nodes, from the current node's immediate parent to the root node of the category tree.")

category_tree_node_level class-attribute instance-attribute

category_tree_node_level = Field(None, alias='categoryTreeNodeLevel', description='The absolute level of the category tree node in the hierarchy of its category tree. Note: The root node of any full category tree is always at level 0 .')

relevancy class-attribute instance-attribute

relevancy = Field(None, description='This field is reserved for internal or future use.')

CategorySuggestionResponse

Bases: EbayModel

category_suggestions class-attribute instance-attribute

category_suggestions = Field(None, alias='categorySuggestions', description="Contains details about one or more suggested categories that correspond to the provided keywords. The array of suggested categories is sorted in order of eBay's confidence of the relevance of each category (the first category is the most relevant). Important: This call is not supported in the Sandbox environment.")

category_tree_id class-attribute instance-attribute

category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the eBay category tree from which suggestions are returned.')

category_tree_version class-attribute instance-attribute

category_tree_version = Field(None, alias='categoryTreeVersion', description="The 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.")

CategoryTreeNode

Bases: EbayModel

category class-attribute instance-attribute

category = Field(None, description='Contains details about the current category tree node.')

category_tree_node_level class-attribute instance-attribute

category_tree_node_level = Field(None, alias='categoryTreeNodeLevel', description='The absolute level of the current category tree node in the hierarchy of its category tree. Note: The root node of any full category tree is always at level 0 .')

child_category_tree_nodes class-attribute instance-attribute

child_category_tree_nodes = Field(None, alias='childCategoryTreeNodes', description='An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes. Returned only if the current category tree node is not a leaf node (the value of leafCategoryTreeNode is false ).')

leaf_category_tree_node class-attribute instance-attribute

leaf_category_tree_node = Field(None, alias='leafCategoryTreeNode', description='A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array. Returned only if the value of this field is true .')

parent_category_tree_node_href class-attribute instance-attribute

parent_category_tree_node_href = Field(None, alias='parentCategoryTreeNodeHref', description='The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node. Not returned if the current category tree node is the root node of its tree.')

CompatibilityProperty

Bases: EbayModel

name class-attribute instance-attribute

name = Field(None, description='This is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category. This is the string value that should be used in the compatibility_property and filter query parameters of a getCompatibilityPropertyValues request URI.')

localized_name class-attribute instance-attribute

localized_name = Field(None, alias='localizedName', description='This is the localized name of the compatible vehicle property. The language that is used will depend on the user making the call, or based on the language specified if the Content-Language HTTP header is used. In some instances, the string value in this field may be the same as the string in the corresponding name field.')

CompatibilityPropertyValue

Bases: EbayModel

value class-attribute instance-attribute

value = Field(None, description='Each value field shows one applicable compatible vehicle property value. The values that are returned will depend on the specified eBay marketplace, specified eBay category, and filters in the request.')

ErrorParameter

Bases: EbayModel

name class-attribute instance-attribute

name = Field(None, description='The object of the error.')

value class-attribute instance-attribute

value = Field(None, description='The value of the object.')

ExpiredCategory

Bases: EbayModel

from_category_id class-attribute instance-attribute

from_category_id = Field(None, alias='fromCategoryId', description='The unique identifier of the expired eBay leaf category.')

to_category_id class-attribute instance-attribute

to_category_id = Field(None, alias='toCategoryId', description='The unique identifier of the currently active eBay leaf category that has replaced the expired leaf category. Note: More than one fromCategoryID value may map into the same toCategoryID value, as multiple eBay categories may be consolidated into one new, expanded category.')

GetCompatibilityMetadataResponse

Bases: EbayModel

compatibility_properties class-attribute instance-attribute

compatibility_properties = Field(None, alias='compatibilityProperties', description='This container consists of an array of all compatible vehicle properties applicable to the specified eBay marketplace and eBay category ID.')

GetCompatibilityPropertyValuesResponse

Bases: EbayModel

compatibility_property_values class-attribute instance-attribute

compatibility_property_values = Field(None, alias='compatibilityPropertyValues', description='This array contains all compatible vehicle property values that match the specified eBay marketplace, specified eBay category, and filters in the request.')

ItemToAspectCardinalityEnum

Bases: OpenStrEnum

multi class-attribute instance-attribute

multi = 'MULTI'

single class-attribute instance-attribute

single = 'SINGLE'

MarketplaceIdEnum

Bases: OpenStrEnum

ebay_at class-attribute instance-attribute

ebay_at = 'EBAY_AT'

ebay_au class-attribute instance-attribute

ebay_au = 'EBAY_AU'

ebay_be class-attribute instance-attribute

ebay_be = 'EBAY_BE'

ebay_ca class-attribute instance-attribute

ebay_ca = 'EBAY_CA'

ebay_ch class-attribute instance-attribute

ebay_ch = 'EBAY_CH'

ebay_de class-attribute instance-attribute

ebay_de = 'EBAY_DE'

ebay_es class-attribute instance-attribute

ebay_es = 'EBAY_ES'

ebay_fr class-attribute instance-attribute

ebay_fr = 'EBAY_FR'

ebay_gb class-attribute instance-attribute

ebay_gb = 'EBAY_GB'

ebay_hk class-attribute instance-attribute

ebay_hk = 'EBAY_HK'

ebay_ie class-attribute instance-attribute

ebay_ie = 'EBAY_IE'

ebay_in class-attribute instance-attribute

ebay_in = 'EBAY_IN'

ebay_it class-attribute instance-attribute

ebay_it = 'EBAY_IT'

ebay_motors_us class-attribute instance-attribute

ebay_motors_us = 'EBAY_MOTORS_US'

ebay_my class-attribute instance-attribute

ebay_my = 'EBAY_MY'

ebay_nl class-attribute instance-attribute

ebay_nl = 'EBAY_NL'

ebay_ph class-attribute instance-attribute

ebay_ph = 'EBAY_PH'

ebay_pl class-attribute instance-attribute

ebay_pl = 'EBAY_PL'

ebay_ru class-attribute instance-attribute

ebay_ru = 'EBAY_RU'

ebay_sg class-attribute instance-attribute

ebay_sg = 'EBAY_SG'

ebay_us class-attribute instance-attribute

ebay_us = 'EBAY_US'

RangeValue

Bases: EbayModel

start class-attribute instance-attribute

start = Field(None, description='The RangeValue type is for future use.')

end class-attribute instance-attribute

end = Field(None, description='The RangeValue type is for future use.')

exclusive_start class-attribute instance-attribute

exclusive_start = Field(None, alias='exclusiveStart', description='The RangeValue type is for future use.')

exclusive_end class-attribute instance-attribute

exclusive_end = Field(None, alias='exclusiveEnd', description='The RangeValue type is for future use.')

range class-attribute instance-attribute

range = Field(None, description='The RangeValue type is for future use.')

RelevanceIndicator

Bases: EbayModel

search_count class-attribute instance-attribute

search_count = Field(None, alias='searchCount', description='The number of recent searches (based on 30 days of data) for the aspect.')

ValueConstraint

Bases: EbayModel

applicable_for_localized_aspect_name class-attribute instance-attribute

applicable_for_localized_aspect_name = Field(None, alias='applicableForLocalizedAspectName', description='The name of the control aspect on which the current aspect value depends.')

applicable_for_localized_aspect_values class-attribute instance-attribute

applicable_for_localized_aspect_values = Field(None, alias='applicableForLocalizedAspectValues', description="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.")

AspectConstraint

Bases: EbayModel

aspect_applicable_to class-attribute instance-attribute

aspect_applicable_to = Field(None, alias='aspectApplicableTo', description='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.')

aspect_data_type class-attribute instance-attribute

aspect_data_type = Field(None, alias='aspectDataType', description='The data type of this aspect.')

aspect_enabled_for_variations class-attribute instance-attribute

aspect_enabled_for_variations = Field(None, alias='aspectEnabledForVariations', description='A value of true indicates that this aspect can be used to help identify item variations.')

aspect_format class-attribute instance-attribute

aspect_format = Field(None, alias='aspectFormat', description='Returned only if the value of aspectDataType identifies a data type that requires specific formatting. Currently, this field provides formatting hints as follows: DATE : YYYY , YYYYMM , YYYYMMDD NUMBER : int32 , double')

aspect_max_length class-attribute instance-attribute

aspect_max_length = Field(None, alias='aspectMaxLength', description="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.")

aspect_mode class-attribute instance-attribute

aspect_mode = Field(None, alias='aspectMode', description='The manner in which values of this aspect must be specified by the seller (as free text or by selecting from available options).')

aspect_required class-attribute instance-attribute

aspect_required = Field(None, alias='aspectRequired', description='A value of true indicates that this aspect is required when offering items in the specified category.')

aspect_usage class-attribute instance-attribute

aspect_usage = Field(None, alias='aspectUsage', description='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 ).')

expected_required_by_date class-attribute instance-attribute

expected_required_by_date = Field(None, alias='expectedRequiredByDate', description='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.')

item_to_aspect_cardinality class-attribute instance-attribute

item_to_aspect_cardinality = Field(None, alias='itemToAspectCardinality', description='Indicates whether this aspect can accept single or multiple values for items in the specified category. Note: Up to 30 values can be supplied for aspects that accept multiple values.')

aspect_advanced_data_type class-attribute instance-attribute

aspect_advanced_data_type = Field(None, alias='aspectAdvancedDataType', description='Indicates additional data type requirements for the aspect. For example, NUMERIC_RANGE indicates that the aspect value must be in numeric range format. Note: Currently only NUMERIC_RANGE is supported.')

AspectValue

Bases: EbayModel

localized_value class-attribute instance-attribute

localized_value = Field(None, alias='localizedValue', description='The localized value of this aspect. Note: This value is always localized for the specified marketplace.')

value_constraints class-attribute instance-attribute

value_constraints = Field(None, alias='valueConstraints', description='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.')

CategorySubtree

Bases: EbayModel

category_subtree_node class-attribute instance-attribute

category_subtree_node = Field(None, alias='categorySubtreeNode', description='Contains details of all nodes of the category subtree hierarchy below a specified node. This is a recursive structure.')

category_tree_id class-attribute instance-attribute

category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the eBay category tree to which this subtree belongs.')

category_tree_version class-attribute instance-attribute

category_tree_version = Field(None, alias='categoryTreeVersion', description="The 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.")

CategoryTree

Bases: EbayModel

applicable_marketplace_ids class-attribute instance-attribute

applicable_marketplace_ids = Field(None, alias='applicableMarketplaceIds', description='A list of one or more identifiers of the eBay marketplaces that use this category tree.')

category_tree_id class-attribute instance-attribute

category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of this eBay category tree.')

category_tree_version class-attribute instance-attribute

category_tree_version = Field(None, alias='categoryTreeVersion', description="The version of this category tree. 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.")

root_category_node class-attribute instance-attribute

root_category_node = Field(None, alias='rootCategoryNode', description='Contains details of all nodes of the category tree hierarchy, starting with the root node and down to the leaf nodes. This is a recursive structure. 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.')

Error

Bases: EbayModel

category class-attribute instance-attribute

category = Field(None, description='Identifies the type of error.')

domain class-attribute instance-attribute

domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')

error_id class-attribute instance-attribute

error_id = Field(None, alias='errorId', description='A unique number to identify the error.')

input_ref_ids class-attribute instance-attribute

input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')

long_message class-attribute instance-attribute

long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')

message class-attribute instance-attribute

message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")

output_ref_ids class-attribute instance-attribute

output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')

parameters class-attribute instance-attribute

parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')

subdomain class-attribute instance-attribute

subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')

ExpiredCategories

Bases: EbayModel

expired_categories class-attribute instance-attribute

expired_categories = Field(None, alias='expiredCategories', description='An array of expired category ID(s) for the requested category tree, and the currently active category ID(s) that have replaced them.')

FilterField

Bases: EbayModel

field class-attribute instance-attribute

field = Field(None, description='The FilterField type is for future use.')

value class-attribute instance-attribute

value = Field(None, description='The FilterField type is for future use.')

negated class-attribute instance-attribute

negated = Field(None, description='The FilterField type is for future use.')

range class-attribute instance-attribute

range = Field(None, description='The FilterField and RangeValue types are for future use.')

set class-attribute instance-attribute

set = Field(None, description='The FilterField type is for future use.')

Aspect

Bases: EbayModel

aspect_constraint class-attribute instance-attribute

aspect_constraint = Field(None, alias='aspectConstraint', description='Information about the formatting, occurrence, and support of this aspect.')

aspect_values class-attribute instance-attribute

aspect_values = Field(None, alias='aspectValues', description='A list of valid values for this aspect (for example: Red , Green , and Blue ), along with any constraints on those values.')

localized_aspect_name class-attribute instance-attribute

localized_aspect_name = Field(None, alias='localizedAspectName', description='The localized name of this aspect (for example: Colour on the eBay UK site). Note: This name is always localized for the specified marketplace.')

relevance_indicator class-attribute instance-attribute

relevance_indicator = Field(None, alias='relevanceIndicator', description='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.')

AspectMetadata

Bases: EbayModel

aspects class-attribute instance-attribute

aspects = Field(None, description='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.')

CategoryAspect

Bases: EbayModel

category class-attribute instance-attribute

category = Field(None, description='The details that are appropriate or necessary to accurately define the category.')

aspects class-attribute instance-attribute

aspects = Field(None, description='A list of aspect metadata that is used to describe the items in a particular leaf category.')

ConstraintFilter

Bases: EbayModel

filters class-attribute instance-attribute

filters = Field(None, description='The ConstraintFilter type is for future use.')

GetCategoriesAspectResponse

Bases: EbayModel

category_tree_id class-attribute instance-attribute

category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the eBay category tree being requested.')

category_tree_version class-attribute instance-attribute

category_tree_version = Field(None, alias='categoryTreeVersion', description='The version of the category tree that is returned in the categoryTreeId field.')

category_aspects class-attribute instance-attribute

category_aspects = Field(None, alias='categoryAspects', description='An array of aspects that are appropriate or necessary for accurately describing items in a particular leaf category.')