Browse API — client.buy.browse¶
Version v1.20.4 · base path /buy/browse/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
search ¶
search(*, aspect_filter: str | None = None, auto_correct: str | None = None, category_ids: str | None = None, charity_ids: str | None = None, compatibility_filter: str | None = None, epid: str | None = None, fieldgroups: str | None = None, filter: str | None = None, gtin: str | None = None, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: Literal[False] = False) -> buy_browse_models.SearchPagedCollection
search(*, aspect_filter: str | None = None, auto_correct: str | None = None, category_ids: str | None = None, charity_ids: str | None = None, compatibility_filter: str | None = None, epid: str | None = None, fieldgroups: str | None = None, filter: str | None = None, gtin: str | None = None, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: Literal[True]) -> httpx.Response
search(*, aspect_filter: str | None = None, auto_correct: str | None = None, category_ids: str | None = None, charity_ids: str | None = None, compatibility_filter: str | None = None, epid: str | None = None, fieldgroups: str | None = None, filter: str | None = None, gtin: str | None = None, limit: int | str | None = None, offset: int | str | None = None, q: str | None = None, sort: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: bool = False) -> buy_browse_models.SearchPagedCollection | httpx.Response
This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these. Note: Only listings where FIXED_PRICE (Buy It Now) is a buying option are returned by default.
search_by_image ¶
search_by_image(*, body: SearchByImageRequest | None = None, aspect_filter: str | None = None, category_ids: str | None = None, charity_ids: str | None = None, fieldgroups: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: Literal[False] = False) -> buy_browse_models.SearchPagedCollection
search_by_image(*, body: SearchByImageRequest | None = None, aspect_filter: str | None = None, category_ids: str | None = None, charity_ids: str | None = None, fieldgroups: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: Literal[True]) -> httpx.Response
search_by_image(*, body: SearchByImageRequest | None = None, aspect_filter: str | None = None, category_ids: str | None = None, charity_ids: str | None = None, fieldgroups: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: bool = False) -> buy_browse_models.SearchPagedCollection | httpx.Response
This method searches for eBay items based on an image and retrieves summaries of the items. You pass in a Base64 image in the request payload and can refine the search by category, or with other available filters. To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter .
get_item ¶
get_item(item_id: str, *, fieldgroups: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: Literal[False] = False) -> buy_browse_models.Item
get_item(item_id: str, *, fieldgroups: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item(item_id: str, *, fieldgroups: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: bool = False) -> buy_browse_models.Item | httpx.Response
This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision. The Buy APIs are designed to let you create an eBay shopping experience in your app or website.
get_item_by_legacy_id ¶
get_item_by_legacy_id(*, legacy_item_id: str, fieldgroups: str | None = None, legacy_variation_id: str | None = None, legacy_variation_sku: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: Literal[False] = False) -> buy_browse_models.Item
get_item_by_legacy_id(*, legacy_item_id: str, fieldgroups: str | None = None, legacy_variation_id: str | None = None, legacy_variation_sku: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_by_legacy_id(*, legacy_item_id: str, fieldgroups: str | None = None, legacy_variation_id: str | None = None, legacy_variation_sku: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: bool = False) -> buy_browse_models.Item | httpx.Response
This method is a bridge between the eBay legacy APIs, such as Shopping and Finding , and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an "item" and what the item ID represents.
get_items ¶
get_items(*, item_ids: str | None = None, item_group_ids: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: Literal[False] = False) -> buy_browse_models.Items
get_items(*, item_ids: str | None = None, item_group_ids: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_items(*, item_ids: str | None = None, item_group_ids: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: bool = False) -> buy_browse_models.Items | httpx.Response
This method retrieves the details about specific items that buyers need to make a purchasing decision. Note: This is a (Limited Release) available only to select Partners.
get_items_by_item_group ¶
get_items_by_item_group(*, item_group_id: str, fieldgroups: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: Literal[False] = False) -> buy_browse_models.ItemGroup
get_items_by_item_group(*, item_group_id: str, fieldgroups: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_items_by_item_group(*, item_group_id: str, fieldgroups: str | None = None, x_ebay_c_enduserctx: str | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, quantity_for_shipping_estimate: str | None = None, raw_response: bool = False) -> buy_browse_models.ItemGroup | httpx.Response
This method retrieves details about individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. You pass in the item_group_id as a URI parameter. This method returns two main containers: items This container has an array of containers with the details about each item in the group.
check_compatibility ¶
check_compatibility(item_id: str, *, body: CompatibilityPayload | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: Literal[False] = False) -> buy_browse_models.CompatibilityResponse
check_compatibility(item_id: str, *, body: CompatibilityPayload | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: Literal[True]) -> httpx.Response
check_compatibility(item_id: str, *, body: CompatibilityPayload | None = None, x_ebay_c_marketplace_id: str | None = None, accept_language: str | None = None, raw_response: bool = False) -> buy_browse_models.CompatibilityResponse | httpx.Response
This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay.
Models¶
AddonServiceSelectionEnum ¶
AddonServiceTypeEnum ¶
Bases: OpenStrEnum
authenticity_guarantee
class-attribute
instance-attribute
¶
authenticity_guarantee = 'AUTHENTICITY_GUARANTEE'
Aspect ¶
Bases: EbayModel
localized_name
class-attribute
instance-attribute
¶
localized_name = Field(None, alias='localizedName', description='The text representing the name of the aspect for the name/value pair, such as Brand.')
localized_values
class-attribute
instance-attribute
¶
localized_values = Field(None, alias='localizedValues', description='The text representing the value of the aspect for the name/value pair, such as Apple.')
AspectGroup ¶
Bases: EbayModel
aspects
class-attribute
instance-attribute
¶
aspects = Field(None, description='An array of the name/value pairs for the aspects of the product. For example: BRAND/Apple')
localized_group_name
class-attribute
instance-attribute
¶
localized_group_name = Field(None, alias='localizedGroupName', description='The name of a group of aspects. In the following example, Product Identifiers and Process are product aspect group names. Under the group name are the product aspect name/value pairs. Product Identifiers Brand/Apple Product Family/iMac Processor Processor Type/Intel Processor Speed/3.10')
AspectValueDistribution ¶
Bases: EbayModel
localized_aspect_value
class-attribute
instance-attribute
¶
localized_aspect_value = Field(None, alias='localizedAspectValue', description='The value of an aspect. For example, Red is a value for the aspect Color.')
match_count
class-attribute
instance-attribute
¶
match_count = Field(None, alias='matchCount', description='The number of items with this aspect.')
refinement_href
class-attribute
instance-attribute
¶
refinement_href = Field(None, alias='refinementHref', description='A HATEOAS reference for this aspect.')
AttributeNameValue ¶
Bases: EbayModel
AuthenticityGuaranteeProgram ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='An indication that the item is qualified for the Authenticity Guarantee program.')
terms_web_url
class-attribute
instance-attribute
¶
terms_web_url = Field(None, alias='termsWebUrl', description='The URL to the Authenticity Guarantee program terms of use.')
AuthenticityVerificationProgram ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='An indication that the item is from a verified seller.')
terms_web_url
class-attribute
instance-attribute
¶
terms_web_url = Field(None, alias='termsWebUrl', description='The URL to the Authenticity Verification program terms of use.')
AutoCorrections ¶
Bases: EbayModel
q
class-attribute
instance-attribute
¶
q = Field(None, description='The automatically spell-corrected keyword from the request.')
AvailabilityStatusEnum ¶
AvailabilityThresholdEnum ¶
Bases: OpenStrEnum
BuyingOptionDistribution ¶
Bases: EbayModel
buying_option
class-attribute
instance-attribute
¶
buying_option = Field(None, alias='buyingOption', description='The container that returns the buying option type. This will be AUCTION, FIXED_PRICE, CLASSIFIED_AD, or a combination of these options. For details, see buyingOptions .')
match_count
class-attribute
instance-attribute
¶
match_count = Field(None, alias='matchCount', description='The number of items having this buying option.')
refinement_href
class-attribute
instance-attribute
¶
refinement_href = Field(None, alias='refinementHref', description='The HATEOAS reference for this buying option.')
Category ¶
Bases: EbayModel
CategoryDistribution ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The unique identifier of the category.')
category_name
class-attribute
instance-attribute
¶
category_name = Field(None, alias='categoryName', description='The name of the category, such as Baby & Toddler Clothing .')
match_count
class-attribute
instance-attribute
¶
match_count = Field(None, alias='matchCount', description='The number of items in this category.')
refinement_href
class-attribute
instance-attribute
¶
refinement_href = Field(None, alias='refinementHref', description='The HATEOAS reference of this category.')
CommonDescriptions ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='The item description that is used by more than one of the item variations.')
item_ids
class-attribute
instance-attribute
¶
item_ids = Field(None, alias='itemIds', description='A list of item ids that have this description.')
CompatibilityMatchEnum ¶
CompatibilityPayload ¶
Bases: EbayModel
compatibility_properties
class-attribute
instance-attribute
¶
compatibility_properties = Field(None, alias='compatibilityProperties', description='An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be "name" : "Year", "value" : "2019" For a list of the attributes required for cars and trucks and motorcycles see Check compatibility in the Buy Integration Guide.')
CompatibilityProperty ¶
Bases: EbayModel
localized_name
class-attribute
instance-attribute
¶
localized_name = Field(None, alias='localizedName', description='The name of the product attribute that as been translated to the language of the site.')
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the product attribute, such as Make, Model, Year, etc.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value for the name attribute, such as BMW , R1200GS , 2011 , etc.')
CompatibilityStatus ¶
ConditionDescriptorValue ¶
Bases: EbayModel
additional_info
class-attribute
instance-attribute
¶
additional_info = Field(None, alias='additionalInfo', description='Additional information about the condition of an item as it relates to a condition descriptor. This array elaborates on the value specified in the content field and provides additional details about the condition of an item.')
content
class-attribute
instance-attribute
¶
content = Field(None, description='The value for the condition descriptor indicated in the associated name field.')
ConditionDistribution ¶
Bases: EbayModel
condition
class-attribute
instance-attribute
¶
condition = Field(None, description='The text describing the condition of the item, such as New or Used . For a list of condition names, refer to Item Condition IDs and Names .')
condition_id
class-attribute
instance-attribute
¶
condition_id = Field(None, alias='conditionId', description='The identifier of the condition. For example, 1000 is the identifier for NEW .')
match_count
class-attribute
instance-attribute
¶
match_count = Field(None, alias='matchCount', description='The number of items having the condition.')
refinement_href
class-attribute
instance-attribute
¶
refinement_href = Field(None, alias='refinementHref', description='The HATEOAS reference of this condition.')
CountryCodeEnum ¶
Bases: OpenStrEnum
CouponConstraint ¶
Bases: EbayModel
expiration_date
class-attribute
instance-attribute
¶
expiration_date = Field(None, alias='expirationDate', description='This timestamp provides the expiration date of the coded coupon.')
CouponDiscountType ¶
Bases: OpenStrEnum
CurrencyCodeEnum ¶
Bases: OpenStrEnum
DeliveryOptionsEnum ¶
Bases: OpenStrEnum
seller_arranged_local_pickup
class-attribute
instance-attribute
¶
seller_arranged_local_pickup = 'SELLER_ARRANGED_LOCAL_PICKUP'
EconomicOperator ¶
Bases: EbayModel
company_name
class-attribute
instance-attribute
¶
company_name = Field(None, alias='companyName', description='The company name of the registered Economic Operator.')
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description="The first line of the registered Economic Operator's street address.")
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description="The second line, if any, of the registered Economic Operator's street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'.")
city
class-attribute
instance-attribute
¶
city = Field(None, description="The city of the registered Economic Operator's street address.")
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description="The state or province of the registered Economic Operator's street address.")
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description="The postal code of the registered Economic Operator's street address.")
country
class-attribute
instance-attribute
¶
country = Field(None, description="The two-letter ISO 3166 standard abbreviation of the country of the registered Economic Operator's address.")
phone
class-attribute
instance-attribute
¶
phone = Field(None, description="The registered Economic Operator's business phone number.")
email
class-attribute
instance-attribute
¶
email = Field(None, description="The registered Economic Operator's business email address.")
ErrorParameter ¶
ErrorParameterV3 ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='This is the name of input field that caused an issue with the call request.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This is the actual value that was passed in for the element specified in the name field.')
EstimatedAvailability ¶
Bases: EbayModel
availability_threshold
class-attribute
instance-attribute
¶
availability_threshold = Field(None, alias='availabilityThreshold', description='This field is return only when the seller sets their \' display item quantity \' preference to Display "More than 10 available" in your listing (if applicable) . The value of this field will be "10", which is the threshold value. Code so that your app gracefully handles any future changes to this value.')
availability_threshold_type
class-attribute
instance-attribute
¶
availability_threshold_type = Field(None, alias='availabilityThresholdType', description='This field is return only when the seller sets their Display Item Quantity preference to Display "More than 10 available" in your listing (if applicable) . The value of this field will be MORE_THAN . This indicates that the seller has more than the \'quantity display preference\', which is 10, in stock for this item. The following are the display item quantity preferences the seller can set.')
delivery_options
class-attribute
instance-attribute
¶
delivery_options = Field(None, alias='deliveryOptions', description='An array of available delivery options. Valid Values: SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, PICKUP_DROP_OFF, or DIGITAL_DELIVERY Code so that your app gracefully handles any future changes to this list.')
estimated_availability_status
class-attribute
instance-attribute
¶
estimated_availability_status = Field(None, alias='estimatedAvailabilityStatus', description='An enumeration value representing the inventory status of this item. Note: Be sure to review the itemEndDate field to determine whether the item is available for purchase. Valid Values: IN_STOCK, LIMITED_STOCK, or OUT_OF_STOCK Code so that your app gracefully handles any future changes to this list.')
estimated_available_quantity
class-attribute
instance-attribute
¶
estimated_available_quantity = Field(None, alias='estimatedAvailableQuantity', description='The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. Note: To see if a listing is available for purchase, review the itemEndDate and estimatedAvailablityStatus fields.')
estimated_remaining_quantity
class-attribute
instance-attribute
¶
estimated_remaining_quantity = Field(None, alias='estimatedRemainingQuantity', description='The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. Note: To see if a listing is available for purchase, review the itemEndDate and estimatedAvailablityStatus fields.')
estimated_sold_quantity
class-attribute
instance-attribute
¶
estimated_sold_quantity = Field(None, alias='estimatedSoldQuantity', description='The estimated number of this item that have been sold.')
FulfilledThroughEnum ¶
HazardPictogram ¶
Bases: EbayModel
pictogram_description
class-attribute
instance-attribute
¶
pictogram_description = Field(None, alias='pictogramDescription', description='The description of the hazard pictogram, such as Flammable.')
pictogram_id
class-attribute
instance-attribute
¶
pictogram_id = Field(None, alias='pictogramId', description='The ID of the hazard pictogram.')
pictogram_url
class-attribute
instance-attribute
¶
pictogram_url = Field(None, alias='pictogramUrl', description='The URL of the hazard pictogram.')
HazardStatement ¶
Bases: EbayModel
statement_description
class-attribute
instance-attribute
¶
statement_description = Field(None, alias='statementDescription', description='A description of the nature of the hazard, such as whether the material is toxic if swallowed.')
statement_id
class-attribute
instance-attribute
¶
statement_id = Field(None, alias='statementId', description='The ID of the hazard statement.')
HazardousMaterialsLabels ¶
Bases: EbayModel
additional_information
class-attribute
instance-attribute
¶
additional_information = Field(None, alias='additionalInformation', description='Additional information about the hazardous materials labels.')
pictograms
class-attribute
instance-attribute
¶
pictograms = Field(None, description='An array of hazard pictograms that apply to the item.')
signal_word
class-attribute
instance-attribute
¶
signal_word = Field(None, alias='signalWord', description='The signal word for the hazardous materials label (such as Danger or Warning).')
signal_word_id
class-attribute
instance-attribute
¶
signal_word_id = Field(None, alias='signalWordId', description='The ID of the signal word for the hazardous materials label.')
statements
class-attribute
instance-attribute
¶
statements = Field(None, description='An array of hazard statements for the item.')
Image ¶
Bases: EbayModel
height
class-attribute
instance-attribute
¶
height = Field(None, description='Reserved for future use.')
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageUrl', description='The URL of the image.')
width
class-attribute
instance-attribute
¶
width = Field(None, description='Reserved for future use.')
ItemCharityTerms ¶
Bases: EbayModel
charity_org_id
class-attribute
instance-attribute
¶
charity_org_id = Field(None, alias='charityOrgId', description='The eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds from the item.')
donation_percentage
class-attribute
instance-attribute
¶
donation_percentage = Field(None, alias='donationPercentage', description='The percentage of the purchase price of the item that the charitable organization (identified in the charityOrgId field) will receive for each sale.')
logo_image
class-attribute
instance-attribute
¶
logo_image = Field(None, alias='LogoImage', description="The details of the charity's logo image, such as the size and URL. Note: Currently, only the imageUrl is populated.")
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of the charity organization.')
website
class-attribute
instance-attribute
¶
website = Field(None, description="The URL to the charity's eBay page.")
ItemGroupTypeEnum ¶
Bases: OpenStrEnum
seller_defined_variations
class-attribute
instance-attribute
¶
seller_defined_variations = 'SELLER_DEFINED_VARIATIONS'
ItemLocationImpl ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of the street address.')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description='The second line of the street address. This field may contain such values as an apartment or suite number.')
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city in which the item is located. Restriction: This field is populated in the search method response only when fieldgroups = EXTENDED .')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166 standard code that indicates the country in which the item is located.')
county
class-attribute
instance-attribute
¶
county = Field(None, description='The county in which the item is located.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code (or zip code in US) where the item is located. Sellers set a postal code for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province in which the item is located.')
LegalAddress ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of the street address.')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description="The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'.")
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city of the address.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166 standard code for the country of the address.')
country_name
class-attribute
instance-attribute
¶
country_name = Field(None, alias='countryName', description='The name of the country of the address.')
county
class-attribute
instance-attribute
¶
county = Field(None, description='The name of the county of the address.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code of the address.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province of the address.')
MarketplaceIdEnum ¶
Bases: OpenStrEnum
PaymentInstructionEnum ¶
Bases: OpenStrEnum
PaymentMethodBrandEnum ¶
Bases: OpenStrEnum
PaymentMethodTypeEnum ¶
Bases: OpenStrEnum
PickupOptionSummary ¶
Bases: EbayModel
pickup_location_type
class-attribute
instance-attribute
¶
pickup_location_type = Field(None, alias='pickupLocationType', description='This container returns the local pickup options available to the buyer. Possible values are ARRANGED_LOCATION and STORE .')
PriceDisplayConditionEnum ¶
PriceTreatmentEnum ¶
ProductIdentity ¶
Bases: EbayModel
identifier_type
class-attribute
instance-attribute
¶
identifier_type = Field(None, alias='identifierType', description='The type of product identifier, such as UPC and EAN.')
identifier_value
class-attribute
instance-attribute
¶
identifier_value = Field(None, alias='identifierValue', description='The product identifier value.')
ProductSafetyLabelPictogram ¶
Bases: EbayModel
pictogram_description
class-attribute
instance-attribute
¶
pictogram_description = Field(None, alias='pictogramDescription', description='The description of the safety label pictogram.')
pictogram_id
class-attribute
instance-attribute
¶
pictogram_id = Field(None, alias='pictogramId', description='The identifier of the safety label pictogram.')
pictogram_url
class-attribute
instance-attribute
¶
pictogram_url = Field(None, alias='pictogramUrl', description='The URL of the safety label pictogram.')
ProductSafetyLabelStatement ¶
Bases: EbayModel
statement_description
class-attribute
instance-attribute
¶
statement_description = Field(None, alias='statementDescription', description='A description of the nature of the product safety label statement.')
statement_id
class-attribute
instance-attribute
¶
statement_id = Field(None, alias='statementId', description='The identifier of the product safety label statement.')
ProductSafetyLabels ¶
Bases: EbayModel
pictograms
class-attribute
instance-attribute
¶
pictograms = Field(None, description='An array of seller provided comma-separated string values that provides identifier, URL, and description for one or more pictograms associated with the listing.')
statements
class-attribute
instance-attribute
¶
statements = Field(None, description='An array of seller provided comma-separated string values that provide identifier and description for one or more product safety statements associated with the listing.')
RangeValue ¶
Bases: EbayModel
end
class-attribute
instance-attribute
¶
end = Field(None, description='Specifies the end or upper limit of the range. This can be empty which equates to greater than or equal to the start or lower limit.')
exclusive_end
class-attribute
instance-attribute
¶
exclusive_end = Field(None, alias='exclusiveEnd', description='Specifies whether the end value is to be included in the range. For example, if end is 100 , and exclusiveEnd is true , the end range would be <100. But if it is set to false , it is <=100.')
exclusive_start
class-attribute
instance-attribute
¶
exclusive_start = Field(None, alias='exclusiveStart', description='Specifies whether the start value is to be included in the range. For example, if start is 60 , and exclusiveStart is true , the start range would be >60. But if it is set to false , it is >=60.')
range
class-attribute
instance-attribute
¶
range = Field(None, description='Specifies whether the filter is for a range of values.')
start
class-attribute
instance-attribute
¶
start = Field(None, description='Specifies the start or lower limit of the range. This can be empty which equates to lesser than or equal to the end or upper limit.')
RatingHistogram ¶
Bases: EbayModel
count
class-attribute
instance-attribute
¶
count = Field(None, description='The total number of user ratings that the product has received.')
rating
class-attribute
instance-attribute
¶
rating = Field(None, description='This is the average rating for the product. As part of a product review, users rate the product. Products are rated from one star (terrible) to five stars (excellent), with each star having a corresponding point value - one star gets 1 point, two stars get 2 points, and so on.')
RefundMethodEnum ¶
RegionTypeEnum ¶
Bases: OpenStrEnum
ResponsiblePersonTypeEnum ¶
Bases: OpenStrEnum
eu_responsible_person
class-attribute
instance-attribute
¶
eu_responsible_person = 'EU_RESPONSIBLE_PERSON'
ReturnMethodEnum ¶
ReturnShippingCostPayerEnum ¶
ReviewRating ¶
Bases: EbayModel
average_rating
class-attribute
instance-attribute
¶
average_rating = Field(None, alias='averageRating', description='The average rating given to a product based on customer reviews.')
rating_histograms
class-attribute
instance-attribute
¶
rating_histograms = Field(None, alias='ratingHistograms', description='An array of containers for the product rating histograms that shows the review counts and the product rating.')
review_count
class-attribute
instance-attribute
¶
review_count = Field(None, alias='reviewCount', description='The total number of reviews for the item.')
SearchByImageRequest ¶
Bases: EbayModel
image
class-attribute
instance-attribute
¶
image = Field(None, description='The Base64 string of the image. To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter .')
Seller ¶
Bases: EbayModel
feedback_percentage
class-attribute
instance-attribute
¶
feedback_percentage = Field(None, alias='feedbackPercentage', description='The percentage of the total positive feedback.')
feedback_score
class-attribute
instance-attribute
¶
feedback_score = Field(None, alias='feedbackScore', description='The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.')
seller_account_type
class-attribute
instance-attribute
¶
seller_account_type = Field(None, alias='sellerAccountType', description='Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay: If they register for a business account, this value will be BUSINESS . If they register for a private account, this value will be INDIVIDUAL . This designation is required by the tax laws in some countries.')
username
class-attribute
instance-attribute
¶
username = Field(None, description='The user name created by the seller for use on eBay. Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance .')
SellerCustomPolicyTypeEnum ¶
SellerInstructionEnum ¶
ShipToLocation ¶
Bases: EbayModel
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166 standard of the country for where the item is to be shipped.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The zip code (postal code) for where the item is to be shipped.')
ShipToRegion ¶
Bases: EbayModel
region_id
class-attribute
instance-attribute
¶
region_id = Field(None, alias='regionId', description='The unique identifier of the shipping region. The value returned here is dependent on the corresponding regionType value. The regionId value for a region does not vary based on the eBay marketplace. However, the corresponding regionName value for a region is a localized, text-based description of the shipping region.')
region_name
class-attribute
instance-attribute
¶
region_name = Field(None, alias='regionName', description='A localized text string that indicates the name of the shipping region. The value returned here is dependent on the corresponding regionType value. If the regionType value is WORLDWIDE , the regionName value will show Worldwide .')
region_type
class-attribute
instance-attribute
¶
region_type = Field(None, alias='regionType', description='An enumeration value that indicates the level or type of shipping region. Valid Values: COUNTRY_REGION - Indicates the region is a domestic region or special location within a country. STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada. COUNTRY - Indicates the region is a single country.')
SortField ¶
Bases: EbayModel
ascending
class-attribute
instance-attribute
¶
ascending = Field(None, description='Indicates if the results are sorted in ascending (smallest to greatest) order.')
field
class-attribute
instance-attribute
¶
field = Field(None, description='Specifies the name of a field in which to sort items using the value of that field. For example, if the field name is amount , the items will be sorted by the amount, or cost of the item.')
TargetLocation ¶
Bases: EbayModel
unit_of_measure
class-attribute
instance-attribute
¶
unit_of_measure = Field(None, alias='unitOfMeasure', description="This value shows the unit of measurement used to measure the distance between the location of the item and the buyer's location. This value is typically mi or km .")
value
class-attribute
instance-attribute
¶
value = Field(None, description="This value indicates the distance (measured in the measurement unit in the unitOfMeasure field) between the item location and the buyer's location.")
TaxType ¶
Bases: OpenStrEnum
TimeDurationUnitEnum ¶
Bases: OpenStrEnum
ValueTypeEnum ¶
VatDetail ¶
Bases: EbayModel
issuing_country
class-attribute
instance-attribute
¶
issuing_country = Field(None, alias='issuingCountry', description="The two-letter ISO 3166 standard of the country issuing the seller's VAT (value added tax) ID. VAT is a tax added by some European countries.")
vat_id
class-attribute
instance-attribute
¶
vat_id = Field(None, alias='vatId', description="The seller's VAT (value added tax) ID. VAT is a tax added by some European countries.")
AdditionalProductIdentity ¶
Bases: EbayModel
product_identity
class-attribute
instance-attribute
¶
product_identity = Field(None, alias='productIdentity', description='An array of product identifier/value pairs for the product associated with the item. This is returned if the seller has associated the eBay Product Identifier (ePID) with the item and the request has fieldgroups set to PRODUCT . The following table shows what is returned, based on the item information provided by the seller, when fieldgroups is set to PRODUCT .')
Address ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description='The first line of the street address. Note: This is conditionally returned in the itemLocation field.')
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description='The second line of the street address. This field is not always used, but can be used for "Suite Number" or "Apt Number".')
city
class-attribute
instance-attribute
¶
city = Field(None, description='The city of the address.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166 standard code for the country of the address.')
county
class-attribute
instance-attribute
¶
county = Field(None, description='The county of the address.')
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description='The postal code (or zip code in US) code of the address. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API.')
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description='The state or province of the address. Note: This is conditionally returned in the itemLocation field.')
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='The list of valid currencies. Each ISO 4217 currency code includes the currency name followed by the numeric value. For example, the Canadian Dollar code (CAD) would take the following form: Canadian Dollar, 124 .')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary value of the amount in the currency defined by the currency field.')
AspectDistribution ¶
Bases: EbayModel
aspect_value_distributions
class-attribute
instance-attribute
¶
aspect_value_distributions = Field(None, alias='aspectValueDistributions', description='An array of containers for the various values of the aspect and the match count, and a HATEOAS reference ( refinementHref ) for this aspect.')
localized_aspect_name
class-attribute
instance-attribute
¶
localized_aspect_name = Field(None, alias='localizedAspectName', description='The name of an aspect, such as Brand , Color , etc.')
AvailableCoupon ¶
Bases: EbayModel
constraint
class-attribute
instance-attribute
¶
constraint = Field(None, description='The limitations or restrictions of the coupon.')
discount_amount
class-attribute
instance-attribute
¶
discount_amount = Field(None, alias='discountAmount', description='The discount amount after the coupon is applied.')
discount_type
class-attribute
instance-attribute
¶
discount_type = Field(None, alias='discountType', description='The type of discount that the coupon applies.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='A description of the coupon. Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included if returned in the API response.')
redemption_code
class-attribute
instance-attribute
¶
redemption_code = Field(None, alias='redemptionCode', description='The coupon code.')
terms_web_url
class-attribute
instance-attribute
¶
terms_web_url = Field(None, alias='termsWebUrl', description='The URL to the coupon terms of use. Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included if returned in the API response.')
CompanyAddress ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description="The first line of the product manufacturer's street address.")
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description="The second line of the product manufacturer's street address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'.")
city
class-attribute
instance-attribute
¶
city = Field(None, description="The city of the product manufacturer's street address.")
company_name
class-attribute
instance-attribute
¶
company_name = Field(None, alias='companyName', description='The company name of the product manufacturer.')
contact_url
class-attribute
instance-attribute
¶
contact_url = Field(None, alias='contactUrl', description='The contact URL of the product manufacturer.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166 standard code for the country of the address.')
country_name
class-attribute
instance-attribute
¶
country_name = Field(None, alias='countryName', description="The country name of the product manufacturer's street address.")
county
class-attribute
instance-attribute
¶
county = Field(None, description="The county of the product manufacturer's street address.")
email
class-attribute
instance-attribute
¶
email = Field(None, description="The product manufacturer's business email address.")
phone
class-attribute
instance-attribute
¶
phone = Field(None, description="The product manufacturer's business phone number.")
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description="The postal code of the product manufacturer's street address.")
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description="The state or province of the product manufacturer's street address.")
ConditionDescriptor ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='The name of a condition descriptor. The value(s) for this condition descriptor is returned in the associated values array.')
values
class-attribute
instance-attribute
¶
values = Field(None, description='This array displays the value(s) for a condition descriptor (denoted by the associated name field), as well as any other additional information about the condition of the item.')
ConvertedAmount ¶
Bases: EbayModel
converted_from_currency
class-attribute
instance-attribute
¶
converted_from_currency = Field(None, alias='convertedFromCurrency', description='The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.')
converted_from_value
class-attribute
instance-attribute
¶
converted_from_value = Field(None, alias='convertedFromValue', description='The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.')
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. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field. Default: The currency of the authenticated user's country.")
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
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='This string value indicates the error category. There are three categories of errors: request errors , application errors , and system errors .')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='The name of 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 code that identifies the particular error or warning 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='An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='A description of the condition that caused the error or warning.')
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='The name of the subdomain in which the error or warning occurred.')
FilterField ¶
Bases: EbayModel
field
class-attribute
instance-attribute
¶
field = Field(None, description='Provides a way to specify the field for the filter.')
negated
class-attribute
instance-attribute
¶
negated = Field(None, description='Note: Currently this filter is not supported.')
range
class-attribute
instance-attribute
¶
range = Field(None, description='Provides a way to specify a range of values for the filter.')
set
class-attribute
instance-attribute
¶
set = Field(None, description='Provides a way to specify a "list of values" for the filter.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='Provides a way to specify the value of the field.')
ItemGroupSummary ¶
Bases: EbayModel
item_group_additional_images
class-attribute
instance-attribute
¶
item_group_additional_images = Field(None, alias='itemGroupAdditionalImages', description='An array of containers with the URLs for images that are in addition to the primary image of the item group. The primary image is returned in the itemGroupImage field.')
item_group_href
class-attribute
instance-attribute
¶
item_group_href = Field(None, alias='itemGroupHref', description='The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.')
item_group_id
class-attribute
instance-attribute
¶
item_group_id = Field(None, alias='itemGroupId', description='The unique identifier for the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.')
item_group_image
class-attribute
instance-attribute
¶
item_group_image = Field(None, alias='itemGroupImage', description='The URL of the primary image of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.')
item_group_title
class-attribute
instance-attribute
¶
item_group_title = Field(None, alias='itemGroupTitle', description='The title of the item that appears on the item group page. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.')
item_group_type
class-attribute
instance-attribute
¶
item_group_type = Field(None, alias='itemGroupType', description='An enumeration value that indicates the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.')
MarketingPrice ¶
Bases: EbayModel
discount_amount
class-attribute
instance-attribute
¶
discount_amount = Field(None, alias='discountAmount', description='This container returns the monetary amount of the seller discount.')
discount_percentage
class-attribute
instance-attribute
¶
discount_percentage = Field(None, alias='discountPercentage', description='This field expresses the percentage of the seller discount based on the value in the originalPrice container.')
original_price
class-attribute
instance-attribute
¶
original_price = Field(None, alias='originalPrice', description='This container returns the monetary amount of the item without the discount.')
price_treatment
class-attribute
instance-attribute
¶
price_treatment = Field(None, alias='priceTreatment', description='Indicates the pricing treatment (discount) that was applied to the price of the item. Note: The pricing treatment affects the way and where the discounted price can be displayed.')
PaymentMethodBrand ¶
Bases: EbayModel
payment_method_brand_type
class-attribute
instance-attribute
¶
payment_method_brand_type = Field(None, alias='paymentMethodBrandType', description='The payment method brand, such as Visa or PayPal.')
logo_image
class-attribute
instance-attribute
¶
logo_image = Field(None, alias='logoImage', description='The details of the logo image, such as the size and URL. Note: Currently, only the imageUrl is populated.')
Product ¶
Bases: EbayModel
additional_images
class-attribute
instance-attribute
¶
additional_images = Field(None, alias='additionalImages', description='An array of containers with the URLs for the product images that are in addition to the primary image.')
additional_product_identities
class-attribute
instance-attribute
¶
additional_product_identities = Field(None, alias='additionalProductIdentities', description='An array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Identifier (ePID) with the item and in the request fieldgroups is set to PRODUCT .')
aspect_groups
class-attribute
instance-attribute
¶
aspect_groups = Field(None, alias='aspectGroups', description='An array of containers for the product aspects. Each group contains the aspect group name and the aspect name/value pairs.')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='The brand associated with product. To identify the product, this is always used along with MPN (manufacturer part number).')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The rich description of an eBay product, which might contain HTML.')
gtins
class-attribute
instance-attribute
¶
gtins = Field(None, description='An array of all the possible GTINs values associated with the product. A GTIN is a unique Global Trade Item number of the item as defined by https://www.gtin.info . This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.')
image
class-attribute
instance-attribute
¶
image = Field(None, description='The primary image of the product. This is often a stock photo.')
mpns
class-attribute
instance-attribute
¶
mpns = Field(None, description='An array of all possible MPN values associated with the product. A MPNs is manufacturer part number of the product. To identify the product, this is always used along with brand.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The title of the product.')
Refinement ¶
Bases: EbayModel
aspect_distributions
class-attribute
instance-attribute
¶
aspect_distributions = Field(None, alias='aspectDistributions', description='An array of containers for the all the aspect refinements.')
buying_option_distributions
class-attribute
instance-attribute
¶
buying_option_distributions = Field(None, alias='buyingOptionDistributions', description='An array of containers for the all the buying option refinements.')
category_distributions
class-attribute
instance-attribute
¶
category_distributions = Field(None, alias='categoryDistributions', description='An array of containers for the all the category refinements.')
condition_distributions
class-attribute
instance-attribute
¶
condition_distributions = Field(None, alias='conditionDistributions', description='An array of containers for the all the condition refinements.')
dominant_category_id
class-attribute
instance-attribute
¶
dominant_category_id = Field(None, alias='dominantCategoryId', description='The identifier of the category that most of the items are part of.')
Region ¶
Bases: EbayModel
region_name
class-attribute
instance-attribute
¶
region_name = Field(None, alias='regionName', description='A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level or at the country level in the case of VAT tax.')
region_type
class-attribute
instance-attribute
¶
region_type = Field(None, alias='regionType', description='An enumeration value that indicates the type of region for the tax jurisdiction. Valid Values: STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada. COUNTRY - Indicates the region is a single country. Code so that your app gracefully handles any future changes to this list.')
ResponsiblePerson ¶
Bases: EbayModel
address_line1
class-attribute
instance-attribute
¶
address_line1 = Field(None, alias='addressLine1', description="The first line of the Responsible Person's street address.")
address_line2
class-attribute
instance-attribute
¶
address_line2 = Field(None, alias='addressLine2', description="The second line of the Responsible Person's address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'.")
city
class-attribute
instance-attribute
¶
city = Field(None, description="The city of the Responsible Person's street address.")
company_name
class-attribute
instance-attribute
¶
company_name = Field(None, alias='companyName', description='The name of the Responsible Person or entity.')
contact_url
class-attribute
instance-attribute
¶
contact_url = Field(None, alias='contactUrl', description='The contact URL of the Responsible Person or entity.')
country
class-attribute
instance-attribute
¶
country = Field(None, description='The two-letter ISO 3166 standard of the country of the address.')
country_name
class-attribute
instance-attribute
¶
country_name = Field(None, alias='countryName', description="The country name of the Responsible Person's street address.")
county
class-attribute
instance-attribute
¶
county = Field(None, description="The county of the Responsible Person's street address.")
email
class-attribute
instance-attribute
¶
email = Field(None, description="The email of the Responsible Person's street address.")
phone
class-attribute
instance-attribute
¶
phone = Field(None, description="The phone number of the Responsible Person's street address.")
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description="The postal code of the Responsible Person's street address.")
state_or_province
class-attribute
instance-attribute
¶
state_or_province = Field(None, alias='stateOrProvince', description="The state or province of the Responsible Person's street address.")
types
class-attribute
instance-attribute
¶
types = Field(None, description='The type(s) associated with the Responsible Person or entity.')
SellerCustomPolicy ¶
Bases: EbayModel
description
class-attribute
instance-attribute
¶
description = Field(None, description='The seller-defined description of the policy.')
label
class-attribute
instance-attribute
¶
label = Field(None, description='The seller-defined label for an individual custom policy.')
type
class-attribute
instance-attribute
¶
type = Field(None, description='The type of custom policy, such as PRODUCT_COMPLIANCE or TAKE_BACK.')
SellerLegalInfo ¶
Bases: EbayModel
email
class-attribute
instance-attribute
¶
email = Field(None, description="The seller's business email address.")
fax
class-attribute
instance-attribute
¶
fax = Field(None, description="The seller' business fax number.")
imprint
class-attribute
instance-attribute
¶
imprint = Field(None, description='This is a free-form string created by the seller. This is information often found on business cards, such as address. This is information used by some countries.')
legal_contact_first_name
class-attribute
instance-attribute
¶
legal_contact_first_name = Field(None, alias='legalContactFirstName', description="The seller's first name.")
legal_contact_last_name
class-attribute
instance-attribute
¶
legal_contact_last_name = Field(None, alias='legalContactLastName', description="The seller's last name.")
name
class-attribute
instance-attribute
¶
name = Field(None, description="The name of the seller's business.")
phone
class-attribute
instance-attribute
¶
phone = Field(None, description="The seller's business phone number.")
registration_number
class-attribute
instance-attribute
¶
registration_number = Field(None, alias='registrationNumber', description="The seller's registration number. This is information used by some countries.")
seller_provided_legal_address
class-attribute
instance-attribute
¶
seller_provided_legal_address = Field(None, alias='sellerProvidedLegalAddress', description="The container that returns the seller's address to be used to contact them.")
terms_of_service
class-attribute
instance-attribute
¶
terms_of_service = Field(None, alias='termsOfService', description="This is a free-form string created by the seller. This is the seller's terms or condition, which is in addition to the seller's return policies.")
vat_details
class-attribute
instance-attribute
¶
vat_details = Field(None, alias='vatDetails', description="An array of the seller's VAT (value added tax) IDs and the issuing country. VAT is a tax added by some European countries.")
economic_operator
class-attribute
instance-attribute
¶
economic_operator = Field(None, alias='economicOperator', description='Provides required information about the manufacturer and/or supplier of the item.')
weee_number
class-attribute
instance-attribute
¶
weee_number = Field(None, alias='weeeNumber', description='The Waste Electrical and Electronic Equipment (WEEE) registration number required for any seller to place electrical and electronic equipment on the market in Germany. This manufacturer number is assigned to the first distributors of electrical and electronic equipment and comprises a country code and an 8-digit sequence of digits (e.g. “WEEE Reg. No. DE 12345678”).')
ShipToLocations ¶
Bases: EbayModel
region_excluded
class-attribute
instance-attribute
¶
region_excluded = Field(None, alias='regionExcluded', description='An array of containers that express the large geographical regions, countries, state/provinces, or special locations within a country where the seller is not willing to ship to.')
region_included
class-attribute
instance-attribute
¶
region_included = Field(None, alias='regionIncluded', description='An array of containers that express the large geographical regions, countries, or state/provinces within a country where the seller is willing to ship to. Prospective buyers must look at the shipping regions under this container, as well as the shipping regions that are under the regionExcluded to see where the seller is willing to ship items.')
ShippingOption ¶
Bases: EbayModel
additional_shipping_cost_per_unit
class-attribute
instance-attribute
¶
additional_shipping_cost_per_unit = Field(None, alias='additionalShippingCostPerUnit', description="Any per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the shippingCost would be $3 and this value would be $2 ($1 for each additional item).")
cut_off_date_used_for_estimate
class-attribute
instance-attribute
¶
cut_off_date_used_for_estimate = Field(None, alias='cutOffDateUsedForEstimate', description="The deadline date that the item must be purchased by in order to be received by the buyer within the delivery window ( maxEstimatedDeliveryDate and minEstimatedDeliveryDate fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the Delivery line on the View Item page.")
fulfilled_through
class-attribute
instance-attribute
¶
fulfilled_through = Field(None, alias='fulfilledThrough', description='If the item is being shipped by the eBay Global Shipping program , this field returns GLOBAL_SHIPPING . If the item is being shipped using the eBay International Shipping program, this field returns INTERNATIONAL_SHIPPING . Otherwise, this field is null.')
guaranteed_delivery
class-attribute
instance-attribute
¶
guaranteed_delivery = Field(None, alias='guaranteedDelivery', description='Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future.')
import_charges
class-attribute
instance-attribute
¶
import_charges = Field(None, alias='importCharges', description='The Global Shipping Program import charges for this item.')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description='The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.')
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description='The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.')
quantity_used_for_estimate
class-attribute
instance-attribute
¶
quantity_used_for_estimate = Field(None, alias='quantityUsedForEstimate', description='The number of items used when calculating the estimation information. This field will reflect the value input in the quantity_for_shipping_estimate query parameter.')
shipping_carrier_code
class-attribute
instance-attribute
¶
shipping_carrier_code = Field(None, alias='shippingCarrierCode', description='The name of the shipping provider, such as FedEx, or USPS.')
shipping_cost
class-attribute
instance-attribute
¶
shipping_cost = Field(None, alias='shippingCost', description='The final shipping cost for all the items after all discounts are applied. This container will reflect the cost for the quantity specified through the quantity_for_shipping_estimate query parameter. Note: The cost does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.')
shipping_cost_type
class-attribute
instance-attribute
¶
shipping_cost_type = Field(None, alias='shippingCostType', description='Indicates the class of the shipping cost. Valid Values: FIXED or CALCULATED Code so that your app gracefully handles any future changes to this list.')
shipping_service_code
class-attribute
instance-attribute
¶
shipping_service_code = Field(None, alias='shippingServiceCode', description='The type of shipping service. For example, USPS First Class.')
ship_to_location_used_for_estimate
class-attribute
instance-attribute
¶
ship_to_location_used_for_estimate = Field(None, alias='shipToLocationUsedForEstimate', description='The container that returns the country and postal code of where the item is to be shipped. These values come from the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. If the header is not submitted, marketplace is used.')
trademark_symbol
class-attribute
instance-attribute
¶
trademark_symbol = Field(None, alias='trademarkSymbol', description='Any trademark symbol, such as ™ or ®, that needs to be shown in superscript next to the shipping service name.')
type
class-attribute
instance-attribute
¶
type = Field(None, description='The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.')
ShippingOptionSummary ¶
Bases: EbayModel
guaranteed_delivery
class-attribute
instance-attribute
¶
guaranteed_delivery = Field(None, alias='guaranteedDelivery', description='Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future.')
max_estimated_delivery_date
class-attribute
instance-attribute
¶
max_estimated_delivery_date = Field(None, alias='maxEstimatedDeliveryDate', description='The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. Note: Estimated delivery dates are not returned for CBT items.')
min_estimated_delivery_date
class-attribute
instance-attribute
¶
min_estimated_delivery_date = Field(None, alias='minEstimatedDeliveryDate', description='The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. Note: Estimated delivery dates are not returned for CBT items.')
shipping_cost
class-attribute
instance-attribute
¶
shipping_cost = Field(None, alias='shippingCost', description='This is the estimated price to ship the item. The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.')
shipping_cost_type
class-attribute
instance-attribute
¶
shipping_cost_type = Field(None, alias='shippingCostType', description='Indicates the type of shipping used to ship the item. Possible values are FIXED (flat-rate shipping) and CALCULATED (shipping cost calculated based on item and buyer location).')
TaxJurisdiction ¶
Bases: EbayModel
Taxes ¶
Bases: EbayModel
ebay_collect_and_remit_tax
class-attribute
instance-attribute
¶
ebay_collect_and_remit_tax = Field(None, alias='ebayCollectAndRemitTax', description="This field is only returned if true , and indicates that eBay will collect tax (sales tax, Goods and Services tax, or VAT) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence.")
included_in_price
class-attribute
instance-attribute
¶
included_in_price = Field(None, alias='includedInPrice', description='This indicates if tax was applied for the cost of the item.')
shipping_and_handling_taxed
class-attribute
instance-attribute
¶
shipping_and_handling_taxed = Field(None, alias='shippingAndHandlingTaxed', description='This indicates if tax is applied for the shipping cost.')
tax_jurisdiction
class-attribute
instance-attribute
¶
tax_jurisdiction = Field(None, alias='taxJurisdiction', description='The container that returns the tax jurisdiction.')
tax_percentage
class-attribute
instance-attribute
¶
tax_percentage = Field(None, alias='taxPercentage', description='The percentage of tax.')
tax_type
class-attribute
instance-attribute
¶
tax_type = Field(None, alias='taxType', description='This field indicates the type of tax that may be collected for the item.')
TimeDuration ¶
Bases: EbayModel
unit
class-attribute
instance-attribute
¶
unit = Field(None, description='An enumeration value that indicates the units of the time span (e.g., HOURS ). The enumeration value in this field defines the period of time being used to measure the duration. Refer to TimeDurationUnitEnum for the list of supported values.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='Retrieves the duration of the time span (no units). The value in this field indicates the number of years, months, days, hours, or minutes in the defined period.')
TypedNameValue ¶
Bases: EbayModel
name
class-attribute
instance-attribute
¶
name = Field(None, description='The text representing the name of the aspect for the name/value pair, such as Color.')
type
class-attribute
instance-attribute
¶
type = Field(None, description='This indicates if the value being returned is a string or an array of values. Valid Values: STRING - Indicates the value returned is a string. STRING_ARRAY - Indicates the value returned is an array of strings. Code so that your app gracefully handles any future changes to this list.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The value of the aspect for the name/value pair, such as Red.')
AddonService ¶
Bases: EbayModel
selection
class-attribute
instance-attribute
¶
selection = Field(None, description='This field indicates whether the add-on service must be selected for the item.')
service_fee
class-attribute
instance-attribute
¶
service_fee = Field(None, alias='serviceFee', description='The amount charged for the add-on service.')
service_id
class-attribute
instance-attribute
¶
service_id = Field(None, alias='serviceId', description='The ID number of the add-on service.')
service_type
class-attribute
instance-attribute
¶
service_type = Field(None, alias='serviceType', description='The type of add-on service, such as AUTHENTICITY_GUARANTEE .')
AspectFilter ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The ID of the category. This limits the aspects filtering to this category.')
filters
class-attribute
instance-attribute
¶
filters = Field(None, description='This query parameter supports multiple field filters that can be used to limit/customize the result set. This is specific to limiting the items return based on item aspects, such as Brand . For an example, refer to the Samples section.')
CompatibilityFilter ¶
Bases: EbayModel
filters
class-attribute
instance-attribute
¶
filters = Field(None, description='This query parameter supports multiple field filters that can be used to limit/customize the result set. This is specific to checking if an item is compatible to the specified a product.')
CompatibilityResponse ¶
Bases: EbayModel
compatibility_status
class-attribute
instance-attribute
¶
compatibility_status = Field(None, alias='compatibilityStatus', description='An enumeration value that tells you if the item is compatible with the product. The values are: COMPATIBLE - Indicates the item is compatible with the product specified in the request. NOT_COMPATIBLE - Indicates the item is not compatible with the product specified in the request. Be sure to check all the value fields to ensure they are correct as errors in the value can also cause this response.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of warning messages. These types of errors do not prevent the method from executing but should be checked.')
ItemReturnTerms ¶
Bases: EbayModel
extended_holiday_returns_offered
class-attribute
instance-attribute
¶
extended_holiday_returns_offered = Field(None, alias='extendedHolidayReturnsOffered', description="This indicates if the seller has enabled the Extended Holiday Returns feature on the item. Extended Holiday Returns are only applicable during the US holiday season, and gives buyers extra time to return an item. This 'extra time' will typically extend beyond what is set through the returnPeriod value.")
refund_method
class-attribute
instance-attribute
¶
refund_method = Field(None, alias='refundMethod', description='An enumeration value that indicates how a buyer is refunded when an item is returned. Valid Values: MONEY_BACK or MERCHANDISE_CREDIT Code so that your app gracefully handles any future changes to this list.')
restocking_fee_percentage
class-attribute
instance-attribute
¶
restocking_fee_percentage = Field(None, alias='restockingFeePercentage', description='This string field indicates the restocking fee percentage that the seller has set on the item. Sellers have the option of setting no restocking fee for an item, or they can set the percentage to 10, 15, or 20 percent.')
return_instructions
class-attribute
instance-attribute
¶
return_instructions = Field(None, alias='returnInstructions', description='Text written by the seller describing what the buyer needs to do in order to return the item.')
return_method
class-attribute
instance-attribute
¶
return_method = Field(None, alias='returnMethod', description='An enumeration value that indicates the alternative methods for a full refund when an item is returned. This field is returned if the seller offers the buyer an item replacement or exchange instead of a monetary refund.')
return_period
class-attribute
instance-attribute
¶
return_period = Field(None, alias='returnPeriod', description='The amount of time the buyer has to return the item after the purchase date.')
returns_accepted
class-attribute
instance-attribute
¶
returns_accepted = Field(None, alias='returnsAccepted', description='Indicates whether the seller accepts returns for the item.')
return_shipping_cost_payer
class-attribute
instance-attribute
¶
return_shipping_cost_payer = Field(None, alias='returnShippingCostPayer', description='This enumeration value indicates whether the buyer or seller is responsible for return shipping costs when an item is returned. Valid Values: SELLER - Indicates the seller will pay for the shipping costs to return the item. BUYER - Indicates the buyer will pay for the shipping costs to return the item. Code so that your app gracefully handles any future changes to this list.')
ItemSummary ¶
Bases: EbayModel
additional_images
class-attribute
instance-attribute
¶
additional_images = Field(None, alias='additionalImages', description='An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.')
adult_only
class-attribute
instance-attribute
¶
adult_only = Field(None, alias='adultOnly', description='This indicates if the item is for adults only. For more information about adult-only items on eBay, refer to the Adult items policy .')
available_coupons
class-attribute
instance-attribute
¶
available_coupons = Field(None, alias='availableCoupons', description='This boolean attribute indicates if coupons are available for the item. Note: The Browse API only acknowledges item-level coupons. This field will only be returned as true if a coupon is linked with an item. It does not recognize store-level coupons offered by sellers across their entire store.')
bid_count
class-attribute
instance-attribute
¶
bid_count = Field(None, alias='bidCount', description='This integer value indicates the total number of bids that have been placed for an auction item. This field is only returned for auction items.')
buying_options
class-attribute
instance-attribute
¶
buying_options = Field(None, alias='buyingOptions', description='A comma separated list of all the purchase options available for the item. Values Returned: FIXED_PRICE Indicates the buyer can purchase the item for a set price using the Buy It Now button. AUCTION Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.')
categories
class-attribute
instance-attribute
¶
categories = Field(None, description='This array returns the name and ID of each category associated with the item, including top level, branch, and leaf categories.')
compatibility_match
class-attribute
instance-attribute
¶
compatibility_match = Field(None, alias='compatibilityMatch', description='This indicates how well an item matches the compatibility_filter product attributes. Valid Values: EXACT POSSIBLE')
compatibility_properties
class-attribute
instance-attribute
¶
compatibility_properties = Field(None, alias='compatibilityProperties', description='This container returns only the product attributes that are compatible with the item. These attributes were specified in the compatibility_filter in the request. This means that if you passed in 5 attributes and only 4 are compatible, only those 4 are returned. If none of the attributes are compatible, this container is not returned.')
condition
class-attribute
instance-attribute
¶
condition = Field(None, description='The text describing the condition of the item, such as New or Used . For a list of condition names, refer to Item Condition IDs and Names .')
condition_id
class-attribute
instance-attribute
¶
condition_id = Field(None, alias='conditionId', description='The identifier of the condition of the item. For example, 1000 is the identifier for NEW . For a list of condition names and IDs, refer to Item Condition IDs and Names .')
current_bid_price
class-attribute
instance-attribute
¶
current_bid_price = Field(None, alias='currentBidPrice', description='This container returns the current highest bid for an auction item. The value field shows the dollar value of the current highest bid, and the currency field (3-digit ISO code) denotes the currency associated with that bid value. This field is only returned for auction items.')
distance_from_pickup_location
class-attribute
instance-attribute
¶
distance_from_pickup_location = Field(None, alias='distanceFromPickupLocation', description='This container returns the distance away that the item is from the pickupPostalCode value that was supplied in the method request. This container is only returned if the "local pickup" filter fields are used in the request.')
energy_efficiency_class
class-attribute
instance-attribute
¶
energy_efficiency_class = Field(None, alias='energyEfficiencyClass', description='This indicates the European energy efficiency rating (EEK) of the item. Energy efficiency ratings apply to products listed by commercial vendors in electronics categories only. Currently, this field is only applicable for the Germany site, and is returned only if the seller specifies the energy efficiency rating through item specifics at listing time.')
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='An ePID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.')
image
class-attribute
instance-attribute
¶
image = Field(None, description='The URL to the primary image of the item.')
item_affiliate_web_url
class-attribute
instance-attribute
¶
item_affiliate_web_url = Field(None, alias='itemAffiliateWebUrl', description='The URL to the View Item page of the item which includes the affiliate tracking ID. Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace. The itemAffiliateWebUrl is returned only if: The marketplace through which the item is being viewed is part of the eBay Partner Network.')
item_creation_date
class-attribute
instance-attribute
¶
item_creation_date = Field(None, alias='itemCreationDate', description='The date and time when the item listing was created. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which you can convert into the local time of the buyer. This field is always returned with itemSummaries .')
item_end_date
class-attribute
instance-attribute
¶
item_end_date = Field(None, alias='itemEndDate', description='A timestamp that indicates the date and time a listing is scheduled to end. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which can be converted into the local time of the buyer.')
item_group_href
class-attribute
instance-attribute
¶
item_group_href = Field(None, alias='itemGroupHref', description='The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. Note: This field is returned only for item groups.')
item_group_type
class-attribute
instance-attribute
¶
item_group_type = Field(None, alias='itemGroupType', description='The indicates the item group type. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. Currently only the SELLER_DEFINED_VARIATIONS is supported and indicates this is an item group created by the seller. Note: This field is returned only for item groups.')
item_href
class-attribute
instance-attribute
¶
item_href = Field(None, alias='itemHref', description='The URI for the Browse API getItem method, which can be used to retrieve more details about items in the search results.')
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique RESTful identifier of the item.')
item_location
class-attribute
instance-attribute
¶
item_location = Field(None, alias='itemLocation', description='This container returns the location of the item. This container consists of fields you typically see for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code).')
item_origin_date
class-attribute
instance-attribute
¶
item_origin_date = Field(None, alias='itemOriginDate', description='The date and time when the listing was first made available. This date will be retained if an item is relisted. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which you can convert into the local time of the buyer. This timestamp is used to sort the response when the sort=newlyListed parameter is used. This field is always returned with itemSummaries .')
item_web_url
class-attribute
instance-attribute
¶
item_web_url = Field(None, alias='itemWebUrl', description='The URL to the View Item page of the item. This enables you to include a "Report Item on eBay" hyperlink that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.')
leaf_category_ids
class-attribute
instance-attribute
¶
leaf_category_ids = Field(None, alias='leafCategoryIds', description='The leaf category IDs of the item. When the item belongs to two leaf categories, the ID values are returned in the order primary, secondary.')
legacy_item_id
class-attribute
instance-attribute
¶
legacy_item_id = Field(None, alias='legacyItemId', description='The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.')
listing_marketplace_id
class-attribute
instance-attribute
¶
listing_marketplace_id = Field(None, alias='listingMarketplaceId', description='The ID of the eBay marketplace on which the seller listed the item.')
marketing_price
class-attribute
instance-attribute
¶
marketing_price = Field(None, alias='marketingPrice', description="This container is returned if the item is eligible for a seller discount and contains the item's original price, and the seller discount amount and percentage.")
pickup_options
class-attribute
instance-attribute
¶
pickup_options = Field(None, alias='pickupOptions', description='This container returns the local pickup options available to the buyer. This container is returned only if the user is searching for local pickup items and set the local pickup filters in the method request.')
price
class-attribute
instance-attribute
¶
price = Field(None, description='The price of the item after it has been converted into another currency. The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.')
price_display_condition
class-attribute
instance-attribute
¶
price_display_condition = Field(None, alias='priceDisplayCondition', description="Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.")
priority_listing
class-attribute
instance-attribute
¶
priority_listing = Field(None, alias='priorityListing', description='This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity. Note: Priority Listing is returned only with a Best Match sort and will not be returned for other sort options.')
qualified_programs
class-attribute
instance-attribute
¶
qualified_programs = Field(None, alias='qualifiedPrograms', description='An array of the qualified programs available for the item, such as EBAY_PLUS , AUTHENTICITY_GUARANTEE , and AUTHENTICITY_VERIFICATION . eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.')
seller
class-attribute
instance-attribute
¶
seller = Field(None, description='This container returns basic information about the seller of the item, such as name, feedback score, etc.')
shipping_options
class-attribute
instance-attribute
¶
shipping_options = Field(None, alias='shippingOptions', description='This container returns the shipping options available to ship the item.')
short_description
class-attribute
instance-attribute
¶
short_description = Field(None, alias='shortDescription', description='This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.) Sometimes the title does not provide enough information but the description is too big. Surfacing the shortDescription can often provide buyers with the additional information that could help them make a buying decision.')
thumbnail_images
class-attribute
instance-attribute
¶
thumbnail_images = Field(None, alias='thumbnailImages', description='An array of thumbnail images for the item.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The seller-created title of the item. Maximum Length: 80 characters')
top_rated_buying_experience
class-attribute
instance-attribute
¶
top_rated_buying_experience = Field(None, alias='topRatedBuyingExperience', description='This indicates if the item is a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy; shipping the item in 1 business day with tracking provided; and the added comfort of knowing that this item is from an experienced seller with the highest buyer ratings.')
tyre_label_image_url
class-attribute
instance-attribute
¶
tyre_label_image_url = Field(None, alias='tyreLabelImageUrl', description='The URL to the image that shows the information on the tyre label.')
unit_price
class-attribute
instance-attribute
¶
unit_price = Field(None, alias='unitPrice', description='The price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"')
unit_pricing_measure
class-attribute
instance-attribute
¶
unit_pricing_measure = Field(None, alias='unitPricingMeasure', description='The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"')
watch_count
class-attribute
instance-attribute
¶
watch_count = Field(None, alias='watchCount', description='The number of users that have added the item to their watch list. Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access.')
PaymentMethod ¶
Bases: EbayModel
payment_method_type
class-attribute
instance-attribute
¶
payment_method_type = Field(None, alias='paymentMethodType', description='The payment method type, such as credit card or cash.')
payment_method_brands
class-attribute
instance-attribute
¶
payment_method_brands = Field(None, alias='paymentMethodBrands', description='The payment method brands, including the payment method brand type and logo image.')
payment_instructions
class-attribute
instance-attribute
¶
payment_instructions = Field(None, alias='paymentInstructions', description='The payment instructions for the buyer, such as cash in person or contact seller .')
seller_instructions
class-attribute
instance-attribute
¶
seller_instructions = Field(None, alias='sellerInstructions', description='The seller instructions to the buyer, such as accepts credit cards or see description .')
SearchPagedCollection ¶
Bases: EbayModel
auto_corrections
class-attribute
instance-attribute
¶
auto_corrections = Field(None, alias='autoCorrections', description='The auto-corrected inputs.')
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the current page of results. The following example of the search method returns items 1 thru 5 from the list of items found. https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0')
item_summaries
class-attribute
instance-attribute
¶
item_summaries = Field(None, alias='itemSummaries', description='An array of the items on this page. The items are sorted according to the sorting method specified in the request.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter submitted in the request, which is the maximum number of items to return on a page, from the result set. A result set is the complete set of items returned by the method.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. The following example of the search method returns items 5 thru 10 from the list of items found. https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This value indicates the offset used for current page of items being returned. Assume the initial request used an offset of 0 and a limit of 3 . Then in the first page of results, this value would be 0 , and items 1-3 are returned. For the second page, this value is 3 and so on.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This is returned if there is a previous page of results from the result set. The following example of the search method returns items 1 thru 5 from the list of items found, which would be the first set of items returned. https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0')
refinement
class-attribute
instance-attribute
¶
refinement = Field(None, description='The container for all the search refinements.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of items that match the input criteria. Note: total is just an indicator of the number of listings for a given query. It could vary based on the number of listings with variations included in the result. It is strongly recommended that total not be used in pagination use cases. Instead, use next to determine the results on the next page.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='The container with all the warnings for the request.')
SellerDetail ¶
Bases: EbayModel
feedback_percentage
class-attribute
instance-attribute
¶
feedback_percentage = Field(None, alias='feedbackPercentage', description='The percentage of the total positive feedback.')
feedback_score
class-attribute
instance-attribute
¶
feedback_score = Field(None, alias='feedbackScore', description='The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.')
seller_account_type
class-attribute
instance-attribute
¶
seller_account_type = Field(None, alias='sellerAccountType', description='This indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS . If they register for a private account, this value will be INDIVIDUAL .')
seller_legal_info
class-attribute
instance-attribute
¶
seller_legal_info = Field(None, alias='sellerLegalInfo', description="The container with the seller's contact info and fields that are required by law.")
user_id
class-attribute
instance-attribute
¶
user_id = Field(None, alias='userId', description='The unique identifier of an eBay user across all eBay sites. This value does not change, even when a user changes their username.')
username
class-attribute
instance-attribute
¶
username = Field(None, description='The user name created by the seller for use on eBay. Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance .')
CoreItem ¶
Bases: EbayModel
additional_images
class-attribute
instance-attribute
¶
additional_images = Field(None, alias='additionalImages', description='An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.')
adult_only
class-attribute
instance-attribute
¶
adult_only = Field(None, alias='adultOnly', description='This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers.')
age_group
class-attribute
instance-attribute
¶
age_group = Field(None, alias='ageGroup', description='(Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.')
authenticity_guarantee
class-attribute
instance-attribute
¶
authenticity_guarantee = Field(None, alias='authenticityGuarantee', description='A container for information about whether an item is qualified for the Authenticity Guarantee program. Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer.')
authenticity_verification
class-attribute
instance-attribute
¶
authenticity_verification = Field(None, alias='authenticityVerification', description='A container for information about whether an item is from a verified seller.')
available_coupons
class-attribute
instance-attribute
¶
available_coupons = Field(None, alias='availableCoupons', description='A list of available coupons for the item.')
bid_count
class-attribute
instance-attribute
¶
bid_count = Field(None, alias='bidCount', description='This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='(Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.')
buying_options
class-attribute
instance-attribute
¶
buying_options = Field(None, alias='buyingOptions', description='A comma separated list of all the purchase options available for the item. The values returned are: FIXED_PRICE - Indicates the buyer can purchase the item for a set price using the Buy It Now button. AUCTION - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children.')
category_path
class-attribute
instance-attribute
¶
category_path = Field(None, alias='categoryPath', description='Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks')
color
class-attribute
instance-attribute
¶
color = Field(None, description='(Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container.')
charity_terms
class-attribute
instance-attribute
¶
charity_terms = Field(None, alias='charityTerms', description='This container returns any applicable charity information associated with the specified item. This container is only returned if the fieldgroups query parameter is set to CHARITY_DETAILS .')
condition
class-attribute
instance-attribute
¶
condition = Field(None, description='A short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names . Code so that your app gracefully handles any future changes to this list.')
condition_description
class-attribute
instance-attribute
¶
condition_description = Field(None, alias='conditionDescription', description='A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item.')
condition_id
class-attribute
instance-attribute
¶
condition_id = Field(None, alias='conditionId', description='The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names . Code so that your app gracefully handles any future changes to this list.')
current_bid_price
class-attribute
instance-attribute
¶
current_bid_price = Field(None, alias='currentBidPrice', description='The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The full description of the item that was created by the seller. This can be plain text or rich content and can be very large.')
eligible_for_inline_checkout
class-attribute
instance-attribute
¶
eligible_for_inline_checkout = Field(None, alias='eligibleForInlineCheckout', description='This field indicates if the item can be purchased using the Buy Order API . If the value of this field is true , this indicates that the item can be purchased using the Order API . If the value of this field is false , this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.')
enabled_for_guest_checkout
class-attribute
instance-attribute
¶
enabled_for_guest_checkout = Field(None, alias='enabledForGuestCheckout', description='This indicates if the item can be purchased using Guest Checkout in the Order API . You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards.')
energy_efficiency_class
class-attribute
instance-attribute
¶
energy_efficiency_class = Field(None, alias='energyEfficiencyClass', description="This indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models.")
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.')
estimated_availabilities
class-attribute
instance-attribute
¶
estimated_availabilities = Field(None, alias='estimatedAvailabilities', description='The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.')
gender
class-attribute
instance-attribute
¶
gender = Field(None, description='(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container.')
gtin
class-attribute
instance-attribute
¶
gtin = Field(None, description='The unique Global Trade Item number of the item as defined by https://www.gtin.info . This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.')
image
class-attribute
instance-attribute
¶
image = Field(None, description='The URL of the primary image of the item. The other images of the item are returned in the additionalImages container.')
immediate_pay
class-attribute
instance-attribute
¶
immediate_pay = Field(None, alias='immediatePay', description="A value of true indicates that the seller requires immediate payment from the buyer when purchasing an item. Note: It is possible for this field to be set to true , but not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyers' purchases that involve the Best Offer feature, or for offline transactions.")
inferred_epid
class-attribute
instance-attribute
¶
inferred_epid = Field(None, alias='inferredEpid', description="The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid field. Note: This field is returned only for authorized Partners.")
item_affiliate_web_url
class-attribute
instance-attribute
¶
item_affiliate_web_url = Field(None, alias='itemAffiliateWebUrl', description='The URL to the View Item page of the item which includes the affiliate tracking ID. Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace. The itemAffiliateWebUrl is only returned if: The marketplace through which the item is being viewed is part of the eBay Partner Network.')
item_creation_date
class-attribute
instance-attribute
¶
item_creation_date = Field(None, alias='itemCreationDate', description='A timestamp that indicates the date and time an item listing was created. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer.')
item_end_date
class-attribute
instance-attribute
¶
item_end_date = Field(None, alias='itemEndDate', description='A timestamp that indicates the date and time an auction listing will end. If a fixed-price listing has ended, this field indicates the date and time the listing ended. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which can be converted into the local time of the buyer.')
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique RESTful identifier of the item.')
item_location
class-attribute
instance-attribute
¶
item_location = Field(None, alias='itemLocation', description='The physical location of the item.')
item_web_url
class-attribute
instance-attribute
¶
item_web_url = Field(None, alias='itemWebUrl', description='The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.')
legacy_item_id
class-attribute
instance-attribute
¶
legacy_item_id = Field(None, alias='legacyItemId', description='The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.')
localized_aspects
class-attribute
instance-attribute
¶
localized_aspects = Field(None, alias='localizedAspects', description='An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item.')
lot_size
class-attribute
instance-attribute
¶
lot_size = Field(None, alias='lotSize', description='The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.')
marketing_price
class-attribute
instance-attribute
¶
marketing_price = Field(None, alias='marketingPrice', description='The original price and the discount amount and percentage.')
material
class-attribute
instance-attribute
¶
material = Field(None, description='(Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container.')
minimum_price_to_bid
class-attribute
instance-attribute
¶
minimum_price_to_bid = Field(None, alias='minimumPriceToBid', description="The minimum price of the next bid, which means to place a bid it must be equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding .")
mpn
class-attribute
instance-attribute
¶
mpn = Field(None, description="The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand.")
pattern
class-attribute
instance-attribute
¶
pattern = Field(None, description='(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container.')
payment_methods
class-attribute
instance-attribute
¶
payment_methods = Field(None, alias='paymentMethods', description='The payment methods for the item, including the payment method types, brands, and instructions for the buyer.')
price
class-attribute
instance-attribute
¶
price = Field(None, description='The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB ) to see the VAT-inclusive pricing.')
price_display_condition
class-attribute
instance-attribute
¶
price_display_condition = Field(None, alias='priceDisplayCondition', description="Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.")
primary_item_group
class-attribute
instance-attribute
¶
primary_item_group = Field(None, alias='primaryItemGroup', description='The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent".')
primary_product_review_rating
class-attribute
instance-attribute
¶
primary_product_review_rating = Field(None, alias='primaryProductReviewRating', description='The container that returns the product rating details, such as review count, rating histogram, and average rating.')
priority_listing
class-attribute
instance-attribute
¶
priority_listing = Field(None, alias='priorityListing', description='This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity. For more information, see Promoted Listings .')
product
class-attribute
instance-attribute
¶
product = Field(None, description='The container that returns the product information of the item.')
product_fiche_web_url
class-attribute
instance-attribute
¶
product_fiche_web_url = Field(None, alias='productFicheWebUrl', description="The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available.")
qualified_programs
class-attribute
instance-attribute
¶
qualified_programs = Field(None, alias='qualifiedPrograms', description='An array of the qualified programs available for the item, such as EBAY_PLUS , AUTHENTICITY_GUARANTEE , and AUTHENTICITY_VERIFICATION . eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.')
quantity_limit_per_buyer
class-attribute
instance-attribute
¶
quantity_limit_per_buyer = Field(None, alias='quantityLimitPerBuyer', description='The maximum number for a specific item that one buyer can purchase.')
reserve_price_met
class-attribute
instance-attribute
¶
reserve_price_met = Field(None, alias='reservePriceMet', description='This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for. If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold. Note: This is returned only for auctions that have a reserve price.')
return_terms
class-attribute
instance-attribute
¶
return_terms = Field(None, alias='returnTerms', description="The container that returns an overview of the seller's return policy.")
seller
class-attribute
instance-attribute
¶
seller = Field(None, description='The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.')
seller_item_revision
class-attribute
instance-attribute
¶
seller_item_revision = Field(None, alias='sellerItemRevision', description='An identifier generated/incremented when a seller revises the item. There are two types of item revisions: Seller changes, such as changing the title eBay system changes, such as changing the quantity when an item is purchased This ID is changed only when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed.')
shipping_options
class-attribute
instance-attribute
¶
shipping_options = Field(None, alias='shippingOptions', description='An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. Note: For items with calculated shipping, this array is only returned if the X-EBAY-C-ENDUSERCTX header is supplied.')
ship_to_locations
class-attribute
instance-attribute
¶
ship_to_locations = Field(None, alias='shipToLocations', description='The container that returns the geographic regions to be included and excluded that define where the item can be shipped.')
short_description
class-attribute
instance-attribute
¶
short_description = Field(None, alias='shortDescription', description='This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.).')
size
class-attribute
instance-attribute
¶
size = Field(None, description="(Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container.")
size_system
class-attribute
instance-attribute
¶
size_system = Field(None, alias='sizeSystem', description='(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container. Valid Values: AU (Australia), BR (Brazil), CN (China), DE (Germany), EU (European Union), FR (France), IT (Italy), JP (Japan), MX (Mexico), US (USA), UK (United Kingdom) Code so that your app gracefully handles any future changes to this list.')
size_type
class-attribute
instance-attribute
¶
size_type = Field(None, alias='sizeType', description='(Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container.')
subtitle
class-attribute
instance-attribute
¶
subtitle = Field(None, description='A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results.')
taxes
class-attribute
instance-attribute
¶
taxes = Field(None, description='The container for the tax information for the item.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The seller-created title of the item. Maximum Length: 80 characters')
top_rated_buying_experience
class-attribute
instance-attribute
¶
top_rated_buying_experience = Field(None, alias='topRatedBuyingExperience', description='This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings.')
tyre_label_image_url
class-attribute
instance-attribute
¶
tyre_label_image_url = Field(None, alias='tyreLabelImageUrl', description='The URL to the image that shows the information on the tyre label.')
unique_bidder_count
class-attribute
instance-attribute
¶
unique_bidder_count = Field(None, alias='uniqueBidderCount', description='This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.')
unit_price
class-attribute
instance-attribute
¶
unit_price = Field(None, alias='unitPrice', description='This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"')
unit_pricing_measure
class-attribute
instance-attribute
¶
unit_pricing_measure = Field(None, alias='unitPricingMeasure', description='The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"')
Item ¶
Bases: EbayModel
additional_images
class-attribute
instance-attribute
¶
additional_images = Field(None, alias='additionalImages', description='An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.')
addon_services
class-attribute
instance-attribute
¶
addon_services = Field(None, alias='addonServices', description='A list of add-on services that may be selected for the item or that may apply automatically.')
adult_only
class-attribute
instance-attribute
¶
adult_only = Field(None, alias='adultOnly', description='This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers.')
age_group
class-attribute
instance-attribute
¶
age_group = Field(None, alias='ageGroup', description='(Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.')
authenticity_guarantee
class-attribute
instance-attribute
¶
authenticity_guarantee = Field(None, alias='authenticityGuarantee', description='A container for information about whether an item, or the item group when returned for the getItemsByItemGroup method, is qualified for the Authenticity Guarantee program.')
authenticity_verification
class-attribute
instance-attribute
¶
authenticity_verification = Field(None, alias='authenticityVerification', description='A container for information about whether an item is from a verified seller.')
available_coupons
class-attribute
instance-attribute
¶
available_coupons = Field(None, alias='availableCoupons', description='A list of available coupons for the item. Note: The Browse API only acknowledges item-level coupons. This array will only return coupons linked with an item. Store-level coupons offered by sellers across their entire store will not be returned.')
bid_count
class-attribute
instance-attribute
¶
bid_count = Field(None, alias='bidCount', description='This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='(Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.')
buying_options
class-attribute
instance-attribute
¶
buying_options = Field(None, alias='buyingOptions', description='A comma separated list of all the purchase options available for the item. The values returned are: FIXED_PRICE - Indicates the buyer can purchase the item for a set price using the Buy It Now button. AUCTION - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children.')
category_id_path
class-attribute
instance-attribute
¶
category_id_path = Field(None, alias='categoryIdPath', description='The IDs of every category in the item path, separated by pipe characters, starting with the top level parent category. For example, if an item belongs to the top level category Home and Garden (category ID 11700), followed by Home Improvement (159907), Heating, Cooling and Air (69197), and Thermostats (115947), the field would return the value: 11700|159907|69197|115947 .')
category_path
class-attribute
instance-attribute
¶
category_path = Field(None, alias='categoryPath', description='Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks')
charity_terms
class-attribute
instance-attribute
¶
charity_terms = Field(None, alias='charityTerms', description='This container returns any applicable charity information associated with the specified item. This container is only returned if the fieldgroups query parameter is set to CHARITY_DETAILS .')
color
class-attribute
instance-attribute
¶
color = Field(None, description='(Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container.')
condition
class-attribute
instance-attribute
¶
condition = Field(None, description='A short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names . Code so that your app gracefully handles any future changes to this list.')
condition_description
class-attribute
instance-attribute
¶
condition_description = Field(None, alias='conditionDescription', description='A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item.')
condition_descriptors
class-attribute
instance-attribute
¶
condition_descriptors = Field(None, alias='conditionDescriptors', description='This array is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that indicate details about a particular condition of an item.')
condition_id
class-attribute
instance-attribute
¶
condition_id = Field(None, alias='conditionId', description='The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names . Code so that your app gracefully handles any future changes to this list.')
current_bid_price
class-attribute
instance-attribute
¶
current_bid_price = Field(None, alias='currentBidPrice', description='The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The full description of the item that was created by the seller. This can be plain text or rich content and can be very large.')
eco_participation_fee
class-attribute
instance-attribute
¶
eco_participation_fee = Field(None, alias='ecoParticipationFee', description='The Eco Participation fee, a fee paid by the buyer that is applied to the cost of the eventual disposal of the purchased item. The fee is remitted in full to the eco organization. Currently, this value is required for electronic devices and furniture.')
eligible_for_inline_checkout
class-attribute
instance-attribute
¶
eligible_for_inline_checkout = Field(None, alias='eligibleForInlineCheckout', description='This field indicates if the item can be purchased using the Buy Order API . If the value of this field is true , this indicates that the item can be purchased using the Order API . If the value of this field is false , this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.')
enabled_for_guest_checkout
class-attribute
instance-attribute
¶
enabled_for_guest_checkout = Field(None, alias='enabledForGuestCheckout', description='This indicates if the item can be purchased using Guest Checkout in the Order API . You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards.')
energy_efficiency_class
class-attribute
instance-attribute
¶
energy_efficiency_class = Field(None, alias='energyEfficiencyClass', description="This indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models.")
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.')
estimated_availabilities
class-attribute
instance-attribute
¶
estimated_availabilities = Field(None, alias='estimatedAvailabilities', description='The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.')
gender
class-attribute
instance-attribute
¶
gender = Field(None, description='(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container.')
gtin
class-attribute
instance-attribute
¶
gtin = Field(None, description='The unique Global Trade Item number of the item as defined by https://www.gtin.info . This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.')
hazardous_materials_labels
class-attribute
instance-attribute
¶
hazardous_materials_labels = Field(None, alias='hazardousMaterialsLabels', description='Hazardous materials labels for the item.')
image
class-attribute
instance-attribute
¶
image = Field(None, description='The URL of the primary image of the item. The other images of the item are returned in the additionalImages container.')
immediate_pay
class-attribute
instance-attribute
¶
immediate_pay = Field(None, alias='immediatePay', description='A value of true indicates that the seller requires immediate payment from the buyer when purchasing an item. Note: It is possible for this field to be set to true , but not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyers purchases that involve the Best Offer feature, or for offline transactions.')
inferred_epid
class-attribute
instance-attribute
¶
inferred_epid = Field(None, alias='inferredEpid', description="The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid field. Note: This field is returned only for authorized Partners.")
item_affiliate_web_url
class-attribute
instance-attribute
¶
item_affiliate_web_url = Field(None, alias='itemAffiliateWebUrl', description='The URL to the View Item page of the item which includes the affiliate tracking ID. Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace. The itemAffiliateWebUrl is only returned if: The marketplace through which the item is being viewed is part of the eBay Partner Network.')
item_creation_date
class-attribute
instance-attribute
¶
item_creation_date = Field(None, alias='itemCreationDate', description='A timestamp that indicates the date and time an item listing was created. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer.')
item_end_date
class-attribute
instance-attribute
¶
item_end_date = Field(None, alias='itemEndDate', description='A timestamp that indicates the date and time an auction listing will end. If a fixed-price listing has ended, this field indicates the date and time the listing ended. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which can be converted into the local time of the buyer.')
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique RESTful identifier of the item.')
item_location
class-attribute
instance-attribute
¶
item_location = Field(None, alias='itemLocation', description='The physical location of the item.')
item_web_url
class-attribute
instance-attribute
¶
item_web_url = Field(None, alias='itemWebUrl', description='The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.')
legacy_item_id
class-attribute
instance-attribute
¶
legacy_item_id = Field(None, alias='legacyItemId', description='The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.')
listing_marketplace_id
class-attribute
instance-attribute
¶
listing_marketplace_id = Field(None, alias='listingMarketplaceId', description='The ID of the eBay marketplace where the item is listed.')
localized_aspects
class-attribute
instance-attribute
¶
localized_aspects = Field(None, alias='localizedAspects', description='An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item.')
lot_size
class-attribute
instance-attribute
¶
lot_size = Field(None, alias='lotSize', description='The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.')
manufacturer
class-attribute
instance-attribute
¶
manufacturer = Field(None, description='Contact information for the manufacturer of the product.')
marketing_price
class-attribute
instance-attribute
¶
marketing_price = Field(None, alias='marketingPrice', description='The original price and the discount amount and percentage.')
material
class-attribute
instance-attribute
¶
material = Field(None, description='(Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container.')
minimum_price_to_bid
class-attribute
instance-attribute
¶
minimum_price_to_bid = Field(None, alias='minimumPriceToBid', description="The minimum price of the next bid, which means to place a bid it must be equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding .")
mpn
class-attribute
instance-attribute
¶
mpn = Field(None, description="The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand.")
pattern
class-attribute
instance-attribute
¶
pattern = Field(None, description='(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container.')
payment_methods
class-attribute
instance-attribute
¶
payment_methods = Field(None, alias='paymentMethods', description='The payment methods for the item, including the payment method types, brands, and instructions for the buyer.')
price
class-attribute
instance-attribute
¶
price = Field(None, description='The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB ) to see the VAT-inclusive pricing.')
price_display_condition
class-attribute
instance-attribute
¶
price_display_condition = Field(None, alias='priceDisplayCondition', description="Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.")
primary_item_group
class-attribute
instance-attribute
¶
primary_item_group = Field(None, alias='primaryItemGroup', description='The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent".')
primary_product_review_rating
class-attribute
instance-attribute
¶
primary_product_review_rating = Field(None, alias='primaryProductReviewRating', description='The container that returns the product rating details, such as review count, rating histogram, and average rating.')
priority_listing
class-attribute
instance-attribute
¶
priority_listing = Field(None, alias='priorityListing', description='This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity. For more information, see Promoted Listings .')
product
class-attribute
instance-attribute
¶
product = Field(None, description='The container that returns the product information of the item.')
product_fiche_web_url
class-attribute
instance-attribute
¶
product_fiche_web_url = Field(None, alias='productFicheWebUrl', description="The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available.")
product_safety_labels
class-attribute
instance-attribute
¶
product_safety_labels = Field(None, alias='productSafetyLabels', description='This container provides product safety labels which were provided by the seller, for the listing. The getProductSafetyLabels method of the Sell Metadata API can be used to retrieve the full set of available Product Safety pictogram labels and safety statements.')
qualified_programs
class-attribute
instance-attribute
¶
qualified_programs = Field(None, alias='qualifiedPrograms', description='An array of the qualified programs available for the item, such as EBAY_PLUS , AUTHENTICITY_GUARANTEE , and AUTHENTICITY_VERIFICATION . eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.')
quantity_limit_per_buyer
class-attribute
instance-attribute
¶
quantity_limit_per_buyer = Field(None, alias='quantityLimitPerBuyer', description='The maximum number for a specific item that one buyer can purchase.')
repair_score
class-attribute
instance-attribute
¶
repair_score = Field(None, alias='repairScore', description='A score that describes how easy it is to repair the product. Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always including a single decimal place.')
reserve_price_met
class-attribute
instance-attribute
¶
reserve_price_met = Field(None, alias='reservePriceMet', description='This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for. If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold. Note: This is returned only for auctions that have a reserve price.')
responsible_persons
class-attribute
instance-attribute
¶
responsible_persons = Field(None, alias='responsiblePersons', description='This array provides information about one or more EU-based Responsible Persons or entities associated with the listing.')
return_terms
class-attribute
instance-attribute
¶
return_terms = Field(None, alias='returnTerms', description="The container that returns an overview of the seller's return policy.")
seller
class-attribute
instance-attribute
¶
seller = Field(None, description='The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.')
seller_custom_policies
class-attribute
instance-attribute
¶
seller_custom_policies = Field(None, alias='sellerCustomPolicies', description='A list of the custom policies that are applied to a listing.')
seller_item_revision
class-attribute
instance-attribute
¶
seller_item_revision = Field(None, alias='sellerItemRevision', description='An identifier generated/incremented when a seller revises the item. There are two types of item revisions: Seller changes, such as changing the title eBay system changes, such as changing the quantity when an item is purchased This ID is changed only when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed.')
shipping_options
class-attribute
instance-attribute
¶
shipping_options = Field(None, alias='shippingOptions', description='An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. Note: For items with calculated shipping, this array is only returned if the X-EBAY-C-ENDUSERCTX header is supplied.')
ship_to_locations
class-attribute
instance-attribute
¶
ship_to_locations = Field(None, alias='shipToLocations', description='The container that returns the geographic regions to be included and excluded that define where the item can be shipped.')
short_description
class-attribute
instance-attribute
¶
short_description = Field(None, alias='shortDescription', description='This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.).')
size
class-attribute
instance-attribute
¶
size = Field(None, description="(Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container.")
size_system
class-attribute
instance-attribute
¶
size_system = Field(None, alias='sizeSystem', description='(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container. Valid Values: AU (Australia), BR (Brazil), CN (China), DE (Germany), EU (European Union), FR (France), IT (Italy), JP (Japan), MX (Mexico), US (USA), UK (United Kingdom) Code so that your app gracefully handles any future changes to this list.')
size_type
class-attribute
instance-attribute
¶
size_type = Field(None, alias='sizeType', description='(Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container.')
subtitle
class-attribute
instance-attribute
¶
subtitle = Field(None, description='A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results.')
taxes
class-attribute
instance-attribute
¶
taxes = Field(None, description='The container for the tax information for the item.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The seller-created title of the item. Maximum Length: 80 characters')
top_rated_buying_experience
class-attribute
instance-attribute
¶
top_rated_buying_experience = Field(None, alias='topRatedBuyingExperience', description='This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings.')
tyre_label_image_url
class-attribute
instance-attribute
¶
tyre_label_image_url = Field(None, alias='tyreLabelImageUrl', description='The URL to the image that shows the information on the tyre label.')
unique_bidder_count
class-attribute
instance-attribute
¶
unique_bidder_count = Field(None, alias='uniqueBidderCount', description='This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.')
unit_price
class-attribute
instance-attribute
¶
unit_price = Field(None, alias='unitPrice', description='This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"')
unit_pricing_measure
class-attribute
instance-attribute
¶
unit_pricing_measure = Field(None, alias='unitPricingMeasure', description='The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of warning messages. These types of errors do not prevent the method from executing but should be checked.')
watch_count
class-attribute
instance-attribute
¶
watch_count = Field(None, alias='watchCount', description='The number of users that have added the item to their watch list. Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to Watch Count data in the Browse API.')
ItemGroup ¶
Bases: EbayModel
common_descriptions
class-attribute
instance-attribute
¶
common_descriptions = Field(None, alias='commonDescriptions', description='An array of containers for a description and the item IDs of all the items that have this exact description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, a description that is shared by at least one other item is returned in this container.')
items
class-attribute
instance-attribute
¶
items = Field(None, description='An array of containers for all the item variation details, excluding the description.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of warning messages. These types of errors do not prevent the method from executing but should be checked.')
Items ¶
Bases: EbayModel
items
class-attribute
instance-attribute
¶
items = Field(None, description='An array/list of all the items.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of items retrieved.')
warnings
class-attribute
instance-attribute
¶
warnings = Field(None, description='An array of warning messages. These types of errors do not prevent the method from executing but should be checked.')