Item Feed Service — client.buy.feed¶
Version v1_beta.35.3 · base path /buy/feed/v1_beta · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_item_feed ¶
get_item_feed(*, accept: str, range: str, feed_scope: str, category_id: str, x_ebay_c_marketplace_id: str | None = None, date: str | None = None, raw_response: Literal[False] = False) -> bytes
get_item_feed(*, accept: str, range: str, feed_scope: str, category_id: str, x_ebay_c_marketplace_id: str | None = None, date: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_feed(*, accept: str, range: str, feed_scope: str, category_id: str, x_ebay_c_marketplace_id: str | None = None, date: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
This method lets you download a TSV_GZIP (tab-separated value gzip) Item feed file. The feed file contains all the items from all the child categories of the specified category. The first line of the file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section.
get_item_group_feed ¶
get_item_group_feed(*, accept: str, feed_scope: str, category_id: str, x_ebay_c_marketplace_id: str | None = None, range: str | None = None, date: str | None = None, raw_response: Literal[False] = False) -> bytes
get_item_group_feed(*, accept: str, feed_scope: str, category_id: str, x_ebay_c_marketplace_id: str | None = None, range: str | None = None, date: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_group_feed(*, accept: str, feed_scope: str, category_id: str, x_ebay_c_marketplace_id: str | None = None, range: str | None = None, date: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
get_item_snapshot_feed ¶
get_item_snapshot_feed(*, accept: str, range: str, category_id: str, snapshot_date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> bytes
get_item_snapshot_feed(*, accept: str, range: str, category_id: str, snapshot_date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_snapshot_feed(*, accept: str, range: str, category_id: str, snapshot_date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
The Hourly Snapshot feed file is generated each hour every day for most categories. This method lets you download an Hourly Snapshot TSV_GZIP (tab-separated value gzip) feed file containing the details of all the items that have changed within the specified day and hour for a specific category.
get_item_priority_feed ¶
get_item_priority_feed(*, accept: str, range: str, category_id: str, date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> bytes
get_item_priority_feed(*, accept: str, range: str, category_id: str, date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_item_priority_feed(*, accept: str, range: str, category_id: str, date: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> bytes | httpx.Response
Using this method, you can download a TSV_GZIP (tab separated value gzip) Item Priority feed file, which allows you to track changes (deltas) in the status of your priority items, such as when an item is added or removed from a campaign. The delta feed tracks the changes to the status of items within a category you specify in the input URI.
Models¶
AvailabilityEnum ¶
AvailabilityThresholdEnum ¶
Bases: OpenStrEnum
CurrencyCodeEnum ¶
Bases: OpenStrEnum
DeliveryOptionsEnum ¶
Bases: OpenStrEnum
seller_arranged_local_pickup
class-attribute
instance-attribute
¶
seller_arranged_local_pickup = 'SELLER_ARRANGED_LOCAL_PICKUP'
ErrorParameter ¶
ItemDescription ¶
Bases: EbayModel
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique identifier of the eBay item that is not part of an item group or (in rare cases) the item is part of an item group but does not share a description with other items in the group. In this case, there will be values in the itemId and description columns.')
item_group_id
class-attribute
instance-attribute
¶
item_group_id = Field(None, alias='itemGroupId', description='The unique identifier for the item group (items with variations, such as a shirt in multiple sizes) where the items in the group share the same description . Even though the itemGroupId represents more than one item, the itemGroupId and description are returned only once for the entire group. In this case, there will be values in the itemGroupId and description columns.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The seller created description of the item, which is Base64 encoded. Descriptions can contain HTML code, links, etc. and are often very large.')
ItemDescriptionResponse ¶
Bases: EbayModel
item_descriptions
class-attribute
instance-attribute
¶
item_descriptions = Field(None, alias='itemDescriptions', description='The container for the array of items descriptions returned by the Item Description feed file. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values for each item. The header labels match the fields that are described in the Response fields section.')
ItemGroup ¶
Bases: EbayModel
item_group_id
class-attribute
instance-attribute
¶
item_group_id = Field(None, alias='itemGroupId', description='The unique identifier for the item group. This ID is returned in the primaryItemGroupId column of the Item Feed file.')
item_group_type
class-attribute
instance-attribute
¶
item_group_type = Field(None, alias='itemGroupType', description='The item group type. For example: SELLER_DEFINED_VARIATIONS , indicates that the item group was created by the seller. When you create your code, ensure that your app gracefully handles any future changes to this list. Important! This field no longer returns values and is scheduled for deprecation.')
title
class-attribute
instance-attribute
¶
title = Field(None, description='The seller created title of the item group. This text is an escaped string when special characters are present, using the following rules: Double quotes (") and backslashes (\\) in the Title are escaped with a backslash (\\) character If there are any tabs (\\t), double quotes ("), or backslashes (\\) in the Title, the entire Title will be wrapped in double quotes.')
varies_by_localized_aspects
class-attribute
instance-attribute
¶
varies_by_localized_aspects = Field(None, alias='variesByLocalizedAspects', description='A pipe separated ( | ) list of the aspect (variation) names for this item group. The aspect name is Base64 encoded. Note: This column can contain multiple values. Encoded Format: aspectName | aspectName Encoded Example (The delimiters are emphasized ): Q29sb3I= | U2l6ZQ== Decoded: Color|Size')
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageUrl', description='The URL to the primary image of the item. The other images of the item group are returned in the additionalImageUrls column.')
additional_image_urls
class-attribute
instance-attribute
¶
additional_image_urls = Field(None, alias='additionalImageUrls', description='A pipe separated ( | ) list of URLs for the additional images for the item group. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values.')
image_altering_prohibited
class-attribute
instance-attribute
¶
image_altering_prohibited = Field(None, alias='imageAlteringProhibited', description='A boolean that indicates whether the images can be altered. If the value is true , you cannot modify the image. Note: Due to image licensing agreements and other legal concerns, modification (including resizing) of some images is strictly prohibited. These images are for display as-is only.')
ItemGroupResponse ¶
Bases: EbayModel
item_groups
class-attribute
instance-attribute
¶
item_groups = Field(None, alias='itemGroups', description='The container for the array of items groups returned by the getItemGroupFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values for each item. The header labels match the fields that are described in the Response fields section.')
ItemPriority ¶
Bases: EbayModel
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique identifier of an item in eBay RESTful format. An example would be v1|1********2|4********2 .')
priority_listing_payload
class-attribute
instance-attribute
¶
priority_listing_payload = Field(None, alias='priorityListingPayload', description='EPN (eBay Partner Network) publishers append this value to their affiliate tracking URL when using an EPN tracking link to track changes that occur to Priority Listing items.')
change_metadata
class-attribute
instance-attribute
¶
change_metadata = Field(None, alias='changeMetadata', description='Status change indicator of the listing. Values: ADDED_TO_CAMPAIGN REMOVED_FROM_CAMPAIGN TRACKING_PAYLOAD_REFRESHED Note: When a listing is removed from the campaign, PriorityListingPayload will be empty. When multiple status changes are returned for a listing, the changeMetadata value will be a pipe-separated string (e.g., ADDED_TO_CAMPAIGN|TRACKING_PAYLOAD_REFRESHED ).')
ItemPriorityResponse ¶
Bases: EbayModel
item_delta
class-attribute
instance-attribute
¶
item_delta = Field(None, alias='itemDelta', description='The container for the array of items returned by the getItemPriorityFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values on each line. The header labels match the fields that are described in the ItemPriority fields.')
LengthUnitOfMeasureEnum ¶
OptionalityEnum ¶
Product ¶
Bases: EbayModel
epid
class-attribute
instance-attribute
¶
epid = Field(None, description="The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search method to retrieve items for this product and in the Marketing API methods to retrieve 'also viewed' and 'also bought' products to encourage up-selling and cross-selling.")
title
class-attribute
instance-attribute
¶
title = Field(None, description='The title of the product. This text is an escaped string when special characters are present, using the following rules: Double quotes (") and backslashes (\\) in the Title are escaped with a backslash (\\) character If there are any tabs (\\t), double quotes ("), or backslashes (\\) in the Title, the entire Title will be wrapped in double quotes.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The description of the product, which is Base64 encoded.')
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageUrl', description='The URL to the primary product image. This is the URL of the largest image available based on what the seller submitted.')
additional_image_urls
class-attribute
instance-attribute
¶
additional_image_urls = Field(None, alias='additionalImageUrls', description='A pipe separated ( | ) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values.')
localized_product_aspects
class-attribute
instance-attribute
¶
localized_product_aspects = Field(None, alias='localizedProductAspects', description='A list of the name/value pairs for the aspects of the product, which are Base64 encoded. The aspect label, is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;).')
ProductResponse ¶
Bases: EbayModel
products
class-attribute
instance-attribute
¶
products = Field(None, description='The container for the array of products returned by the getProductFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values on each line. The header labels match the fields that are described in the Response fields section.')
RefundMethodEnum ¶
ReturnMethodEnum ¶
ReturnShippingCostPayerEnum ¶
SellerTrustLevelEnum ¶
TimeDurationUnitEnum ¶
Bases: OpenStrEnum
WeightUnitOfMeasureEnum ¶
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.')
Item ¶
Bases: EbayModel
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique identifier of an item in eBay RESTful format. An example would be v1|1**********2|4**********2 .')
title
class-attribute
instance-attribute
¶
title = Field(None, description='This is the seller-created title of the item. This text is an escaped string when special characters are present, using the following rules: Double quotes (") and backslashes (\\) in the Title are escaped with a backslash (\\) character If there are any tabs (\\t), double quotes ("), or backslashes (\\) in the Title , the entire Title will be wrapped in double quotes.')
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageUrl', description='The URL to the primary image of the item. This is the URL of the largest image available based on what the seller submitted.')
category
class-attribute
instance-attribute
¶
category = Field(None, description='The label of the category. For example: Toys & Hobbies|Action Figures|Comic Book Heroes')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The ID of the category of the item.<br For example: The ID for Toys & Hobbies|Action Figures|Comic Book Heroes is 158671 .')
buying_options
class-attribute
instance-attribute
¶
buying_options = Field(None, alias='buyingOptions', description='A comma-separated list of the purchase options available for the item. Currently the only supported option is FIXED_PRICE . Important! This field no longer returns values and is scheduled for deprecation.')
seller_username
class-attribute
instance-attribute
¶
seller_username = Field(None, alias='sellerUsername', description="The seller's eBay user name. 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 .")
seller_feedback_percentage
class-attribute
instance-attribute
¶
seller_feedback_percentage = Field(None, alias='sellerFeedbackPercentage', description="The percentage of the seller's total positive feedback.")
seller_feedback_score
class-attribute
instance-attribute
¶
seller_feedback_score = Field(None, alias='sellerFeedbackScore', description='The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.')
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.')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='The name brand of the item, such as Nike, Apple, etc.')
mpn
class-attribute
instance-attribute
¶
mpn = Field(None, description='The manufacturer part number, which is a number that is used in combination with brand to identify a product.')
epid
class-attribute
instance-attribute
¶
epid = Field(None, description="The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search method to retrieve items for this product and in the Marketing API methods to retrieve 'also viewed' and 'also bought' products to encourage up-selling and cross-selling.")
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 . When you create your code, ensure that your app gracefully handles any future changes to this list.')
condition
class-attribute
instance-attribute
¶
condition = Field(None, description='The text describing the condition of the item. For a list of condition names, see Item Condition IDs and Names .')
price_value
class-attribute
instance-attribute
¶
price_value = Field(None, alias='priceValue', description='The price of the item, which can be a discounted price. If it is discounted, information about the discount is returned in the originalPriceValue , originalPriceCurrency , discountAmount , and discountPercentage columns. Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces.')
price_currency
class-attribute
instance-attribute
¶
price_currency = Field(None, alias='priceCurrency', description='The currency used for the price of the item. Generally, this is the currency used by the country of the eBay site offering the item.')
primary_item_group_id
class-attribute
instance-attribute
¶
primary_item_group_id = Field(None, alias='primaryItemGroupId', description='The unique identifier for the item group that contains this item. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.')
primary_item_group_type
class-attribute
instance-attribute
¶
primary_item_group_type = Field(None, alias='primaryItemGroupType', description='The item group type. Supported value: SELLER_DEFINED_VARIATIONS , indicates that the item group was created by the seller. When you create your code, ensure that your app gracefully handles any future changes to this list. Important! This field no longer returns values and is scheduled for deprecation.')
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. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which can be converted into the local time of the buyer.')
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.')
item_location_country
class-attribute
instance-attribute
¶
item_location_country = Field(None, alias='itemLocationCountry', description='The country where the item is physically located.')
localized_aspects
class-attribute
instance-attribute
¶
localized_aspects = Field(None, alias='localizedAspects', description='A semicolon separated list of the name/value pairs for the aspects of the item, which are Base64 encoded. The aspect label is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;).')
seller_trust_level
class-attribute
instance-attribute
¶
seller_trust_level = Field(None, alias='sellerTrustLevel', description='An enumeration value representing the eBay status of the seller. Valid Values: TOP_RATED , ABOVE_STANDARD , or an empty value. An empty value indicates a return of anything other than TOP_RATED or ABOVE_STANDARD . <brWhen you create your code, ensure that your app gracefully handles any future changes to this list.')
availability
class-attribute
instance-attribute
¶
availability = Field(None, description="An enumeration value representing the item's availability (possibility of being purchased). Values: AVAILABLE TEMPORARILY_UNAVAILABLE UNAVAILABLE When you create your code, ensure that your app gracefully handles any future changes to this list.")
image_altering_prohibited
class-attribute
instance-attribute
¶
image_altering_prohibited = Field(None, alias='imageAlteringProhibited', description='A boolean that indicates whether the images can be altered. If the value is true , you cannot modify the image. Note: Due to image licensing agreements and other legal concerns, modification (including resizing) of some images is strictly prohibited. These images are for display as-is only.')
estimated_available_quantity
class-attribute
instance-attribute
¶
estimated_available_quantity = Field(None, alias='estimatedAvailableQuantity', description='The estimated quantity of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.')
availability_threshold_type
class-attribute
instance-attribute
¶
availability_threshold_type = Field(None, alias='availabilityThresholdType', description='This column has a value only when the seller sets their availability threshold preference. The value of this column will show MORE_THAN , which indicates that the seller has more than the available threshold preference in stock for this item. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity.')
availability_threshold
class-attribute
instance-attribute
¶
availability_threshold = Field(None, alias='availabilityThreshold', description='This column has a value only when the seller sets their availability threshold preference. The value of this column will be "10", which is the threshold value. Note: This field and the availabilityThresholdType field will be returned as null if the actual quantity meets or drops below the threshold value, and then the buyer will want to look at the value in the estimatedAvailableQuantity field.')
returns_accepted
class-attribute
instance-attribute
¶
returns_accepted = Field(None, alias='returnsAccepted', description='Indicates whether the seller accepts returns for the item.')
return_period_value
class-attribute
instance-attribute
¶
return_period_value = Field(None, alias='returnPeriodValue', description="The amount of days that the buyer has to return the item after the purchase date. For example, if this value is '30', the return period is 30 days.")
return_period_unit
class-attribute
instance-attribute
¶
return_period_unit = Field(None, alias='returnPeriodUnit', description='An enumeration value that indicates the period of time being used to measure the duration, such as business days, months, or years. TimeDurationUnitEnum is a common type shared by multiple eBay APIs and fields to express the time unit, but for return period duration, this value will always be DAY .')
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. When you create your code, ensure that your app gracefully handles any future changes to this list. Important! This field no longer returns values and is scheduled for deprecation.')
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 column will have data if the seller offers the buyer an item replacement or exchange instead of a monetary refund. Important! This field no longer returns values and is scheduled for deprecation.')
return_shipping_cost_payer
class-attribute
instance-attribute
¶
return_shipping_cost_payer = Field(None, alias='returnShippingCostPayer', description='The party responsible for the return shipping costs when an item is returned. Valid Values: BUYER or SELLER When you create your code, ensure that your app gracefully handles any future changes to this list.')
accepted_payment_methods
class-attribute
instance-attribute
¶
accepted_payment_methods = Field(None, alias='acceptedPaymentMethods', description='This field is returned empty. For a list of payment methods available for a marketplace, see eBay help pages or the actual View Item page. Important! This field no longer returns values and is scheduled for deprecation.')
delivery_options
class-attribute
instance-attribute
¶
delivery_options = Field(None, alias='deliveryOptions', description='A comma-separated list of available delivery options. This column lets you filter out items than cannot be shipped to the buyer. Valid Values : SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, and PICKUP_DROP_OFF. When you create your code, ensure that your app gracefully handles any future changes to this list.')
ship_to_included_regions
class-attribute
instance-attribute
¶
ship_to_included_regions = Field(None, alias='shipToIncludedRegions', description='A pipe ( | ) separated alphabetical list of the geographic countries and regions where the seller will ship the item. If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship. The COUNTRY: list is separated from the REGION: list with a semicolon ( ; ).')
ship_to_excluded_regions
class-attribute
instance-attribute
¶
ship_to_excluded_regions = Field(None, alias='shipToExcludedRegions', description='A pipe ( | ) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restrict) the shipToIncludedRegions list. The COUNTRY: list is separated from the REGION: list with a semicolon ( ; ).')
inferred_epid
class-attribute
instance-attribute
¶
inferred_epid = Field(None, alias='inferredEpid', description="The ePID (eBay Product ID of a product in 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 actually provided an ePID at listing time for the item, the ePID value is returned in the epid column instead.")
inferred_gtin
class-attribute
instance-attribute
¶
inferred_gtin = Field(None, alias='inferredGtin', description="The GTIN (Global Trade Item Number) of the product as defined by https://www.gtin.info , which as been programmatically determined by eBay. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. If the seller provided a GTIN for the item, the seller's value is returned in the gtin column.")
inferred_brand
class-attribute
instance-attribute
¶
inferred_brand = Field(None, alias='inferredBrand', description="The name brand for the item, such as Nike or Apple, which has been programmatically determined by eBay. To identify the product, this is always used along with MPN . If the seller provided a brand for the item, the seller's value is returned in the brand column.")
inferred_mpn
class-attribute
instance-attribute
¶
inferred_mpn = Field(None, alias='inferredMpn', description="The MPN (Manufacturer's Part Number) for the item, which has been programmatically determined by eBay. To identify the product, this is always used along with brand . If the seller provided a MPN for the item, the seller's value is returned in the mpn column.")
inferred_localized_aspects
class-attribute
instance-attribute
¶
inferred_localized_aspects = Field(None, alias='inferredLocalizedAspects', description="A semicolon separated list of the name/value pairs for the aspects of the item, which are Base64 encoded. These aspects have been programmatically determined by eBay. If the seller provided aspects for the item, the seller's values are returned in the localizedAspects column.")
additional_image_urls
class-attribute
instance-attribute
¶
additional_image_urls = Field(None, alias='additionalImageUrls', description='A pipe separated ( | ) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values.')
original_price_value
class-attribute
instance-attribute
¶
original_price_value = Field(None, alias='originalPriceValue', description='The original selling price of the item. This lets you surface a strikethrough price for the item.')
original_price_currency
class-attribute
instance-attribute
¶
original_price_currency = Field(None, alias='originalPriceCurrency', description='The currency of the originalPriceValue of the item and the discountAmount .')
discount_amount
class-attribute
instance-attribute
¶
discount_amount = Field(None, alias='discountAmount', description='The calculated amount of the discount ( originalPriceValue - priceValue ). For example, if originalPriceValue is 70 and priceValue is 56, this value would be 14. Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency .')
discount_percentage
class-attribute
instance-attribute
¶
discount_percentage = Field(None, alias='discountPercentage', description='The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20.')
energy_efficiency_class
class-attribute
instance-attribute
¶
energy_efficiency_class = Field(None, alias='energyEfficiencyClass', description="Indicates the European energy efficiency rating (EEK) of the item. Data is returned in this column 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.")
qualified_programs
class-attribute
instance-attribute
¶
qualified_programs = Field(None, alias='qualifiedPrograms', description='A pipe separated list of the qualified programs available for the item. Valid Values: EBAY_PLUS : Indicates an item is eligible for eBay Plus. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Note: eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.')
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.')
length_unit_of_measure
class-attribute
instance-attribute
¶
length_unit_of_measure = Field(None, alias='lengthUnitOfMeasure', description='The unit of measurement used for the package dimensions, such as INCH, FEET, CENTIMETER, or METER. When you create your code, ensure that your app gracefully handles any future changes to this list. Important! This field no longer returns values and is scheduled for deprecation.')
package_width
class-attribute
instance-attribute
¶
package_width = Field(None, alias='packageWidth', description='The width of the shipping package that contains the item. Important! This field no longer returns values and is scheduled for deprecation.')
package_height
class-attribute
instance-attribute
¶
package_height = Field(None, alias='packageHeight', description='The height of the shipping package that contains the item. Important! This field no longer returns values and is scheduled for deprecation.')
package_length
class-attribute
instance-attribute
¶
package_length = Field(None, alias='packageLength', description='The length of the shipping package that contains the item. Important! This field no longer returns values and is scheduled for deprecation.')
weight_unit_of_measure
class-attribute
instance-attribute
¶
weight_unit_of_measure = Field(None, alias='weightUnitOfMeasure', description='The unit of measurement used for the package weight, such as POUND, KILOGRAM, OUNCE, or GRAM. When you create your code, ensure that your app gracefully handles any future changes to this list. Important! This field no longer returns values and is scheduled for deprecation.')
package_weight
class-attribute
instance-attribute
¶
package_weight = Field(None, alias='packageWeight', description='The weight of the package that contains the item. Important! This field no longer returns values and is scheduled for deprecation.')
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. Important! This field no longer returns values and is scheduled for deprecation.')
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. Important! This field no longer returns values and is scheduled for deprecation.')
shipping_type
class-attribute
instance-attribute
¶
shipping_type = Field(None, alias='shippingType', description='The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.')
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. Note: The price includes 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.')
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.')
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). Important! This field no longer returns values and is scheduled for deprecation.")
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. Important! This field no longer returns values and is scheduled for deprecation.')
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"')
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.')
alerts
class-attribute
instance-attribute
¶
alerts = Field(None, description='A pipe-separated list of alerts available for the item. For example, if the DELAYED_DELIVERY alert was returned for an item, it would indicate a delay in shipping by the seller.')
seller_account_type
class-attribute
instance-attribute
¶
seller_account_type = Field(None, alias='sellerAccountType', description='A string value that specifies whether the seller is a business or an individual. This is determined when the seller registers with eBay. If the seller registers for a business account, the value returned in this field will be BUSINESS . If the seller registers for a private account, the value returned in this field will be INDIVIDUAL .')
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.')
priority_listing_payload
class-attribute
instance-attribute
¶
priority_listing_payload = Field(None, alias='priorityListingPayload', description='EPN (eBay Partner Network) publishers append this value to their affiliate tracking URL when using an EPN tracking link to track changes that occur to Priority Listing items.')
item_creation_date
class-attribute
instance-attribute
¶
item_creation_date = Field(None, alias='itemCreationDate', description='A timestamp indicating when the item was created. Format: UTC yyyy-MM-ddThh:mm:ss.sssZ')
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. For example: Single SKU: https://www.ebay.de/itm/2********0 MSKU: https://www.ebay.com/itm/2********9?var=5********2')
default_image_url
class-attribute
instance-attribute
¶
default_image_url = Field(None, alias='defaultImageUrl', description='URL to the gallery or default image of the item. The other images of the item are returned in the additionalImageUrls field. For example https://i.ebayimg.com/00/s/M********w/z/W********p/$_1. JPG?set_id=8********F')
item_affiliate_web_url
class-attribute
instance-attribute
¶
item_affiliate_web_url = Field(None, alias='itemAffiliateWebUrl', description='The URL of the View Item page of the item, with the affiliate tracking ID appended to it. For example https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=707-53477-19255-0&campid=CAMPAIGNID&toolid=2***6&customid=CUSTOMID')
age_group
class-attribute
instance-attribute
¶
age_group = Field(None, alias='ageGroup', description='The age group that the product is recommended for. Valid values: newborn , infant , toddler , kids , adult .')
color
class-attribute
instance-attribute
¶
color = Field(None, description='The color of the item.')
pattern
class-attribute
instance-attribute
¶
pattern = Field(None, description='Text describing the pattern used on the item. For example, paisley. Note: All the item aspects, including this aspect, are returned in the localizedAspects container.')
gender
class-attribute
instance-attribute
¶
gender = Field(None, description='In cases where items could vary by gender, this specifies for which gender the product is intended. Possible values include male, female, and unisex.')
material
class-attribute
instance-attribute
¶
material = Field(None, description='The material that the item is made of.')
total_units
class-attribute
instance-attribute
¶
total_units = Field(None, alias='totalUnits', description='For an item that is priced by the unit, the total number of units that are on offer. For example, if the item is priced by the meter and 50 cm is on offer, the totalUnits would be 0.5 m.')
eco_participation_fee_value
class-attribute
instance-attribute
¶
eco_participation_fee_value = Field(None, alias='ecoParticipationFeeValue', description='The amount of the Eco Participation Fee, a fee paid toward the eventual disposal of the purchased item.')
eco_participation_fee_currency
class-attribute
instance-attribute
¶
eco_participation_fee_currency = Field(None, alias='ecoParticipationFeeCurrency', description='The currency in which the Eco Participation Fee for the item is paid.')
take_back_policy_label
class-attribute
instance-attribute
¶
take_back_policy_label = Field(None, alias='takeBackPolicyLabel', description="The seller-defined label of the TAKE_BACK custom policy for the item. A TAKE_BACK policy describes the seller's regulatory responsibility to take back a purchased item for disposal when the buyer purchases a new one.")
take_back_policy_description
class-attribute
instance-attribute
¶
take_back_policy_description = Field(None, alias='takeBackPolicyDescription', description='The seller-defined description of the TAKE_BACK custom policy for the item.')
hazmat_signal_word_id
class-attribute
instance-attribute
¶
hazmat_signal_word_id = Field(None, alias='hazmatSignalWordId', description='The ID of the signal word for the hazardous material.')
hazmat_signal_word
class-attribute
instance-attribute
¶
hazmat_signal_word = Field(None, alias='hazmatSignalWord', description="The localized signal word for the hazardous material, such as 'Danger'.")
hazmat_statement_ids
class-attribute
instance-attribute
¶
hazmat_statement_ids = Field(None, alias='hazmatStatementIds', description='The IDs of hazardous material statements, separated by the pipe symbol. For example: H200|H221')
hazmat_statement_descriptions
class-attribute
instance-attribute
¶
hazmat_statement_descriptions = Field(None, alias='hazmatStatementDescriptions', description='The Base64 encoded descriptions of hazardous material statements, separated by the pipe symbol. For example: encoded(Unstable explosives)|encoded(Flammable gas)')
hazmat_pictogram_ids
class-attribute
instance-attribute
¶
hazmat_pictogram_ids = Field(None, alias='hazmatPictogramIds', description='The IDs of hazardous material pictograms, separated by the pipe symbol. For example: SGH01|SGH02')
hazmat_pictogram_descriptions
class-attribute
instance-attribute
¶
hazmat_pictogram_descriptions = Field(None, alias='hazmatPictogramDescriptions', description='The Base64 encoded descriptions of hazardous material pictograms, separated by the pipe symbol. For example: encoded(exploding bomb)|encoded(flame)')
hazmat_pictogram_image_urls
class-attribute
instance-attribute
¶
hazmat_pictogram_image_urls = Field(None, alias='hazmatPictogramImageUrls', description='The image URLs of hazardous material pictograms, separated by the pipe symbol. For example: https://img1|https://img2')
hazmat_additional_information
class-attribute
instance-attribute
¶
hazmat_additional_information = Field(None, alias='hazmatAdditionalInformation', description='Base64 encoded additional information about the hazardous material.')
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.')
condition_descriptors
class-attribute
instance-attribute
¶
condition_descriptors = Field(None, alias='conditionDescriptors', description='Note: Condition descriptors are currently only available for applicable categories. This field contains a list of the name/value pairs for the condition descriptors of the item, which are Base64 encoded.')
seller_user_id
class-attribute
instance-attribute
¶
seller_user_id = Field(None, alias='sellerUserId', description='The unique identifier of an eBay user across all eBay sites. This value does not change, even when a user changes their username.')
ItemResponse ¶
Bases: EbayModel
items
class-attribute
instance-attribute
¶
items = Field(None, description='The container for the array of items returned by the getItemFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values on each line. The header labels match the fields that are described in the Response fields section.')
ItemSnapshot ¶
Bases: EbayModel
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique identifier of an item in eBay RESTful format. An example would be v1|1**********2|4**********2 .')
availability
class-attribute
instance-attribute
¶
availability = Field(None, description="An enumeration value representing the item's availability (possibility of being purchased). Values: AVAILABLE TEMPORARILY_UNAVAILABLE UNAVAILABLE When you create your code, ensure that your app gracefully handles any future changes to this list.")
title
class-attribute
instance-attribute
¶
title = Field(None, description='The seller created title of the item. This text is an escaped string when special characters are present, using the following rules: Double quotes (") and backslashes (\\) in the Title are escaped with a backslash (\\) character If there are any tabs (\\t), double quotes ("), or backslashes (\\) in the Title, the entire Title will be wrapped in double quotes.')
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageUrl', description='The URL to the primary image of the item. This is the URL of the largest image available based on what the seller submitted.')
category
class-attribute
instance-attribute
¶
category = Field(None, description='The label of the category of the item. For example: Toys & Hobbies|Action Figures|Comic Book Heroes .')
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The ID of the leaf category for this item.')
buying_options
class-attribute
instance-attribute
¶
buying_options = Field(None, alias='buyingOptions', description='A comma separated list of the purchase options available for the item. Currently the only supported option is FIXED_PRICE . Important! This field no longer returns values and is scheduled for deprecation.')
seller_username
class-attribute
instance-attribute
¶
seller_username = Field(None, alias='sellerUsername', description="The seller's eBay user name.")
seller_feedback_percentage
class-attribute
instance-attribute
¶
seller_feedback_percentage = Field(None, alias='sellerFeedbackPercentage', description="The percentage of the seller's total positive feedback.")
seller_feedback_score
class-attribute
instance-attribute
¶
seller_feedback_score = Field(None, alias='sellerFeedbackScore', description='The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.')
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.')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='The name brand of the item, such as Nike, Apple, etc.')
mpn
class-attribute
instance-attribute
¶
mpn = Field(None, description='The manufacturer part number, which is a number that is used in combination with brand to identify a product.')
epid
class-attribute
instance-attribute
¶
epid = Field(None, description="The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search method to retrieve items for this product and in the Marketing API methods to retrieve 'also viewed' and 'also bought' products to encourage up-selling and cross-selling.")
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 . When you create your code, ensure that your app gracefully handles any future changes to this list.')
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, see Item Condition IDs and Names .')
price_value
class-attribute
instance-attribute
¶
price_value = Field(None, alias='priceValue', description='The price of the item, which can be a discounted price. Note: The price includes 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_currency
class-attribute
instance-attribute
¶
price_currency = Field(None, alias='priceCurrency', description='The currency used for the price of the item. Generally, this is the currency used by the country of the eBay site offering the item.')
primary_item_group_id
class-attribute
instance-attribute
¶
primary_item_group_id = Field(None, alias='primaryItemGroupId', description='The unique identifier for the item group that contains this item. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.')
primary_item_group_type
class-attribute
instance-attribute
¶
primary_item_group_type = Field(None, alias='primaryItemGroupType', description='The item group type. Supported value: SELLER_DEFINED_VARIATIONS , indicates that the item group was created by the seller. When you create your code, ensure that your app gracefully handles any future changes to this list. Important! This field no longer returns values and is scheduled for deprecation.')
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. This value is returned in UTC format ( yyyy-MM-ddThh:mm:ss.sssZ ), which can be converted into the local time of the buyer.')
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.')
item_location_country
class-attribute
instance-attribute
¶
item_location_country = Field(None, alias='itemLocationCountry', description='The country where the item is physically located.')
localized_aspects
class-attribute
instance-attribute
¶
localized_aspects = Field(None, alias='localizedAspects', description='A semicolon separated list of the name/value pairs for the aspects of the item, which are Base64 encoded. The aspect label is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;).')
seller_trust_level
class-attribute
instance-attribute
¶
seller_trust_level = Field(None, alias='sellerTrustLevel', description='An enumeration value representing the eBay status of the seller. Valid Values: TOP_RATED , ABOVE_STANDARD , or an empty value. An empty value indicates a return of anything other than TOP_RATED or ABOVE_STANDARD . When you create your code, ensure that your app gracefully handles any future changes to this list.')
image_altering_prohibited
class-attribute
instance-attribute
¶
image_altering_prohibited = Field(None, alias='imageAlteringProhibited', description='A boolean that indicates whether the images can be altered. If the value is true , you cannot modify the image. Note: Due to image licensing agreements and other legal concerns, modification (including resizing) of some images is strictly prohibited. These images are for display as-is only.')
estimated_available_quantity
class-attribute
instance-attribute
¶
estimated_available_quantity = Field(None, alias='estimatedAvailableQuantity', description='The estimated quantity of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.')
availability_threshold_type
class-attribute
instance-attribute
¶
availability_threshold_type = Field(None, alias='availabilityThresholdType', description='This column has a value only when the seller sets their availability threshold preference. The value of this column will show MORE_THAN , which indicates that the seller has more than the available threshold preference in stock for this item. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity.')
availability_threshold
class-attribute
instance-attribute
¶
availability_threshold = Field(None, alias='availabilityThreshold', description='This column has a value only when the seller sets their availability threshold preference. The value of this column will be "10", which is the threshold value. Note: This field and the availabilityThresholdType field will be returned as null if the actual quantity meets or drops below the threshold value, and then the buyer will want to look at the value in the estimatedAvailableQuantity field.')
item_snapshot_date
class-attribute
instance-attribute
¶
item_snapshot_date = Field(None, alias='itemSnapshotDate', description="This timestamp denotes the date and time the changes for that item were picked up and added to the snapshot feed file. For example, let's say you have a snapshot feed file and also ran the getItem method. When you compare the same item information from the two sources, you see that the price in the getItem method response is different from the price in the snapshot feed file.")
original_price_value
class-attribute
instance-attribute
¶
original_price_value = Field(None, alias='originalPriceValue', description='The original selling price of the item. This lets you surface a strikethrough price for the item.')
original_price_currency
class-attribute
instance-attribute
¶
original_price_currency = Field(None, alias='originalPriceCurrency', description='The currency of the originalPriceValue of the item and the discountAmount .')
discount_amount
class-attribute
instance-attribute
¶
discount_amount = Field(None, alias='discountAmount', description='The calculated amount of the discount ( originalPriceValue - priceValue ). For example, if originalPriceValue is 70 and priceValue is 56, this value would be 14. Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency .')
discount_percentage
class-attribute
instance-attribute
¶
discount_percentage = Field(None, alias='discountPercentage', description='The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20.')
returns_accepted
class-attribute
instance-attribute
¶
returns_accepted = Field(None, alias='returnsAccepted', description='Indicates whether the seller accepts returns for the item.')
return_period_value
class-attribute
instance-attribute
¶
return_period_value = Field(None, alias='returnPeriodValue', description='The amount of days that the buyer has to return the item after the purchase date. For example, if this value is 30 , the return period is 30 days.')
return_period_unit
class-attribute
instance-attribute
¶
return_period_unit = Field(None, alias='returnPeriodUnit', description='An enumeration value that indicates the period of time being used to measure the duration, such as business days, months, or years. TimeDurationUnitEnum is a common type shared by multiple eBay APIs and fields to express the time unit, but for return period duration, this value will always be DAY .')
refund_method
class-attribute
instance-attribute
¶
refund_method = Field(None, alias='refundMethod', description='An enumeration value representing how a buyer is refunded when an item is returned. When you create your code, ensure that your app gracefully handles any future changes to this list. Important! This field no longer returns values and is scheduled for deprecation.')
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 column will have data if the seller offers the buyer an item replacement or exchange instead of a monetary refund. Important! This field no longer returns values and is scheduled for deprecation.')
return_shipping_cost_payer
class-attribute
instance-attribute
¶
return_shipping_cost_payer = Field(None, alias='returnShippingCostPayer', description='An enumeration value that indicates the party responsible for the return shipping costs when an item is returned. Valid Values: BUYER or SELLER When you create your code, ensure that your app gracefully handles any future changes to this list.')
energy_efficiency_class
class-attribute
instance-attribute
¶
energy_efficiency_class = Field(None, alias='energyEfficiencyClass', description="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.")
additional_image_urls
class-attribute
instance-attribute
¶
additional_image_urls = Field(None, alias='additionalImageUrls', description='A pipe separated ( | ) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values.')
delivery_options
class-attribute
instance-attribute
¶
delivery_options = Field(None, alias='deliveryOptions', description='A comma-separated list of available delivery options. This column lets you filter out items than cannot be shipped to the buyer. Valid Values : SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, and PICKUP_DROP_OFF. When you create your code, ensure that your app gracefully handles any future changes to this list.')
ship_to_included_regions
class-attribute
instance-attribute
¶
ship_to_included_regions = Field(None, alias='shipToIncludedRegions', description='A pipe ( | ) separated alphabetical list of the geographic countries and regions where the seller will ship the item. If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship. The COUNTRY: list is separated from the REGION: list with a semicolon ( ; ).')
ship_to_excluded_regions
class-attribute
instance-attribute
¶
ship_to_excluded_regions = Field(None, alias='shipToExcludedRegions', description='A pipe ( | ) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restrict) the shipToIncludedRegions list. The COUNTRY: list is separated from the REGION: list with a semicolon ( ; ).')
accepted_payment_methods
class-attribute
instance-attribute
¶
accepted_payment_methods = Field(None, alias='acceptedPaymentMethods', description='This field is returned empty. For a list of payment methods available for a marketplace, see eBay help pages or the actual View Item page. Important! This field no longer returns values and is scheduled for deprecation.')
qualified_programs
class-attribute
instance-attribute
¶
qualified_programs = Field(None, alias='qualifiedPrograms', description='A pipe separated list of the qualified programs available for the item, such as EBAY_PLUS and AUTHENTICITY_GUARANTEE. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings.')
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.')
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. Important! This field no longer returns values and is scheduled for deprecation.')
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. Important! This field no longer returns values and is scheduled for deprecation.')
shipping_type
class-attribute
instance-attribute
¶
shipping_type = Field(None, alias='shippingType', description='The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.')
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. Note: The price includes 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.')
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 When you create your code, ensure that your app gracefully handles any future changes to this list.')
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). Important! This field no longer returns values and is scheduled for deprecation.")
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 shipping estimation information. Important! This field no longer returns values and is scheduled for deprecation.')
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" }')
inferred_epid
class-attribute
instance-attribute
¶
inferred_epid = Field(None, alias='inferredEpid', description="The ePID (eBay Product ID of a product in 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 actually provided an ePID at listing time for the item, the ePID value is returned in the epid column instead.")
item_creation_date
class-attribute
instance-attribute
¶
item_creation_date = Field(None, alias='itemCreationDate', description='A timestamp indicating when the item was created. Format: UTC yyyy-MM-ddThh:mm:ss.sssZ')
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.')
alerts
class-attribute
instance-attribute
¶
alerts = Field(None, description='A pipe-separated list of alerts available for the item. For example, if the DELAYED_DELIVERY alert was returned for an item, it would indicate a delay in shipping by the seller.')
seller_account_type
class-attribute
instance-attribute
¶
seller_account_type = Field(None, alias='sellerAccountType', description='A string value that specifies whether the seller is a business or an individual. This is determined when the seller registers with eBay. If the seller registers for a business account, the value returned in this field will be BUSINESS . If the seller registers for a private account, the value returned in this field will be INDIVIDUAL .')
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.')
age_group
class-attribute
instance-attribute
¶
age_group = Field(None, alias='ageGroup', description='The age group that the product is recommended for. Valid values: newborn , infant , toddler , kids , adult .')
color
class-attribute
instance-attribute
¶
color = Field(None, description='The color of the item.')
pattern
class-attribute
instance-attribute
¶
pattern = Field(None, description='(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. Note: All the item aspects, including this aspect, are returned in the localizedAspects container.')
gender
class-attribute
instance-attribute
¶
gender = Field(None, description='In cases where items could vary by gender, this specifies for which gender the product is intended. Possible values include male, female, and unisex.')
material
class-attribute
instance-attribute
¶
material = Field(None, description='The material that the item is made of.')
total_units
class-attribute
instance-attribute
¶
total_units = Field(None, alias='totalUnits', description='For an item that is priced by the unit, the total number of units that are on offer. For example, if the item is priced by the meter and 50 cm is on offer, the totalUnits would be 0.5 m.')
default_image_url
class-attribute
instance-attribute
¶
default_image_url = Field(None, alias='defaultImageUrl', description='URL to the gallery or default image of the item. The other images of the item are returned in the additionalImageUrls field. For example https://i.ebayimg.com/00/s/M********w/z/W********p/$_1. JPG?set_id=8********F')
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. For example: Single SKU: https://www.ebay.de/itm/2********0 MSKU: https://www.ebay.com/itm/2********9?var=5********2')
item_affiliate_web_url
class-attribute
instance-attribute
¶
item_affiliate_web_url = Field(None, alias='itemAffiliateWebUrl', description='The URL of the View Item page of the item, with the affiliate tracking ID appended to it. For example https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=707-53477-19255-0&campid=CAMPAIGNID&toolid=2***6&customid=CUSTOMID')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The seller created description of the item. For example: Brand-new, unused, and unworn. Not in original packaging.')
change_metadata
class-attribute
instance-attribute
¶
change_metadata = Field(None, alias='changeMetadata', description='Status change indicator of the listing. Values: PRICE_CHANGE QUANTITY_CHANGE TITLE_CHANGE DELETED NEW ENDED')
eco_participation_fee_value
class-attribute
instance-attribute
¶
eco_participation_fee_value = Field(None, alias='ecoParticipationFeeValue', description='The amount of the Eco Participation Fee, a fee paid toward the eventual disposal of the purchased item.')
eco_participation_fee_currency
class-attribute
instance-attribute
¶
eco_participation_fee_currency = Field(None, alias='ecoParticipationFeeCurrency', description='The currency in which the Eco Participation Fee for the item is paid.')
take_back_policy_label
class-attribute
instance-attribute
¶
take_back_policy_label = Field(None, alias='takeBackPolicyLabel', description="The seller-defined label of the TAKE_BACK custom policy for the item. A TAKE_BACK policy describes the seller's regulatory responsibility to take back a purchased item for disposal when the buyer purchases a new one.")
take_back_policy_description
class-attribute
instance-attribute
¶
take_back_policy_description = Field(None, alias='takeBackPolicyDescription', description='The seller-defined description of the TAKE_BACK custom policy for the item.')
authenticity_guarantee_service_id
class-attribute
instance-attribute
¶
authenticity_guarantee_service_id = Field(None, alias='authenticityGuaranteeServiceId', description='The unique identifier for the Authenticity Guarantee service associated with the item.')
authenticity_guarantee_selection
class-attribute
instance-attribute
¶
authenticity_guarantee_selection = Field(None, alias='authenticityGuaranteeSelection', description='An indication of whether the Authenticity Guarantee service is optional or mandatory for the item.')
authenticity_guarantee_fee_value
class-attribute
instance-attribute
¶
authenticity_guarantee_fee_value = Field(None, alias='authenticityGuaranteeFeeValue', description='The price of the Authenticity Guarantee service for the item. Note: The price returned in this field indicates the service fee for a single item quantity.')
authenticity_guarantee_fee_currency
class-attribute
instance-attribute
¶
authenticity_guarantee_fee_currency = Field(None, alias='authenticityGuaranteeFeeCurrency', description='The currency used for the Authenticity Guarantee service fee.')
coupon_discount_type
class-attribute
instance-attribute
¶
coupon_discount_type = Field(None, alias='couponDiscountType', description='The type of discount that the coupon applies.')
coupon_redemption_code
class-attribute
instance-attribute
¶
coupon_redemption_code = Field(None, alias='couponRedemptionCode', description='The redemption code for the coupon.')
coupon_message
class-attribute
instance-attribute
¶
coupon_message = Field(None, alias='couponMessage', description='A description of the coupon.')
coupon_terms_web_url
class-attribute
instance-attribute
¶
coupon_terms_web_url = Field(None, alias='couponTermsWebUrl', description='The URL to the coupon terms of use.')
coupon_discount_value
class-attribute
instance-attribute
¶
coupon_discount_value = Field(None, alias='couponDiscountValue', description='The discount amount after the coupon is applied.')
coupon_discount_currency
class-attribute
instance-attribute
¶
coupon_discount_currency = Field(None, alias='couponDiscountCurrency', description='The currency used to specify the coupon discount value.')
coupon_expiration_date
class-attribute
instance-attribute
¶
coupon_expiration_date = Field(None, alias='couponExpirationDate', description='The expiration date for the coupon. Format: UTC yyyy-MM-ddThh:mm:ss.sssZ')
hazmat_signal_word_id
class-attribute
instance-attribute
¶
hazmat_signal_word_id = Field(None, alias='hazmatSignalWordId', description='The ID of the signal word for the hazardous material.')
hazmat_signal_word
class-attribute
instance-attribute
¶
hazmat_signal_word = Field(None, alias='hazmatSignalWord', description="The localized signal word for the hazardous material, such as 'Danger'.")
hazmat_statement_ids
class-attribute
instance-attribute
¶
hazmat_statement_ids = Field(None, alias='hazmatStatementIds', description='The IDs of hazardous material statements, separated by the pipe symbol. For example: H200|H221')
hazmat_statement_descriptions
class-attribute
instance-attribute
¶
hazmat_statement_descriptions = Field(None, alias='hazmatStatementDescriptions', description='The Base64 encoded descriptions of hazardous material statements, separated by the pipe symbol. For example: encoded(Unstable explosives)|encoded(Flammable gas)')
hazmat_pictogram_ids
class-attribute
instance-attribute
¶
hazmat_pictogram_ids = Field(None, alias='hazmatPictogramIds', description='The IDs of hazardous material pictograms, separated by the pipe symbol. For example: SGH01|SGH02')
hazmat_pictogram_descriptions
class-attribute
instance-attribute
¶
hazmat_pictogram_descriptions = Field(None, alias='hazmatPictogramDescriptions', description='The Base64 encoded descriptions of hazardous material pictograms, separated by the pipe symbol. For example: encoded(exploding bomb)|encoded(flame)')
hazmat_pictogram_image_urls
class-attribute
instance-attribute
¶
hazmat_pictogram_image_urls = Field(None, alias='hazmatPictogramImageUrls', description='The image URLs of hazardous material pictograms, separated by the pipe symbol. For example: https://img1|https://img2')
hazmat_additional_information
class-attribute
instance-attribute
¶
hazmat_additional_information = Field(None, alias='hazmatAdditionalInformation', description='Base64 encoded additional information about the hazardous material.')
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.')
condition_descriptors
class-attribute
instance-attribute
¶
condition_descriptors = Field(None, alias='conditionDescriptors', description='Note: Condition descriptors are currently only available for applicable categories. This field contains a list of the name/value pairs for the condition descriptors of the item, which are Base64 encoded.')
seller_user_id
class-attribute
instance-attribute
¶
seller_user_id = Field(None, alias='sellerUserId', description='The unique identifier for an eBay user across all eBay sites. This value does not change, even when a user changes their username.')
ItemSnapshotResponse ¶
Bases: EbayModel
items
class-attribute
instance-attribute
¶
items = Field(None, description='The container for the array of items returned by the getItemSnapshotFeed method. Note: When the value of the availability column is UNAVAILABLE , only the itemId and availability columns are populated.')