Metadata API — client.sell.metadata¶
Version v1.13.0 · base path /sell/metadata/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_automotive_parts_compatibility_policies ¶
get_automotive_parts_compatibility_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.AutomotivePartsCompatibilityPolicyResponse
get_automotive_parts_compatibility_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_automotive_parts_compatibility_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.AutomotivePartsCompatibilityPolicyResponse | httpx.Response
This method returns the eBay policies that define how to list automotive parts compatibility items in the categories of the specified marketplace. By default, this method returns all categories that support parts compatibility. You can limit the size of the result set by using the filter query parameter to specify only the category IDs you want to review.
get_category_policies ¶
get_category_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.CategoryPolicyResponse
get_category_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_category_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.CategoryPolicyResponse | httpx.Response
This method returns eBay category policy metadata for all leaf categories on the specified marketplace. By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.
get_classified_ad_policies ¶
get_classified_ad_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ClassifiedAdPolicyResponse
get_classified_ad_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_classified_ad_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ClassifiedAdPolicyResponse | httpx.Response
This method returns eBay classified ad policy metadata for all leaf categories on the specified marketplace. By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.
get_currencies ¶
get_currencies(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.GetCurrenciesResponse
get_currencies(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_currencies(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.GetCurrenciesResponse | httpx.Response
This method returns the default currency used by the eBay marketplace specified in the request. This is the currency that the seller should use when providing price data for this marketplace through listing APIs.
get_extended_producer_responsibility_policies ¶
get_extended_producer_responsibility_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ExtendedProducerResponsibilityPolicyResponse
get_extended_producer_responsibility_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_extended_producer_responsibility_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ExtendedProducerResponsibilityPolicyResponse | httpx.Response
This method returns the Extended Producer Responsibility policies for one, multiple, or all eBay categories in an eBay marketplace. The identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the filter query parameter, this method will return metadata on every applicable category for the specified marketplace.
get_hazardous_materials_labels ¶
get_hazardous_materials_labels(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.HazardousMaterialDetailsResponse
get_hazardous_materials_labels(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_hazardous_materials_labels(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.HazardousMaterialDetailsResponse | httpx.Response
This method returns hazardous materials label information for the specified eBay marketplace. The information includes IDs, descriptions, and URLs (as applicable) for the available signal words, statements, and pictograms. The returned statements are localized for the default language of the marketplace.
get_item_condition_policies ¶
get_item_condition_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ItemConditionPolicyResponse
get_item_condition_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_condition_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ItemConditionPolicyResponse | httpx.Response
This method returns item condition metadata on one, multiple, or all eBay categories on an eBay marketplace. This metadata consists of the different item conditions (with IDs) that an eBay category supports, and a boolean to indicate if an eBay category requires an item condition.
get_listing_structure_policies ¶
get_listing_structure_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ListingStructurePolicyResponse
get_listing_structure_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_listing_structure_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ListingStructurePolicyResponse | httpx.Response
This method returns the eBay policies that define the allowed listing structures for the categories of a specific marketplace. The listing-structure policies currently pertain to whether or not you can list items with variations. By default, this method returns the entire category tree for the specified marketplace.
get_listing_type_policies ¶
get_listing_type_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ListingTypePoliciesResponse
get_listing_type_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_listing_type_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ListingTypePoliciesResponse | httpx.Response
This method returns eBay listing type policy metadata for all leaf categories on the specified marketplace. By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.
get_minimum_listing_price_policies ¶
get_minimum_listing_price_policies(marketplace_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.GetMinimumListingPricePoliciesResponse
get_minimum_listing_price_policies(marketplace_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_minimum_listing_price_policies(marketplace_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.GetMinimumListingPricePoliciesResponse | httpx.Response
This method returns minimum listing price policies for supported types of listings on a specific marketplace. This includes the minimum start price for auction listings, the minimum sale price for fixed-price listings, and the minimum percentage value that a Buy It Now or auction listing must be above the minimum start price for the same listing.
get_motors_listing_policies ¶
get_motors_listing_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.MotorsListingPoliciesResponse
get_motors_listing_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_motors_listing_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.MotorsListingPoliciesResponse | httpx.Response
This method returns eBay Motors policy metadata for all leaf categories on the specified marketplace. By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.
get_negotiated_price_policies ¶
get_negotiated_price_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.NegotiatedPricePolicyResponse
get_negotiated_price_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_negotiated_price_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.NegotiatedPricePolicyResponse | httpx.Response
This method returns the eBay policies that define the supported negotiated price features (like "best offer") for the categories of a specific marketplace. By default, this method returns the entire category tree for the specified marketplace. You can limit the size of the result set by using the filter query parameter to specify only the category IDs you want to review.
get_product_safety_labels ¶
get_product_safety_labels(marketplace_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ProductSafetyLabelsResponse
get_product_safety_labels(marketplace_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_product_safety_labels(marketplace_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ProductSafetyLabelsResponse | httpx.Response
This method returns product safety label information for the specified eBay marketplace. The information includes IDs, descriptions, and URLs (as applicable) for the available statements and pictograms. The returned statements are localized for the default language of the marketplace.
get_regulatory_policies ¶
get_regulatory_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.RegulatoryPolicyResponse
get_regulatory_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_regulatory_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.RegulatoryPolicyResponse | httpx.Response
This method returns regulatory policies for one, multiple, or all eBay categories in an eBay marketplace. The identifier of the eBay marketplace is passed in as a path parameter, and unless one or more eBay category IDs are passed in through the filter query parameter, this method will return metadata for every listing category in the specified marketplace.
get_return_policies ¶
get_return_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ReturnPolicyResponse
get_return_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_return_policies(marketplace_id: str, *, filter: str | None = None, accept_encoding: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ReturnPolicyResponse | httpx.Response
This method returns the eBay policies that define whether or not you must include a return policy for the items you list in the categories of a specific marketplace, plus the guidelines for creating domestic and international return policies in the different eBay categories. By default, this method returns the entire category tree for the specified marketplace.
get_shipping_policies ¶
get_shipping_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ShippingPoliciesResponse
get_shipping_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_shipping_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ShippingPoliciesResponse | httpx.Response
This method returns eBay shipping policy metadata for all leaf categories on the specified marketplace. By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.
get_site_visibility_policies ¶
get_site_visibility_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.SiteVisibilityPoliciesResponse
get_site_visibility_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_site_visibility_policies(marketplace_id: str, *, filter: str | None = None, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.SiteVisibilityPoliciesResponse | httpx.Response
This method returns eBay international site visibility policy metadata for all leaf categories on the specified marketplace. By default, this method returns metadata on all leaf categories. You can limit the size of the result set by using the filter query parameter to specify only the leaf category IDs you want to review.
get_compatibilities_by_specification ¶
get_compatibilities_by_specification(*, body: SpecificationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.SpecificationResponse
get_compatibilities_by_specification(*, body: SpecificationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_compatibilities_by_specification(*, body: SpecificationRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.SpecificationResponse | httpx.Response
This method is used to retrieve all compatible application name-value pairs for a part based on the provided specification(s). The part's relevant dimensions and/or characteristics can be provided through the specifications container.
get_compatibility_property_names ¶
get_compatibility_property_names(*, body: PropertyNamesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.PropertyNamesResponse
get_compatibility_property_names(*, body: PropertyNamesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_compatibility_property_names(*, body: PropertyNamesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.PropertyNamesResponse | httpx.Response
This method is used to retrieve product compatibility property names for the specified compatibility-enabled category. Compatibility property names can be used alongside the corresponding compatibility property value (retrieved using the getCompatibilityPropertyValues method) to describe the assembly for which an item is compatible.
get_compatibility_property_values ¶
get_compatibility_property_values(*, body: PropertyValuesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.PropertyValuesResponse
get_compatibility_property_values(*, body: PropertyValuesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_compatibility_property_values(*, body: PropertyValuesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.PropertyValuesResponse | httpx.Response
This method is used to retrieve product compatibility property values associated with a single property name, in the specified category. Compatibility property values can be used alongside the corresponding compatibility property name (retrieved using the getCompatibilityPropertyNames method) to describe the assembly for which an item is compatible.
get_multi_compatibility_property_values ¶
get_multi_compatibility_property_values(*, body: MultiCompatibilityPropertyValuesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.MultiCompatibilityPropertyValuesResponse
get_multi_compatibility_property_values(*, body: MultiCompatibilityPropertyValuesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_multi_compatibility_property_values(*, body: MultiCompatibilityPropertyValuesRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.MultiCompatibilityPropertyValuesResponse | httpx.Response
This method is used to retrieve product compatibility property values associated with multiple property names, in the specified category. Compatibility property values can be used alongside the corresponding compatibility property name (retrieved using the getCompatibilityPropertyNames method) to describe the assembly for which an item is compatible.
get_product_compatibilities ¶
get_product_compatibilities(*, body: ProductRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ProductResponse
get_product_compatibilities(*, body: ProductRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_product_compatibilities(*, body: ProductRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ProductResponse | httpx.Response
This method is used to retrieve all available item compatibility details for the specified product. Item compatibility details can be used to see the properties for which an item is compatible. For example, if you are searching for a part for a specific vehicle, you can use this method to see the years, engine, and/or trim for which the part is compatible.
get_exclude_shipping_locations ¶
get_exclude_shipping_locations(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ShippingExcludeLocationResponse
get_exclude_shipping_locations(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_exclude_shipping_locations(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ShippingExcludeLocationResponse | httpx.Response
This method retrieves a list of locations that the seller can use as excluded shipping locations within their listings or in their fulfillment business policies for the specified marketplace. These are locations that a seller designates as areas where they will not ship items.
get_handling_times ¶
get_handling_times(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ShippingHandlingTimeResponse
get_handling_times(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_handling_times(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ShippingHandlingTimeResponse | httpx.Response
This method retrieves a list of supported handling times for the specified marketplace. The handling time returned specifies the maximum number of business days the eBay site allows for shipping an item to domestic buyers after receiving a cleared payment. Handling times apply to both domestic and international orders.
get_shipping_carriers ¶
get_shipping_carriers(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ShippingCarrierResponse
get_shipping_carriers(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_shipping_carriers(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ShippingCarrierResponse | httpx.Response
This method retrieves a list of supported shipping carriers for the specified marketplace. It provides essential information for sellers to understand which shipping carriers are available for use when listing items on that eBay marketplace. Knowing the supported carriers can help sellers optimize their shipping options and ensure efficient delivery to buyers.
get_shipping_locations ¶
get_shipping_locations(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ShippingLocationResponse
get_shipping_locations(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_shipping_locations(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ShippingLocationResponse | httpx.Response
This method retrieves a list of supported shipping locations for the specified marketplace. It provides sellers with information on where they can ship their items. Sellers can use this information to configure their shipping settings. Tip: Use the getExcludeShippingLocations method to return locations where the seller does not ship.
get_shipping_services ¶
get_shipping_services(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.ShippingServiceResponse
get_shipping_services(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_shipping_services(marketplace_id: str, *, accept_language: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.ShippingServiceResponse | httpx.Response
This method retrieves a list of shipping services supported for the specified marketplace, including valid shipping services, shipping times, and package constraints such as size and weight. Manage shipping services using business policies through the fulfillment_policy resource of the Account v1 API .
get_sales_tax_jurisdictions ¶
get_sales_tax_jurisdictions(country_code: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_metadata_models.SalesTaxJurisdictions
get_sales_tax_jurisdictions(country_code: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_sales_tax_jurisdictions(country_code: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_metadata_models.SalesTaxJurisdictions | httpx.Response
This method retrieves all sales-tax jurisdictions for the country specified in the countryCode path parameter. Countries with valid sales-tax jurisdictions are Canada and the US. The response from this call tells you the jurisdictions for which a seller can configure tax tables.
Models¶
AdFormatEnabledEnum ¶
CardinalityEnum ¶
ClassifiedAdBestOfferEnabledEnum ¶
ClassifiedAdPaymentMethodEnabledEnum ¶
ClassifiedAdPolicy ¶
Bases: EbayModel
ad_format_enabled
class-attribute
instance-attribute
¶
ad_format_enabled = Field(None, alias='adFormatEnabled', description='This enumerated value indicates the type or status of available Classified Ad formats for this category.')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which metadata is being returned.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the category tree.')
classified_ad_auto_accept_enabled
class-attribute
instance-attribute
¶
classified_ad_auto_accept_enabled = Field(None, alias='classifiedAdAutoAcceptEnabled', description='Indicates whether the category supports the Best Offer Automatic Accept feature for Classified Ad listings.')
classified_ad_auto_decline_enabled
class-attribute
instance-attribute
¶
classified_ad_auto_decline_enabled = Field(None, alias='classifiedAdAutoDeclineEnabled', description='Indicates whether the category supports the Best Offer Automatic Reject feature for Classified Ad listings.')
classified_ad_best_offer_enabled
class-attribute
instance-attribute
¶
classified_ad_best_offer_enabled = Field(None, alias='classifiedAdBestOfferEnabled', description='This enumerated value indicates if Best Offer is enabled, disabled, or required for Classified Ad listings in this category.')
classified_ad_company_name_enabled
class-attribute
instance-attribute
¶
classified_ad_company_name_enabled = Field(None, alias='classifiedAdCompanyNameEnabled', description="Indicates whether this category supports including a company name in the seller's contact information. This element is for For Sale By Owner listings.")
classified_ad_contact_by_address_enabled
class-attribute
instance-attribute
¶
classified_ad_contact_by_address_enabled = Field(None, alias='classifiedAdContactByAddressEnabled', description="Indicates whether this category supports including an address in the seller's contact information. This element is for For Sale By Owner listings.")
classified_ad_contact_by_email_enabled
class-attribute
instance-attribute
¶
classified_ad_contact_by_email_enabled = Field(None, alias='classifiedAdContactByEmailEnabled', description="Indicates whether most categories support including an email address in the seller's contact information.")
classified_ad_contact_by_phone_enabled
class-attribute
instance-attribute
¶
classified_ad_contact_by_phone_enabled = Field(None, alias='classifiedAdContactByPhoneEnabled', description="Indicates whether most categories support including a phone number in the seller's contact information.")
classified_ad_counter_offer_enabled
class-attribute
instance-attribute
¶
classified_ad_counter_offer_enabled = Field(None, alias='classifiedAdCounterOfferEnabled', description='Indicates whether counter offers are allowed on Best offers for the category.')
classified_ad_payment_method_enabled
class-attribute
instance-attribute
¶
classified_ad_payment_method_enabled = Field(None, alias='classifiedAdPaymentMethodEnabled', description='This enumerated value indicates support for the payment method being displayed to the user for the category. Even if enabled, checkout may or may not be enabled.')
classified_ad_phone_count
class-attribute
instance-attribute
¶
classified_ad_phone_count = Field(None, alias='classifiedAdPhoneCount', description='Indicates how many contact phone numbers can be specified in contact information for the category. This element is for For Sale By Owner listings.')
classified_ad_shipping_method_enabled
class-attribute
instance-attribute
¶
classified_ad_shipping_method_enabled = Field(None, alias='classifiedAdShippingMethodEnabled', description='Indicates if shipping methods can be specified and displayed in the View Item page for the category.')
classified_ad_street_count
class-attribute
instance-attribute
¶
classified_ad_street_count = Field(None, alias='classifiedAdStreetCount', description='Indicates how many street addresses can be specified in contact information for the category. This element is for For Sale By Owner listings.')
seller_contact_details_enabled
class-attribute
instance-attribute
¶
seller_contact_details_enabled = Field(None, alias='sellerContactDetailsEnabled', description='Indicates whether this category supports seller-level contact information for Classified Ad listings.')
CompatibilityDetails ¶
Bases: EbayModel
property_name
class-attribute
instance-attribute
¶
property_name = Field(None, alias='propertyName', description='The name of the property being described.')
property_value
class-attribute
instance-attribute
¶
property_value = Field(None, alias='propertyValue', description='The value for the property specified in the propertyName field.')
CompatibilityTypeEnum ¶
CompatibleVehicleTypeEnum ¶
Bases: OpenStrEnum
CountryCodeEnum ¶
Bases: OpenStrEnum
CurrencyCodeEnum ¶
Bases: OpenStrEnum
DescriptorUsageEnum ¶
Bases: OpenStrEnum
DisabledProductFilter ¶
Bases: EbayModel
exclude_for_ebay_reviews
class-attribute
instance-attribute
¶
exclude_for_ebay_reviews = Field(None, alias='excludeForEbayReviews', description='Specifies whether to filter out products excluded for eBay reviews. If set to true , items excluded from eBay reviews are not returned.')
exclude_for_ebay_selling
class-attribute
instance-attribute
¶
exclude_for_ebay_selling = Field(None, alias='excludeForEbaySelling', description='Specifies whether to filter out products excluded for eBay selling. If set to true , items excluded from eBay selling are not returned.')
DistanceType ¶
Bases: OpenStrEnum
local_listing_distances_regular
class-attribute
instance-attribute
¶
local_listing_distances_regular = 'LOCAL_LISTING_DISTANCES_REGULAR'
local_listing_distances_specialty
class-attribute
instance-attribute
¶
local_listing_distances_specialty = 'LOCAL_LISTING_DISTANCES_SPECIALTY'
local_listing_distances_non_subscription
class-attribute
instance-attribute
¶
local_listing_distances_non_subscription = 'LOCAL_LISTING_DISTANCES_NON_SUBSCRIPTION'
DurationEnum ¶
Bases: OpenStrEnum
ErrorParameter ¶
ErrorParameterV3 ¶
ExtendedProducerResponsibilityEnum ¶
GenericUsageEnum ¶
GeographicExposureEnum ¶
HazardStatement ¶
Bases: EbayModel
statement_id
class-attribute
instance-attribute
¶
statement_id = Field(None, alias='statementId', description='The identifier of the statement. For sample values, see Hazard statement sample values .')
statement_description
class-attribute
instance-attribute
¶
statement_description = Field(None, alias='statementDescription', description='The description of the statement localized to the default language of the marketplace. For sample values, see Hazard statement sample values .')
ItemConditionDescriptorValueConstraint ¶
Bases: EbayModel
applicable_to_condition_descriptor_id
class-attribute
instance-attribute
¶
applicable_to_condition_descriptor_id = Field(None, alias='applicableToConditionDescriptorId', description='This string is returned if the corresponding condition descriptor value requires an associated condition descriptor that must also be specified in a listing. The condition descriptor ID for the associated condition descriptors is returned here.')
applicable_to_condition_descriptor_value_ids
class-attribute
instance-attribute
¶
applicable_to_condition_descriptor_value_ids = Field(None, alias='applicableToConditionDescriptorValueIds', description='This array is returned if the corresponding condition descriptor value is required for one or more associated condition descriptor values that must also be specified in a listing. The condition descriptor values IDs for the associated condition descriptor values are returned here.')
ListingStructurePolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The category ID to which the listing-structure policy applies.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.')
variations_supported
class-attribute
instance-attribute
¶
variations_supported = Field(None, alias='variationsSupported', description='This flag denotes whether or not the associated category supports listings with item variations. If set to true , the category does support item variations.')
ListingTypeEnum ¶
Bases: OpenStrEnum
LocalListingDistance ¶
Bases: EbayModel
distances
class-attribute
instance-attribute
¶
distances = Field(None, description='This array indicates the radius (in miles) of the selling area for Local Market Vehicle listings.')
distance_type
class-attribute
instance-attribute
¶
distance_type = Field(None, alias='distanceType', description='This enumerated value indicates the type of local listing distances, such as non-subscription or regular, for items listed by sellers.')
MarketplaceIdEnum ¶
Bases: OpenStrEnum
ModeEnum ¶
MotorsListingPolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which metadata is being returned.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the category tree.')
deposit_supported
class-attribute
instance-attribute
¶
deposit_supported = Field(None, alias='depositSupported', description='This field is returned as true if the corresponding category supports the use of a deposit/down payment on a motor vehicle listing. In an AddItem call, the seller can configure a down payment for a motor vehicle listing using the PaymentDetails container.')
ebay_motors_pro_ad_format_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_ad_format_enabled = Field(None, alias='ebayMotorsProAdFormatEnabled', description='Indicates whether or not eBay Motors Pro sellers can use classified ads in this category to sell their vehicles. This element is applicable for eBay Motors Pro users.')
ebay_motors_pro_auto_accept_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_auto_accept_enabled = Field(None, alias='ebayMotorsProAutoAcceptEnabled', description='Indicates whether or not the category supports the Best Offer Auto Accept feature for eBay Motors Pro listings. This element is for eBay Motors Pro users.')
ebay_motors_pro_auto_decline_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_auto_decline_enabled = Field(None, alias='ebayMotorsProAutoDeclineEnabled', description='Indicates whether or not the category allows auto-decline for Best Offers for eBay Motors Classified Ad listings. This element is for eBay Motors Pro users.')
ebay_motors_pro_best_offer_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_best_offer_enabled = Field(None, alias='ebayMotorsProBestOfferEnabled', description='This enumerated value indicates whether or not Best Offer features are supported for eBay Motors Classified Ad listings in this category. This element is for eBay Motors Pro users.')
ebay_motors_pro_company_name_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_company_name_enabled = Field(None, alias='ebayMotorsProCompanyNameEnabled', description="Indicates whether this category supports including the company name in the seller's contact information. This element is for eBay Motors Pro users.")
ebay_motors_pro_contact_by_address_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_contact_by_address_enabled = Field(None, alias='ebayMotorsProContactByAddressEnabled', description="Indicates whether this category supports including the address in the seller's contact information. This element is for eBay Motors Pro users.")
ebay_motors_pro_contact_by_email_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_contact_by_email_enabled = Field(None, alias='ebayMotorsProContactByEmailEnabled', description="Indicates whether this category supports including an email address in the seller's contact information. This element is for eBay Motors Pro users.")
ebay_motors_pro_contact_by_phone_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_contact_by_phone_enabled = Field(None, alias='ebayMotorsProContactByPhoneEnabled', description="Indicates whether this category supports including the telephone in the seller's contact information. This element is for eBay Motors Pro users.")
ebay_motors_pro_counter_offer_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_counter_offer_enabled = Field(None, alias='ebayMotorsProCounterOfferEnabled', description='Indicates whether counter offers are allowed on Best Offers for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users.')
ebay_motors_pro_payment_method_check_out_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_payment_method_check_out_enabled = Field(None, alias='ebayMotorsProPaymentMethodCheckOutEnabled', description='This enumerated value indicates whether this category supports that the payment method should be displayed to the user for this category in an eBay Motors Classified Ad listing. Even if enabled, checkout may or may not be enabled. This element is for eBay Motors Pro users.')
ebay_motors_pro_phone_count
class-attribute
instance-attribute
¶
ebay_motors_pro_phone_count = Field(None, alias='ebayMotorsProPhoneCount', description='Indicates the number of phone numbers that can be included through contact information for this category. This element is for eBay Motors Pro users.')
ebay_motors_pro_seller_contact_details_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_seller_contact_details_enabled = Field(None, alias='ebayMotorsProSellerContactDetailsEnabled', description='Indicates whether this category allows seller-level contact information for eBay Motors Classified Ad listings. A value of true means seller-level contact information is available for Classified Ad listings. This element is for eBay Motors Pro users.')
ebay_motors_pro_shipping_method_enabled
class-attribute
instance-attribute
¶
ebay_motors_pro_shipping_method_enabled = Field(None, alias='ebayMotorsProShippingMethodEnabled', description='Indicates if shipping options should be displayed to the user for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users.')
ebay_motors_pro_street_count
class-attribute
instance-attribute
¶
ebay_motors_pro_street_count = Field(None, alias='ebayMotorsProStreetCount', description='This field indicates the number of street addresses allowed in contact information for this category. This element is for eBay Motors Pro users.')
epid_supported
class-attribute
instance-attribute
¶
epid_supported = Field(None, alias='epidSupported', description='If returned as true , this indicates the category supports the use of an eBay Product ID (e.g. ePID) to identify which motorcycles and/or scooters are compatible with a motor vehicle part or accessory. ePIDs can only be used to identify motorcycles and scooters on the Germany and UK sites.')
k_type_supported
class-attribute
instance-attribute
¶
k_type_supported = Field(None, alias='kTypeSupported', description='This field indicates whether or not the category supports the use of a K type to identify the cars and trucks compatible with a motor vehicle part or accessory. Only the AU, DE, ES, FR, IT, and UK marketplaces support the use of K types. See Compatibility by K type for more information')
local_listing_distances
class-attribute
instance-attribute
¶
local_listing_distances = Field(None, alias='localListingDistances', description="This array shows the supported distances (in miles) for different types of Local Market subscription types in this category. Motor vehicle listings will be shown to buyers located within these proximities of the vehicle's location.")
local_market_ad_format_enabled
class-attribute
instance-attribute
¶
local_market_ad_format_enabled = Field(None, alias='localMarketAdFormatEnabled', description='Specifies whether this category supports Motor Local Market Classified Ad listings.')
local_market_auto_accept_enabled
class-attribute
instance-attribute
¶
local_market_auto_accept_enabled = Field(None, alias='localMarketAutoAcceptEnabled', description='Specifies whether this category supports auto-accept for Best Offers for Motors Local Market Classified Ads.')
local_market_auto_decline_enabled
class-attribute
instance-attribute
¶
local_market_auto_decline_enabled = Field(None, alias='localMarketAutoDeclineEnabled', description='Specifies whether this category supports auto-decline for Best Offers for Motors Local Market Classified Ads.')
local_market_best_offer_enabled
class-attribute
instance-attribute
¶
local_market_best_offer_enabled = Field(None, alias='localMarketBestOfferEnabled', description='Indicates if Best Offer is enabled/required for Motors Local Market Classified Ad listings in this category.')
local_market_company_name_enabled
class-attribute
instance-attribute
¶
local_market_company_name_enabled = Field(None, alias='localMarketCompanyNameEnabled', description="Indicates whether the category supports the seller's company name being specified when using Motors Local Market classified ads.")
local_market_contact_by_address_enabled
class-attribute
instance-attribute
¶
local_market_contact_by_address_enabled = Field(None, alias='localMarketContactByAddressEnabled', description="Indicates whether this category supports including the address in the seller's contact information.")
local_market_contact_by_email_enabled
class-attribute
instance-attribute
¶
local_market_contact_by_email_enabled = Field(None, alias='localMarketContactByEmailEnabled', description="Indicates whether the category supports including an email address in the seller's contact information.")
local_market_contact_by_phone_enabled
class-attribute
instance-attribute
¶
local_market_contact_by_phone_enabled = Field(None, alias='localMarketContactByPhoneEnabled', description="Indicates whether this category supports including the telephone in the seller's contact information.")
local_market_counter_offer_enabled
class-attribute
instance-attribute
¶
local_market_counter_offer_enabled = Field(None, alias='localMarketCounterOfferEnabled', description='Indicates whether counter offers are allowed on Best Offers for this category for Motors Local Market Classified Ad listings.')
local_market_non_subscription
class-attribute
instance-attribute
¶
local_market_non_subscription = Field(None, alias='localMarketNonSubscription', description='Indicates whether the category supports a seller creating a Motors Local Market listing without a subscription. This feature is only available to licensed vehicle dealers.')
local_market_payment_method_check_out_enabled
class-attribute
instance-attribute
¶
local_market_payment_method_check_out_enabled = Field(None, alias='localMarketPaymentMethodCheckOutEnabled', description='Indicates if the payment method should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled.')
local_market_phone_count
class-attribute
instance-attribute
¶
local_market_phone_count = Field(None, alias='localMarketPhoneCount', description='Indicates the number of phone numbers that can be included through contact information for this category.')
local_market_premium_subscription
class-attribute
instance-attribute
¶
local_market_premium_subscription = Field(None, alias='localMarketPremiumSubscription', description='Indicates whether the category supports the Premium level subscription Motors Local Market listings. This feature is only available to licensed vehicle dealers.')
local_market_regular_subscription
class-attribute
instance-attribute
¶
local_market_regular_subscription = Field(None, alias='localMarketRegularSubscription', description='Indicates whether the category supports the Regular level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers.')
local_market_seller_contact_details_enabled
class-attribute
instance-attribute
¶
local_market_seller_contact_details_enabled = Field(None, alias='localMarketSellerContactDetailsEnabled', description='Specifies the whether this category allows seller-level contact information for Motors Local Market Classified Ad listings.')
local_market_shipping_method_enabled
class-attribute
instance-attribute
¶
local_market_shipping_method_enabled = Field(None, alias='localMarketShippingMethodEnabled', description='Indicates if shipping methods should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled.')
local_market_speciality_subscription
class-attribute
instance-attribute
¶
local_market_speciality_subscription = Field(None, alias='localMarketSpecialitySubscription', description='Indicates whether the category supports the Specialty level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers.')
local_market_street_count
class-attribute
instance-attribute
¶
local_market_street_count = Field(None, alias='localMarketStreetCount', description="Indicates which address option is enabled for the seller's contact information.")
max_granular_fitment_count
class-attribute
instance-attribute
¶
max_granular_fitment_count = Field(None, alias='maxGranularFitmentCount', description='Indicates the maximum number of compatible applications allowed per item when adding or revising items with compatibilities provided at the most detailed granularity. For example, in Car and Truck Parts on the US site, the most granular application would include Year, Make, Model, Trim, and Engine.')
max_item_compatibility
class-attribute
instance-attribute
¶
max_item_compatibility = Field(None, alias='maxItemCompatibility', description='Indicates the maximum number of compatible applications allowed per item when adding or revising items. This is relevant for specifying parts compatibility by application manually only. See Specify parts compatibility manually and Managing product compatibility for more information.')
min_item_compatibility
class-attribute
instance-attribute
¶
min_item_compatibility = Field(None, alias='minItemCompatibility', description='Indicates the minimum number of required compatible applications for listing items. A value of 0 indicates it is not mandatory to specify parts compatibilities when listing.')
non_subscription
class-attribute
instance-attribute
¶
non_subscription = Field(None, alias='nonSubscription', description='The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription.')
premium_subscription
class-attribute
instance-attribute
¶
premium_subscription = Field(None, alias='premiumSubscription', description='The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription.')
regular_subscription
class-attribute
instance-attribute
¶
regular_subscription = Field(None, alias='regularSubscription', description='The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Regular vehicle subscription.')
seller_provided_title_supported
class-attribute
instance-attribute
¶
seller_provided_title_supported = Field(None, alias='sellerProvidedTitleSupported', description="This field is returned as true if the corresponding category supports the use of a seller-provided title for a motor vehicle listing on the US or Canada Motors marketplaces. A seller-provided title is a descriptive title, given by the seller, that appears below eBay's pre-filled listing title for the motor vehicle.")
speciality_subscription
class-attribute
instance-attribute
¶
speciality_subscription = Field(None, alias='specialitySubscription', description='The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription.')
vin_supported
class-attribute
instance-attribute
¶
vin_supported = Field(None, alias='vinSupported', description='Indicates if Vehicle Identification Number is supported.')
vrm_supported
class-attribute
instance-attribute
¶
vrm_supported = Field(None, alias='vrmSupported', description='Indicates if Vehicle Registration Mark is supported.')
NegotiatedPricePolicy ¶
Bases: EbayModel
best_offer_auto_accept_enabled
class-attribute
instance-attribute
¶
best_offer_auto_accept_enabled = Field(None, alias='bestOfferAutoAcceptEnabled', description='This flag denotes whether or not the category supports the setting of a price at which best offers are automatically accepted. If set to true , the category does support the setting of an automatic price for best-offers.')
best_offer_auto_decline_enabled
class-attribute
instance-attribute
¶
best_offer_auto_decline_enabled = Field(None, alias='bestOfferAutoDeclineEnabled', description='This flag denotes whether or not the category supports the setting of an auto-decline price for best offers. If set to true , the category does support the setting of an automatic-decline price for best-offers.')
best_offer_counter_enabled
class-attribute
instance-attribute
¶
best_offer_counter_enabled = Field(None, alias='bestOfferCounterEnabled', description='This flag denotes whether or not the category supports the setting for an automatic counter-offer on best offers. If set to true , the category does support the setting of an automatic counter-offer price for best-offers.')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The category ID to which the negotiated-price policies apply.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.')
PackageLimits ¶
Bases: EbayModel
dimension_unit
class-attribute
instance-attribute
¶
dimension_unit = Field(None, alias='dimensionUnit', description='Unit of dimensional measurement, for example INCH or CENTIMETER .')
max_girth
class-attribute
instance-attribute
¶
max_girth = Field(None, alias='maxGirth', description='The maximum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .')
max_height
class-attribute
instance-attribute
¶
max_height = Field(None, alias='maxHeight', description='The maximum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .')
max_length
class-attribute
instance-attribute
¶
max_length = Field(None, alias='maxLength', description='The maximum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .')
max_weight
class-attribute
instance-attribute
¶
max_weight = Field(None, alias='maxWeight', description='The maximum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit .')
max_width
class-attribute
instance-attribute
¶
max_width = Field(None, alias='maxWidth', description='The maximum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .')
min_girth
class-attribute
instance-attribute
¶
min_girth = Field(None, alias='minGirth', description='The minimum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .')
min_height
class-attribute
instance-attribute
¶
min_height = Field(None, alias='minHeight', description='The minimum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .')
min_length
class-attribute
instance-attribute
¶
min_length = Field(None, alias='minLength', description='The minimum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .')
min_weight
class-attribute
instance-attribute
¶
min_weight = Field(None, alias='minWeight', description='The minimum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit .')
min_width
class-attribute
instance-attribute
¶
min_width = Field(None, alias='minWidth', description='The minimum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit .')
weight_unit
class-attribute
instance-attribute
¶
weight_unit = Field(None, alias='weightUnit', description='Unit of weight measurement, for example KILOGRAM or OUNCE .')
Pagination ¶
Bases: EbayModel
count
class-attribute
instance-attribute
¶
count = Field(None, description='The number of results showing on the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The max number of entries that can be returned on a single page.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of items that will be skipped in the result set before returning the first item in the paginated response.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of results in a result set.')
PaginationInput ¶
Bases: EbayModel
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The max number of items, from the current result set, returned on a single page. Note: For getProductCompatibilities , the max value is 100. If no limit is specified, this field defaults to the max value.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of items that will be skipped in the result set before returning the first item in the paginated response. Combine offset with limit to control the items returned in the response. For example, if you supply an offset of 10 and a limit of 20, the first page of the response contains items 11-30 from the complete result set. Default: 0')
PaymentEnum ¶
Bases: OpenStrEnum
payment_see_description
class-attribute
instance-attribute
¶
payment_see_description = 'PAYMENT_SEE_DESCRIPTION'
Pictogram ¶
Bases: EbayModel
pictogram_id
class-attribute
instance-attribute
¶
pictogram_id = Field(None, alias='pictogramId', description='The identifier of the pictogram. For sample values, see Pictogram sample values .')
pictogram_description
class-attribute
instance-attribute
¶
pictogram_description = Field(None, alias='pictogramDescription', description='The description of the pictogram localized to the default language of the marketplace. For sample values, see Pictogram sample values .')
pictogram_url
class-attribute
instance-attribute
¶
pictogram_url = Field(None, alias='pictogramUrl', description='The URL of the pictogram.')
ProductIdentiferEnabledEnum ¶
ProductIdentifier ¶
Bases: EbayModel
ean
class-attribute
instance-attribute
¶
ean = Field(None, description='The EAN of the item, if applicable. EAN is the European Article Number, a barcode standard for retail product labeling primarily used outside of North America.')
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='The ePID (eBay Product Identifier) of the item, if applicable. ePID is a unique identifier used by eBay to track products in its catalog. Use the getProduct method of the Catalog API to retrieve the ePID of an item.')
isbn
class-attribute
instance-attribute
¶
isbn = Field(None, description='The ISBN of the item, if applicable. ISBN is the International Standard Book Number, a unique identifier for books.')
product_id
class-attribute
instance-attribute
¶
product_id = Field(None, alias='productId', description='The product ID of the item, if applicable. The product ID is a general term for a unique identifier assigned to a product.')
upc
class-attribute
instance-attribute
¶
upc = Field(None, description='The UPC of the item, if applicable. UPC stands for Universal Product Code, a unique identifier for products, primarily in North America.')
ProductSafetyLabelPictogram ¶
Bases: EbayModel
pictogram_description
class-attribute
instance-attribute
¶
pictogram_description = Field(None, alias='pictogramDescription', description='The description of the pictogram localized to the default language of the marketplace.')
pictogram_id
class-attribute
instance-attribute
¶
pictogram_id = Field(None, alias='pictogramId', description='The identifier of the pictogram.')
pictogram_url
class-attribute
instance-attribute
¶
pictogram_url = Field(None, alias='pictogramUrl', description='The URL of the pictogram.')
ProductSafetyLabelStatement ¶
Bases: EbayModel
statement_description
class-attribute
instance-attribute
¶
statement_description = Field(None, alias='statementDescription', description='The description of the statement localized to the default language of the marketplace.')
statement_id
class-attribute
instance-attribute
¶
statement_id = Field(None, alias='statementId', description='The identifier of the statement.')
ProductSafetyLabelsResponse ¶
Bases: EbayModel
pictograms
class-attribute
instance-attribute
¶
pictograms = Field(None, description='This array contains a list of pictograms of product safety labels for the specified marketplace.')
statements
class-attribute
instance-attribute
¶
statements = Field(None, description='This array contains available product safety labels statements for the specified marketplace.')
PropertyFilterInner ¶
Bases: EbayModel
property_name
class-attribute
instance-attribute
¶
property_name = Field(None, alias='propertyName', description="The name of the property being described. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category.")
property_value
class-attribute
instance-attribute
¶
property_value = Field(None, alias='propertyValue', description='The value for the property specified in the properyName field. For example, if the propertyName is Make , then the propertyValue will be the specific make of the vehicle, such as Toyota . Use the getCompatibilityPropertyValues to retrieve valid property values associated with a specified property name.')
unit_of_measurement
class-attribute
instance-attribute
¶
unit_of_measurement = Field(None, alias='unitOfMeasurement', description='The unit of measurement of the property being described, if applicable.')
url
class-attribute
instance-attribute
¶
url = Field(None, description='The URL associated with the property being described, if applicable.')
PropertyNamesRequest ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which to retrieve compatibility property names. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility.')
dataset
class-attribute
instance-attribute
¶
dataset = Field(None, description='This array defines the properties that will be returned for the compatibility-enabled category. For example, if you specify Searchable , the compatibility details will contain properties that can be used to search for products, such as make or model. Valid values: DisplayableProductDetails : Properties for use in a user interface to describe products.')
PropertyNamesResponsePropertyNameMetadata ¶
Bases: EbayModel
display_sequence
class-attribute
instance-attribute
¶
display_sequence = Field(None, alias='displaySequence', description='The numeric value indicating the ordering position of the property.')
PropertyNamesResponsePropertyNames ¶
Bases: EbayModel
property_display_name
class-attribute
instance-attribute
¶
property_display_name = Field(None, alias='propertyDisplayName', description='The display name of a property. This is the localized name of the compatible property.')
property_name
class-attribute
instance-attribute
¶
property_name = Field(None, alias='propertyName', description='The canonical name of a property. This value is used as part of the name-value pairs used to specify compatibility.')
property_name_metadata
class-attribute
instance-attribute
¶
property_name_metadata = Field(None, alias='propertyNameMetadata', description='The metadata for a property.')
PropertyValues ¶
Bases: EbayModel
property_name
class-attribute
instance-attribute
¶
property_name = Field(None, alias='propertyName', description="The name of the property. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.")
property_value
class-attribute
instance-attribute
¶
property_value = Field(None, alias='propertyValue', description='The value for the property specified in the properyName field. For example, if the propertyName is make , then the propertyValue will be the specific make of the vehicle, such as Toyota .')
PropertyValuesRequest ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which to retrieve compatibility property values. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility.')
property_filters
class-attribute
instance-attribute
¶
property_filters = Field(None, alias='propertyFilters', description='This array can be used to specify the compatibility properties used limit the result set. Only values associated with the specified name-value pairs will be returned in the response. For example, if the propertyName is set to Make and the propertyValue is set to Honda , only compatible Honda vehicles will be returned.')
property_name
class-attribute
instance-attribute
¶
property_name = Field(None, alias='propertyName', description="This field specifies the name of the property for which to retrieve associated property values. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category.")
sort_order
class-attribute
instance-attribute
¶
sort_order = Field(None, alias='sortOrder', description='This field specifies the sort order for the property values in the result set. Valid values: Ascending Descending Note: If no search order is specified, values are sorted in ascending order.')
PropertyValuesResponse ¶
Bases: EbayModel
metadata_version
class-attribute
instance-attribute
¶
metadata_version = Field(None, alias='metadataVersion', description='The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace.')
property_name
class-attribute
instance-attribute
¶
property_name = Field(None, alias='propertyName', description='The name of the property specified in the request.')
property_values
class-attribute
instance-attribute
¶
property_values = Field(None, alias='propertyValues', description='This array specifies the property values associated with the specified propertyName , in the specified category.')
RefundMethodEnum ¶
Bases: OpenStrEnum
RegulatoryAttributeEnum ¶
Bases: OpenStrEnum
manufacturer_contact
class-attribute
instance-attribute
¶
manufacturer_contact = 'MANUFACTURER_CONTACT'
ReturnMethodEnum ¶
Bases: OpenStrEnum
ReturnShippingCostPayerEnum ¶
SalesTaxJurisdiction ¶
Bases: EbayModel
sales_tax_jurisdiction_id
class-attribute
instance-attribute
¶
sales_tax_jurisdiction_id = Field(None, alias='salesTaxJurisdictionId', description='The unique ID for a sales-tax jurisdiction. Important! When countryCode is set to US , IDs for all 50 states, Washington, DC, and all US territories will be returned. However, the only salesTaxJurisdictionId values currently supported are: AS (American Samoa) GU (Guam MP Northern Mariana Islands PW (Palau) VI (US Virgin Islands)')
SalesTaxJurisdictions ¶
Bases: EbayModel
sales_tax_jurisdictions
class-attribute
instance-attribute
¶
sales_tax_jurisdictions = Field(None, alias='salesTaxJurisdictions', description='A list of sales-tax jurisdictions.')
ShippingCarrier ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='The localized description of the shipping carrier, such as UPS , FedEx , and USPS .')
shipping_carrier
class-attribute
instance-attribute
¶
shipping_carrier = Field(None, alias='shippingCarrier', description='An enumerated value describing the shipping carrier returned, for example, UPS , FedEx , and USPS . These values are needed when providing shipment tracking information for each specific shipping carrier.')
ShippingCarrierResponse ¶
Bases: EbayModel
shipping_carriers
class-attribute
instance-attribute
¶
shipping_carriers = Field(None, alias='shippingCarriers', description='A list of shipping carriers available for the marketplace.')
ShippingExcludeLocation ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='The localized location name.')
location
class-attribute
instance-attribute
¶
location = Field(None, description='The location or region to be excluded. Countries are returned through ISO 3166 codes . This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii).')
region
class-attribute
instance-attribute
¶
region = Field(None, description='The region of the excluded shipping area specified, such as: Africa Americas Asia Central America and Caribbean Europe Middle East North America Oceania South America Southeast Asia')
ShippingExcludeLocationResponse ¶
Bases: EbayModel
exclude_shipping_locations
class-attribute
instance-attribute
¶
exclude_shipping_locations = Field(None, alias='excludeShippingLocations', description='The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that the seller has designated as excluded shipping locations.')
ShippingHandlingTime ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='The localized description of the maximum handling time.')
extended_handling
class-attribute
instance-attribute
¶
extended_handling = Field(None, alias='extendedHandling', description='This field is only returned if its value is true . If returned, it indicates that the corresponding handling time is considered extended handling for the marketplace. Extended handling times may be used for freight shipping, but should generally be avoided if possible, as they might adversely affect the buying decisions of potential customers.')
max_handling_time
class-attribute
instance-attribute
¶
max_handling_time = Field(None, alias='maxHandlingTime', description="The integer value returned in this field indicates the maximum number of business days that the eBay site allows as a seller's handling time measured from when the buyer pays for the order. For example, if the maxHandlingTime value is set to 1 and a buyer pays for the order on a Wednesday, the seller would have to ship the item by the next day (Thursday).")
ShippingHandlingTimeResponse ¶
Bases: EbayModel
handling_times
class-attribute
instance-attribute
¶
handling_times = Field(None, alias='handlingTimes', description='A list of supported handling times for the marketplace.')
ShippingLocation ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='The localized location name.')
shipping_location
class-attribute
instance-attribute
¶
shipping_location = Field(None, alias='shippingLocation', description='The name or abbreviation of the shipping location or region. Countries are returned through ISO 3166 codes . This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii).')
ShippingLocationResponse ¶
Bases: EbayModel
shipping_locations
class-attribute
instance-attribute
¶
shipping_locations = Field(None, alias='shippingLocations', description='The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that can be set as shipping locations.')
ShippingService ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='This field returns the localized name of the shipping service.')
international_service
class-attribute
instance-attribute
¶
international_service = Field(None, alias='internationalService', description='A value of true indicates that the shipping service is international. An international shipping service option is required if an item is being shipped from one country (origin) to another (destination).')
max_shipping_time
class-attribute
instance-attribute
¶
max_shipping_time = Field(None, alias='maxShippingTime', description='This value indicates the maximum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService .')
min_shipping_time
class-attribute
instance-attribute
¶
min_shipping_time = Field(None, alias='minShippingTime', description='This value indicates the minimum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService .')
package_limits
class-attribute
instance-attribute
¶
package_limits = Field(None, alias='packageLimits', description='This container provides name-value pairs that specify physical constraints and measurement units of packages for the shippingCarrier and the corresponding shippingService . An empty container is returned if the shipping service does not have any package limits defined.')
shipping_carrier
class-attribute
instance-attribute
¶
shipping_carrier = Field(None, alias='shippingCarrier', description='The code for the shipping carrier returned, for example, UPS , FedEx , and USPS .')
shipping_category
class-attribute
instance-attribute
¶
shipping_category = Field(None, alias='shippingCategory', description='The shipping category of the shipping service including: ECONOMY , STANDARD , EXPEDITED , ONE_DAY , PICKUP , and other similar categories.')
shipping_cost_types
class-attribute
instance-attribute
¶
shipping_cost_types = Field(None, alias='shippingCostTypes', description='A list of shipping cost types that this shipping service option supports. For example, FLAT_RATE , CALCULATED , and FREIGHT .')
shipping_service
class-attribute
instance-attribute
¶
shipping_service = Field(None, alias='shippingService', description='The name of the shipping service. The shipping service named here can only be used in listings or in business policies if validForSellingFlow is true . The value returned in this field is used in listing APIs and business policies to set the shipping service.')
valid_for_selling_flow
class-attribute
instance-attribute
¶
valid_for_selling_flow = Field(None, alias='validForSellingFlow', description='A value of true indicates that the shippingService can be set as an available shipping service in the listing or through the fulfillment business policy.')
ShippingServiceResponse ¶
Bases: EbayModel
shipping_services
class-attribute
instance-attribute
¶
shipping_services = Field(None, alias='shippingServices', description='A complete list of shipping service options that can be used on the marketplace for shipping items.')
SignalWord ¶
Bases: EbayModel
signal_word_id
class-attribute
instance-attribute
¶
signal_word_id = Field(None, alias='signalWordId', description='The identifier of the signal word. For more information, see Signal word information .')
signal_word_description
class-attribute
instance-attribute
¶
signal_word_description = Field(None, alias='signalWordDescription', description='The description of the signal word localized to the default language of the marketplace. For more information, see Signal word information .')
SiteVisibilityPolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which metadata is being returned.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the category tree.')
cross_border_trade_australia_enabled
class-attribute
instance-attribute
¶
cross_border_trade_australia_enabled = Field(None, alias='crossBorderTradeAustraliaEnabled', description='If true , the category supports specifying that listings of a seller on the UK marketplace can pass in Australia as a value in a field to expose that item on the eBay Australia site (ebay.com.au). For more information, see Cross-border trading .')
cross_border_trade_gb_enabled
class-attribute
instance-attribute
¶
cross_border_trade_gb_enabled = Field(None, alias='crossBorderTradeGBEnabled', description='If true , the category supports specifying that listings of a seller on the US or Canada marketplaces can pass in UK as a value in a field to expose that item on the eBay UK (ebay.co.uk) and eBay IE (ebay.ie) sites. For more information, see Cross-border trading .')
cross_border_trade_north_america_enabled
class-attribute
instance-attribute
¶
cross_border_trade_north_america_enabled = Field(None, alias='crossBorderTradeNorthAmericaEnabled', description='If true , the category supports specifying that listings of a seller on the US or Canada marketplaces can pass in North America as a value in a field to expose that item on the eBay US (ebay.com) and eBay Canada (ebay.ca) sites (English). For more information, see Cross-border trading .')
SortOrderProperties ¶
Bases: EbayModel
order
class-attribute
instance-attribute
¶
order = Field(None, description='Defines the order of the sort. Valid values : Ascending Descending')
property_name
class-attribute
instance-attribute
¶
property_name = Field(None, alias='propertyName', description="The name of the searchable property to be used for sorting. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.")
TimeDurationUnitEnum ¶
Bases: OpenStrEnum
UsageEnum ¶
Bases: OpenStrEnum
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='The three-letter ISO 4217 code representing the currency of the amount in the value field. Restriction: Only the currency of the marketplace is supported. For example, on the US marketplace the only currency supported is USD.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount, in the currency specified by the currency field.')
AutomotivePartsCompatibilityPolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The category ID to which the automotive parts compatibility policies apply.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.')
compatibility_based_on
class-attribute
instance-attribute
¶
compatibility_based_on = Field(None, alias='compatibilityBasedOn', description='Indicates whether the category supports parts compatibility by either ASSEMBLY or by SPECIFICATION . Note: Only categories returning the compatibilityBasedOn field support compatibility. Categories where all compatibility fields are missing, or where only compatibilityBasedOn is missing, should be considered as not supporting compatibility.')
compatible_vehicle_types
class-attribute
instance-attribute
¶
compatible_vehicle_types = Field(None, alias='compatibleVehicleTypes', description='Indicates the compatibility classification of the part based on high-level vehicle types.')
max_number_of_compatible_vehicles
class-attribute
instance-attribute
¶
max_number_of_compatible_vehicles = Field(None, alias='maxNumberOfCompatibleVehicles', description='Specifies the maximum number of compatible vehicle-applications allowed per item.')
CategoryPolicy ¶
Bases: EbayModel
auto_pay_enabled
class-attribute
instance-attribute
¶
auto_pay_enabled = Field(None, alias='autoPayEnabled', description="If this field is returned as true , the corresponding category supports immediate payment for listings. The immediate payment feature is applicable to fixed-price listings, to auction listings with the 'Buy It Now' option enabled, and for a motor vehicle listing that requires an initial deposit.")
b2b_vat_enabled
class-attribute
instance-attribute
¶
b2b_vat_enabled = Field(None, alias='b2bVatEnabled', description='If this field is returned as true , the corresponding category supports business-to-business (B2B) VAT listings. If this field is not present, the category does not have B2B VAT listings. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only. This field is only returned when true (not returned when false).')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which metadata is being returned.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the category tree.')
ean_support
class-attribute
instance-attribute
¶
ean_support = Field(None, alias='eanSupport', description='This enumerated value indicates whether or not European Article Numbers (EANs) are supported/required when listing products in the category.')
expired
class-attribute
instance-attribute
¶
expired = Field(None, description='If this field is returned as true , the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. You can use the getExpiredCategories method (of the Taxonomy API ) to find the leaf category that replaced the expired category. This field is only returned when true (not returned when false).')
intangible_enabled
class-attribute
instance-attribute
¶
intangible_enabled = Field(None, alias='intangibleEnabled', description='If this field is returned as true , the category supports the listing of intangible goods or services.')
isbn_support
class-attribute
instance-attribute
¶
isbn_support = Field(None, alias='isbnSupport', description='This enumerated value indicates whether or not International Standard Book Numbers (ISBNs) are supported/required when listing products in the specified category.')
lsd
class-attribute
instance-attribute
¶
lsd = Field(None, description='If this field (Lot Size Disabled) is returned as true , the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction. This field is only returned when true (not returned when false).')
minimum_reserve_price
class-attribute
instance-attribute
¶
minimum_reserve_price = Field(None, alias='minimumReservePrice', description='Indicates the Minimum Reserve Price for an auction listing in this category. If there is no Minimum Reserve Price, a value of 0.0 is returned in this field.')
orpa
class-attribute
instance-attribute
¶
orpa = Field(None, description="This field (Override Reserve Price Allowed) is returned as true if the eBay marketplace's default policy is to allow reserve prices for auction listings, but the corresponding category does not allow a reserve price. Note: This field is not returned if the marketplace does not permit reserve prices.")
orra
class-attribute
instance-attribute
¶
orra = Field(None, description='If this field (Override Reduce Reserve Allowed) is returned as true , the seller can reduce or remove a reserve price that had already been reduced for an active auction listing.')
payment_methods
class-attribute
instance-attribute
¶
payment_methods = Field(None, alias='paymentMethods', description='An array that indicates the acceptable offline payment methods that can be used when listing an item for sale in the corresponding category.')
reduce_reserve_allowed
class-attribute
instance-attribute
¶
reduce_reserve_allowed = Field(None, alias='reduceReserveAllowed', description="If this field (Reduce Reserve Allowed) is true , the corresponding leaf category allows the seller to reduce an item's reserve price. If false, this field is not returned in the response and the corresponding leaf category on the site do not normally allow sellers to reduce an item's reserve price. This field is only returned when true (not returned when false).")
reserve_price_allowed
class-attribute
instance-attribute
¶
reserve_price_allowed = Field(None, alias='reservePriceAllowed', description='This field indicates whether reserve prices are allowed for auction listings in this category. This field returns as true when the category supports reserve prices, or false if the eBay marketplace does not permit reserve prices or the category override blocks reserve prices ( orpa is true ).')
upc_support
class-attribute
instance-attribute
¶
upc_support = Field(None, alias='upcSupport', description='This enumerated value indicates whether or not the category on the specified eBay site supports the use of Universal Product Codes (UPCs) to help create a listing.')
value_category
class-attribute
instance-attribute
¶
value_category = Field(None, alias='valueCategory', description='When returned as true , this boolean indicates that the leaf category for the specified site is designated by eBay as a value category. Value categories can be used as a secondary category for a listing at no extra charge.')
virtual
class-attribute
instance-attribute
¶
virtual = Field(None, description='If this field is returned as true , the corresponding category is an eBay virtual category, a category in which items may not be listed. This field is only returned when true (not returned when false).')
Compatibility ¶
Bases: EbayModel
compatibility_details
class-attribute
instance-attribute
¶
compatibility_details = Field(None, alias='compatibilityDetails', description='This array returns a list of compatibility details associated with the specified property name(s).')
Currency ¶
Bases: EbayModel
code
class-attribute
instance-attribute
¶
code = Field(None, description='The three-letter ISO 4217 code returned. Restriction: Only the currency of the marketplace is supported. Examples: on the US marketplace, the only currency supported is the United States dollar, USD ; on the Canadian marketplace, the only currency supported is the Canadian dollar, CAD .')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The description of the returned three-letter code. For example, if the code is USD , the description returned would be US Dollar .')
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.')
ErrorDetailV3 ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description="The category type for this error or warning. It takes an ErrorCategory object which can have one of three values: Application : Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.")
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name of the domain containing the service or application.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description="Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.")
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='An expanded version of message that should be around 100-200 characters long, but is not required to be such.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId .')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value .')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description="Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain.")
ExtendedProducerResponsibility ¶
Bases: EbayModel
enabled_for_variations
class-attribute
instance-attribute
¶
enabled_for_variations = Field(None, alias='enabledForVariations', description='An indication of whether the attribute can be enabled for listing variations. If the value is true , the attribute may be specified at the variation level.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the attribute included in the policy.')
usage
class-attribute
instance-attribute
¶
usage = Field(None, description='The usage guidelines for the attribute, in the specified marketplace.')
ExtendedProducerResponsibilityPolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier for the category under which the policy applies.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier for the category tree under which the policy applies.')
supported_attributes
class-attribute
instance-attribute
¶
supported_attributes = Field(None, alias='supportedAttributes', description='The details regarding the attributes included in the policy, such as their usage guidelines and whether they can be specified at the listing variation level.')
ExtendedProducerResponsibilityPolicyResponse ¶
Bases: EbayModel
extended_producer_responsibilities
class-attribute
instance-attribute
¶
extended_producer_responsibilities = Field(None, alias='extendedProducerResponsibilities', description='An array of response fields detailing the Extended Producer Responsibility policies supported for the specified marketplace.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A collection of warnings generated for the request.')
GetCurrenciesResponse ¶
Bases: EbayModel
default_currency
class-attribute
instance-attribute
¶
default_currency = Field(None, alias='defaultCurrency', description='This field specifies the default currency used by the marketplace.')
marketplace_id
class-attribute
instance-attribute
¶
marketplace_id = Field(None, alias='marketplaceId', description='The ID of the eBay marketplace to which the default currency applies.')
HazardousMaterialDetailsResponse ¶
Bases: EbayModel
signal_words
class-attribute
instance-attribute
¶
signal_words = Field(None, alias='signalWords', description='This array contains available hazardous materials signal words for the specified marketplace.')
statements
class-attribute
instance-attribute
¶
statements = Field(None, description='This array contains available hazardous materials hazard statements for the specified marketplace.')
pictograms
class-attribute
instance-attribute
¶
pictograms = Field(None, description='This array contains available hazardous materials hazard pictograms for the specified marketplace.')
ItemConditionDescriptorConstraint ¶
Bases: EbayModel
applicable_to_condition_descriptor_ids
class-attribute
instance-attribute
¶
applicable_to_condition_descriptor_ids = Field(None, alias='applicableToConditionDescriptorIds', description='This array is returned if the corresponding condition descriptor requires that one or more other associated condition descriptors must also be specified in a listing. The condition descriptor IDs for the associated condition descriptors are returned here. For example, the Grade and Grader condition descriptors must always be specified together in a listing for Graded cards.')
cardinality
class-attribute
instance-attribute
¶
cardinality = Field(None, description='The value returned in this field indicates whether a condition descriptor can have a single value or multiple values.')
default_condition_descriptor_value_id
class-attribute
instance-attribute
¶
default_condition_descriptor_value_id = Field(None, alias='defaultConditionDescriptorValueId', description='The default condition descriptor value that will be set if there are multiple values.')
max_length
class-attribute
instance-attribute
¶
max_length = Field(None, alias='maxLength', description='The maximum characters allowed for a condition descriptor. This field is only returned/applicable for condition descriptors that allow free text for condition descriptor values.')
mode
class-attribute
instance-attribute
¶
mode = Field(None, description='The value returned in this field indicates whether the supported values for a condition descriptor are predefined or if the seller manually specified the value. Note: FREE_TEXT is currently only applicable to the Certification Number condition descriptor.')
usage
class-attribute
instance-attribute
¶
usage = Field(None, description='This value indicates whether or not the condition descriptor is required for the item condition. Currently, this field is only returned if the condition descriptor is required for the item condition.')
ItemConditionDescriptorValue ¶
Bases: EbayModel
condition_descriptor_value_additional_help_text
class-attribute
instance-attribute
¶
condition_descriptor_value_additional_help_text = Field(None, alias='conditionDescriptorValueAdditionalHelpText', description='Additional information about the the condition of the item that is not included in the conditionDescriptorValueHelpText field.')
condition_descriptor_value_constraints
class-attribute
instance-attribute
¶
condition_descriptor_value_constraints = Field(None, alias='conditionDescriptorValueConstraints', description='The constraints on a condition descriptor value, such as which descriptor value IDs and Descriptor ID it is associated with.')
condition_descriptor_value_help_text
class-attribute
instance-attribute
¶
condition_descriptor_value_help_text = Field(None, alias='conditionDescriptorValueHelpText', description='A detailed description of the condition descriptor value.')
condition_descriptor_value_id
class-attribute
instance-attribute
¶
condition_descriptor_value_id = Field(None, alias='conditionDescriptorValueId', description='The unique identification number of a condition descriptor value associated with the conditionDescriptorValueName .')
condition_descriptor_value_name
class-attribute
instance-attribute
¶
condition_descriptor_value_name = Field(None, alias='conditionDescriptorValueName', description='The human-readable label for the condition descriptor value associated with the conditionDescriptorValueID .')
ListingDuration ¶
Bases: EbayModel
duration_values
class-attribute
instance-attribute
¶
duration_values = Field(None, alias='durationValues', description='This array defines the supported time duration options available for the listing type.')
listing_type
class-attribute
instance-attribute
¶
listing_type = Field(None, alias='listingType', description='The enumerated value returned in this field indicates the listing type for the duration value(s).')
ListingStructurePolicyResponse ¶
Bases: EbayModel
listing_structure_policies
class-attribute
instance-attribute
¶
listing_structure_policies = Field(None, alias='listingStructurePolicies', description='Returns a list of category IDs plus a flag indicating whether or not each listed category supports item variations.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
ListingTypePolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which metadata is being returned.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the category tree.')
digital_good_delivery_enabled
class-attribute
instance-attribute
¶
digital_good_delivery_enabled = Field(None, alias='digitalGoodDeliveryEnabled', description="A true value in this field indicates that the leaf category supports the listing of items (such as gift cards) that can be delivered electronically via a download link or sent to a buyer's email address.")
listing_durations
class-attribute
instance-attribute
¶
listing_durations = Field(None, alias='listingDurations', description='An array of eBay listing types and the supported durations for the corresponding leaf category. If a specific eBay listing type does not appear for a leaf category, it indicates that the category does not support that listing type.')
pickup_drop_off_enabled
class-attribute
instance-attribute
¶
pickup_drop_off_enabled = Field(None, alias='pickupDropOffEnabled', description="A true value in this field indicates that items listed in the category (specified in the listingTypePolicies.categoryId field) may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on an eBay site and collect them at a local store. Buyers are notified by eBay once their items are available.")
MinimumListingPricePoliciesType ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='The description of the listing type for which the pricing data is intended, such as "Pricing for the auction-like listings".')
listing_type
class-attribute
instance-attribute
¶
listing_type = Field(None, alias='listingType', description='This enum value indicates the listing type for which minimum starting price policies are being returned. Note: The only applicable values for this method are AUCTION and FIXED_PRICE_ITEM .')
min_buy_it_now_price_percent
class-attribute
instance-attribute
¶
min_buy_it_now_price_percent = Field(None, alias='minBuyItNowPricePercent', description='The minimum percentage value that a Buy It Now price for an auction listing must be above the starting bid price for the same listing. This field is only returned and applicable for auction listings.')
start_price
class-attribute
instance-attribute
¶
start_price = Field(None, alias='startPrice', description="For auction listings, this field indicates the lowest dollar value that can be set for the item's starting bid. For fixed-price listings, this field indicates the lower dollar value that can be set for the item's sale price.")
MotorsListingPoliciesResponse ¶
Bases: EbayModel
motors_listing_policies
class-attribute
instance-attribute
¶
motors_listing_policies = Field(None, alias='motorsListingPolicies', description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
MultiCompatibilityPropertyValuesRequest ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which to retrieve property values. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility.')
property_filters
class-attribute
instance-attribute
¶
property_filters = Field(None, alias='propertyFilters', description='This array can be used to specify the compatibility properties used to limit the result set. Only values associated with the specified name-value pairs will be returned in the response. For example, if the propertyName is set to Year and the propertyValue is set to 2022 , only compatible vehicles from 2022 will be returned. At least one property name-value pair must be used.')
property_names
class-attribute
instance-attribute
¶
property_names = Field(None, alias='propertyNames', description="This comma-delimited array specifies the names of the properties for which to retrieve associated property values. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.")
MultiCompatibilityPropertyValuesResponse ¶
Bases: EbayModel
compatibilities
class-attribute
instance-attribute
¶
compatibilities = Field(None, description='This container defines the compatibility details associated with the specified property name value(s).')
metadata_version
class-attribute
instance-attribute
¶
metadata_version = Field(None, alias='metadataVersion', description='The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace.')
NegotiatedPricePolicyResponse ¶
Bases: EbayModel
negotiated_price_policies
class-attribute
instance-attribute
¶
negotiated_price_policies = Field(None, alias='negotiatedPricePolicies', description='A list of category IDs and the policies related to negotiated-price items for each of the listed categories.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
ProductResponseCompatibilityDetails ¶
Bases: EbayModel
note_details
class-attribute
instance-attribute
¶
note_details = Field(None, alias='noteDetails', description='This array returns additional comments about the corresponding product in the form of name-value pairs.')
product_details
class-attribute
instance-attribute
¶
product_details = Field(None, alias='productDetails', description='This array returns details about the product in the form of name-value pairs.')
PropertyNamesResponseProperties ¶
Bases: EbayModel
dataset
class-attribute
instance-attribute
¶
dataset = Field(None, description='This field defines the types of properties are returned for the specified catalog-enabled category. Valid values: DisplayableProductDetails : Properties for use in a user interface to describe products. DisplayableSearchResults : Properties for use in results for product searches. Searchable : Properties for use in searches. Sortable : Properties that are suitable for sorting.')
property_names
class-attribute
instance-attribute
¶
property_names = Field(None, alias='propertyNames', description="This array specifies the names of the properties associated with the specified category in the specified marketplace. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category.")
RegulatoryAttribute ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='A unique value identifying a specific regulatory attribute.')
usage
class-attribute
instance-attribute
¶
usage = Field(None, description='The enumeration value in this field indicates whether the corresponding attribute is recommended or required for the corresponding leaf category.')
RegulatoryPolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the leaf category to which the corresponding policies pertain.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the category tree, which reflects the specified marketplace.')
supported_attributes
class-attribute
instance-attribute
¶
supported_attributes = Field(None, alias='supportedAttributes', description='A list of supported regulatory attributes for this marketplace.')
RegulatoryPolicyResponse ¶
Bases: EbayModel
regulatory_policies
class-attribute
instance-attribute
¶
regulatory_policies = Field(None, alias='regulatoryPolicies', description='A list of eBay policies that define whether or not you must include required regulatory information for leaf categories on the given marketplace.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
ShippingPolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which metadata is being returned.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='The unique identifier of the category tree.')
global_shipping_enabled
class-attribute
instance-attribute
¶
global_shipping_enabled = Field(None, alias='globalShippingEnabled', description='Indicates if the Global Shipping Program (GSP) is supported for the category. Note: GSP is only supported by the eBay UK marketplace ( EBAY_GB ).')
group1_max_flat_shipping_cost
class-attribute
instance-attribute
¶
group1_max_flat_shipping_cost = Field(None, alias='group1MaxFlatShippingCost', description='Returns the applicable max cap per shipping cost for shipping service group1.')
group2_max_flat_shipping_cost
class-attribute
instance-attribute
¶
group2_max_flat_shipping_cost = Field(None, alias='group2MaxFlatShippingCost', description='Returns the applicable max cap per shipping cost for shipping service group2.')
group3_max_flat_shipping_cost
class-attribute
instance-attribute
¶
group3_max_flat_shipping_cost = Field(None, alias='group3MaxFlatShippingCost', description='Returns the applicable max cap per shipping cost for shipping service group3.')
handling_time_enabled
class-attribute
instance-attribute
¶
handling_time_enabled = Field(None, alias='handlingTimeEnabled', description="Indicates if a seller's stated handling time is enabled for a category. A handling time is generally needed for items that are shipped to the buyer, but not necessarily applicable to freight shipping or local pickup.")
max_flat_shipping_cost
class-attribute
instance-attribute
¶
max_flat_shipping_cost = Field(None, alias='maxFlatShippingCost', description='The maximum cost the seller can charge for the first domestic flat-rate shipping service. Mutually exclusive with the GroupNMaxFlatShippingCost elements.')
shipping_terms_required
class-attribute
instance-attribute
¶
shipping_terms_required = Field(None, alias='shippingTermsRequired', description='Indicates whether the category requires sellers to specify shipping details at listing time.')
SiteVisibilityPoliciesResponse ¶
Bases: EbayModel
site_visibility_policies
class-attribute
instance-attribute
¶
site_visibility_policies = Field(None, alias='siteVisibilityPolicies', description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
SortOrderInner ¶
Bases: EbayModel
sort_order
class-attribute
instance-attribute
¶
sort_order = Field(None, alias='sortOrder', description='This container is used to define the property to be used in the sorting.')
sort_priority
class-attribute
instance-attribute
¶
sort_priority = Field(None, alias='sortPriority', description='The priority of the specified sort order provided. For example, when a property is assigned Sort1 , its values are sorted first. Values for the property assigned Sort2 are sorted second, and so on. Valid values : Sort1 Sort2 Sort3 Sort4 Sort5')
SpecificationRequest ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay leaf category for which compatibility details are being retrieved. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcycles.')
compatibility_property_filters
class-attribute
instance-attribute
¶
compatibility_property_filters = Field(None, alias='compatibilityPropertyFilters', description='This comma-delimited array can be used to restrict the number of compatible application name-value pairs returned in the response by specifying the properties that the seller wishes to be included in the response. Only compatible applications with the specified properties will be returned. Properties that can be specified here include make, model, year, and trim.')
dataset
class-attribute
instance-attribute
¶
dataset = Field(None, description='This field can be used to define the type of properties that will be returned in the response. For example, if you specify Searchable , the compatibility details will contain properties that can be used to search for products, such as make or model. Note: This field cannot be used alongside dataPropertyName . If both are used, an error will occur.')
dataset_property_name
class-attribute
instance-attribute
¶
dataset_property_name = Field(None, alias='datasetPropertyName', description='This comma-delimited array can be used to define the specific property name(s) that will be returned in the response. For example, if you specify Engine , the result set will only contain engines that are compatible with the input criteria. Note: This array cannot be used alongside dataset . If both are used, an error will occur.')
exact_match
class-attribute
instance-attribute
¶
exact_match = Field(None, alias='exactMatch', description='This boolean can be used to specify that the compatibilities returned in the response are to be defined by an exact match on the input value of specification properties. By default, an expanded compatibility match is done when it applies, such as for Load Index, where a compatible vehicle is one that has a load index requirement that is less than or equal to the input.')
pagination_input
class-attribute
instance-attribute
¶
pagination_input = Field(None, alias='paginationInput', description='Important! Pagination is not yet supported by this method. If this container is included in the request, it will be ignored.')
sort_orders
class-attribute
instance-attribute
¶
sort_orders = Field(None, alias='sortOrders', description='This array specifies the sorting order of the compatibility properties. Any of the searchable properties can be used to specify search order. Up to 5 levels of sort order may be specified. Note: If no sort order is specified through this field, the default sort order of popularity descending is applied.')
specifications
class-attribute
instance-attribute
¶
specifications = Field(None, description='This array defines the specifications of the part, in the form of name-value pairs, for which compatible applications will be retrieved.')
SpecificationResponse ¶
Bases: EbayModel
compatibility_details
class-attribute
instance-attribute
¶
compatibility_details = Field(None, alias='compatibilityDetails', description='This container returns the list of all compatible application name-value pairs for the given filter criteria.')
pagination
class-attribute
instance-attribute
¶
pagination = Field(None, description='Important! Not currently returned. For future use.')
TimeDuration ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='A time-measurement unit that specifies a singular period of time. A span of time is defined when you apply the value specified in the value field to the value specified for unit . Time-measurement units can be YEAR, MONTH, DAY, and so on. See TimeDurationUnitEnum for a complete list of possible time-measurement units.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.')
AutomotivePartsCompatibilityPolicyResponse ¶
Bases: EbayModel
automotive_parts_compatibility_policies
class-attribute
instance-attribute
¶
automotive_parts_compatibility_policies = Field(None, alias='automotivePartsCompatibilityPolicies', description='A list of category IDs and the automotive parts compatibility policies for each of the listed categories.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
CategoryPolicyResponse ¶
Bases: EbayModel
category_policies
class-attribute
instance-attribute
¶
category_policies = Field(None, alias='categoryPolicies', description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
ClassifiedAdPolicyResponse ¶
Bases: EbayModel
classified_ad_policies
class-attribute
instance-attribute
¶
classified_ad_policies = Field(None, alias='classifiedAdPolicies', description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
GetMinimumListingPricePoliciesResponse ¶
Bases: EbayModel
minimum_listing_price_policies
class-attribute
instance-attribute
¶
minimum_listing_price_policies = Field(None, alias='minimumListingPricePolicies', description='This array returns a list of minimum listing price policies for supported types of listings on the specific marketplace')
ItemConditionDescriptor ¶
Bases: EbayModel
condition_descriptor_constraint
class-attribute
instance-attribute
¶
condition_descriptor_constraint = Field(None, alias='conditionDescriptorConstraint', description='This container shows the constraints on a condition descriptor, such as the maximum length, default condition descriptor value ID, cardinality, mode, usage, and applicable descriptor IDs.')
condition_descriptor_help_text
class-attribute
instance-attribute
¶
condition_descriptor_help_text = Field(None, alias='conditionDescriptorHelpText', description='A description of the condition descriptor that directs a user to its condition descriptor values. For example, the help text for Card Condition is Select ungraded condition .')
condition_descriptor_id
class-attribute
instance-attribute
¶
condition_descriptor_id = Field(None, alias='conditionDescriptorId', description='The unique identification number of a condition descriptor associated with with a conditionDescriptorName . For example, 40001 is the ID for Card Condition . These IDs are used in the addItem family of calls of the Trading API to provide condition descriptor names for the item.')
condition_descriptor_name
class-attribute
instance-attribute
¶
condition_descriptor_name = Field(None, alias='conditionDescriptorName', description='The human-readable label for the condition descriptor associated with the conditionDescriptorID . For example, Card Condition is the condition descriptor name for ID 40001')
condition_descriptor_values
class-attribute
instance-attribute
¶
condition_descriptor_values = Field(None, alias='conditionDescriptorValues', description='This array shows the possible values that map to the corresponding conditionDescriptorName values. Constraint information and help text are also shown for each value. For example, The ID 40001 is ID for the condition descriptor card condition . The ID 400012 is the ID for the Very Good card condition value.')
ListingTypePoliciesResponse ¶
Bases: EbayModel
listing_type_policies
class-attribute
instance-attribute
¶
listing_type_policies = Field(None, alias='listingTypePolicies', description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
ProductRequest ¶
Bases: EbayModel
application_property_filters
class-attribute
instance-attribute
¶
application_property_filters = Field(None, alias='applicationPropertyFilters', description="This array is used to filter the properties of an application, such as a vehicle's make or model, that will be returned in the response. Application property filters are specified as name-value pairs. Only products compatible with these name-value pairs will be returned.")
dataset
class-attribute
instance-attribute
¶
dataset = Field(None, description='This array defines the type of properties that are returned for the catalog-enabled category. For example, if you specify Searchable , the compatibility details will contain properties that can be used to search for products, such as make or model. Note: This field cannot be used alongside dataPropertyName . If both are used, an error will occur.')
dataset_property_name
class-attribute
instance-attribute
¶
dataset_property_name = Field(None, alias='datasetPropertyName', description='This comma-delimted array can be used to define the specific property name(s) that will be returned in the response. For example, if you specify Engine , the result set will only contain engines that are compatible with the input criteria. Note: This array cannot be used alongside dataset . If both are used, an error will occur.')
disabled_product_filter
class-attribute
instance-attribute
¶
disabled_product_filter = Field(None, alias='disabledProductFilter', description='This container can be used to specify whether or not to filter out products which are disabled for selling on eBay and/or disabled for product review.')
pagination_input
class-attribute
instance-attribute
¶
pagination_input = Field(None, alias='paginationInput', description='This container controls the pagination of the result set.')
product_identifier
class-attribute
instance-attribute
¶
product_identifier = Field(None, alias='productIdentifier', description='This container is used to provide unique identifier for the product. The product identifier consists of an identifier type and value, and are unique across all sites.')
sort_orders
class-attribute
instance-attribute
¶
sort_orders = Field(None, alias='sortOrders', description='This array controls the sort order of compatibility properties.')
ProductResponse ¶
Bases: EbayModel
compatibility_details
class-attribute
instance-attribute
¶
compatibility_details = Field(None, alias='compatibilityDetails', description='This container provides compatibility details for the specified product.')
pagination
class-attribute
instance-attribute
¶
pagination = Field(None, description='This container returns the pagination settings for the result set.')
PropertyNamesResponse ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the eBay category specified in the request.')
properties
class-attribute
instance-attribute
¶
properties = Field(None, description='This array contains all of the properties for the specified category.')
ReturnPolicyDetails ¶
Bases: EbayModel
policy_description_enabled
class-attribute
instance-attribute
¶
policy_description_enabled = Field(None, alias='policyDescriptionEnabled', description="If set to true , this flag indicates you can supply a detailed return policy description within your return policy (for example, by populating the returnInstructions field in the Account API's createReturnPolicy ). User-supplied return policy details are allowed only in the DE, ES, FR, and IT marketplaces.")
refund_methods
class-attribute
instance-attribute
¶
refund_methods = Field(None, alias='refundMethods', description='A list of refund methods allowed for the associated category. Note: Depending on the API used to setup your return policy, available refund methods are defined differently.')
return_methods
class-attribute
instance-attribute
¶
return_methods = Field(None, alias='returnMethods', description='A list of return methods allowed for the associated category. Note: Depending on the API used to setup your return policy, available return methods are defined differently.')
return_periods
class-attribute
instance-attribute
¶
return_periods = Field(None, alias='returnPeriods', description='A list of return periods allowed for the associated category. Note: Depending on the API used to setup your return policy, return periods are defined differently. Account v1 API When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use the returnPeriod and internationalOverride.returnPeriod containers to set the return period(s) for the business policy.')
returns_acceptance_enabled
class-attribute
instance-attribute
¶
returns_acceptance_enabled = Field(None, alias='returnsAcceptanceEnabled', description='A value of true in this field indicates that return policies are applicable to the corresponding leaf category.')
return_shipping_cost_payers
class-attribute
instance-attribute
¶
return_shipping_cost_payers = Field(None, alias='returnShippingCostPayers', description='A list of allowed values for who pays for the return shipping cost. Note that for SNAD returns, the seller is always responsible for the return shipping cost. Note: Depending on the API used to setup your return policy, specifiying that the buyer or seller is responsible for paying for return shipping costs is defined differently.')
ShippingPoliciesResponse ¶
Bases: EbayModel
shipping_policies
class-attribute
instance-attribute
¶
shipping_policies = Field(None, alias='shippingPolicies', description='This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter .')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
ItemCondition ¶
Bases: EbayModel
condition_description
class-attribute
instance-attribute
¶
condition_description = Field(None, alias='conditionDescription', description='The human-readable label for the condition (e.g., "New"). This value is typically localized for each site. Note that the display name can vary by category. For example, the description for condition ID 1000 could be called "New: with Tags" in one category and "Brand New" in another. For details on condition IDs and descriptions, see Item condition ID and name values .')
condition_descriptors
class-attribute
instance-attribute
¶
condition_descriptors = Field(None, alias='conditionDescriptors', description='This array contains the possible condition descriptors and condition descriptor values applicable for the specified category. It also returns usage requirements, maximum length, cardinality, and help text. Note: This array is only returned for categories that support condition descriptors.')
condition_help_text
class-attribute
instance-attribute
¶
condition_help_text = Field(None, alias='conditionHelpText', description='A detailed description of the condition denoted by the conditionID and conditionDescription .')
condition_id
class-attribute
instance-attribute
¶
condition_id = Field(None, alias='conditionId', description='The ID value of the selected item condition. For information on the supported condition ID values, see Item condition ID and name values .')
usage
class-attribute
instance-attribute
¶
usage = Field(None, description="The value returned in this field indicates if there are any usage restrictions or requirements for the corresponding item condition in the corresponding category. Note: Currently, the only supported value is 'RESTRICTED', and this field will only be returned for the following conditions: 2000, 2010, 2020, 2030. Sellers must be pre-approved to use any of these item conditions.")
ItemConditionPolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The category ID to which the item-condition policy applies.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.')
item_condition_required
class-attribute
instance-attribute
¶
item_condition_required = Field(None, alias='itemConditionRequired', description='This flag denotes whether or not you must list the item condition in a listing for the specified category. If set to true , you must specify an item condition for the associated category.')
item_conditions
class-attribute
instance-attribute
¶
item_conditions = Field(None, alias='itemConditions', description="The item-condition values allowed in the category. Note: The ‘Seller Refurbished’ item condition (condition ID 2500) has been replaced by the 'Excellent - Refurbished', 'Very Good - Refurbished', and 'Good - Refurbished' item conditions in a select number of eBay marketplaces and categories.")
ItemConditionPolicyResponse ¶
Bases: EbayModel
item_condition_policies
class-attribute
instance-attribute
¶
item_condition_policies = Field(None, alias='itemConditionPolicies', description="A list of category IDs and the policies for how to indicate an item's condition in each of the listed categories.")
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')
ReturnPolicy ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The category ID to which the return policies apply.')
category_tree_id
class-attribute
instance-attribute
¶
category_tree_id = Field(None, alias='categoryTreeId', description='A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree.')
domestic
class-attribute
instance-attribute
¶
domestic = Field(None, description='This complex type defines the category policies related to domestic item returns.')
international
class-attribute
instance-attribute
¶
international = Field(None, description='This complex type defines the category policies related to international item returns.')
required
class-attribute
instance-attribute
¶
required = Field(None, description='If set to true , this flag indicates that you must specify a return policy for items listed in the associated category. Note that not accepting returns (setting returnsAcceptedEnabled to false ) is a valid return policy.')
ReturnPolicyResponse ¶
Bases: EbayModel
return_policies
class-attribute
instance-attribute
¶
return_policies = Field(None, alias='returnPolicies', description='A list of elements, where each contains a category ID and a flag that indicates whether or not listings in that category require a return policy.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request.')