Listing API — client.sell.listing¶
Version v1_beta.2.1 · base path /sell/listing/v1_beta · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
create_item_draft ¶
create_item_draft(*, body: ItemDraft | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_listing_models.ItemDraftResponse
create_item_draft(*, body: ItemDraft | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_item_draft(*, body: ItemDraft | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_listing_models.ItemDraftResponse | httpx.Response
This call gives Partners the ability to create an eBay draft of a item for their seller using information from their site. This lets the Partner increase the exposure of items on their site and leverage the eBay user listing experience seamlessly. This experience provides guidance on pricing, aspects, etc.
Models¶
Amount ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='The three-letter ISO 4217 code representing the currency of the amount in the value field. Restriction: Only the currency of the marketplace is supported. For example, on the US marketplace the only currency supported is USD. For implementation help, refer to eBay API documentation')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount, in the currency specified by the currency field.')
Aspect ¶
Charity ¶
Bases: EbayModel
donation_percentage
class-attribute
instance-attribute
¶
donation_percentage = Field(None, alias='donationPercentage', description='This field sets the percentage of the purchase price that the charitable organization (identified in the charityId field) will receive for each sale that the listing generates. This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization.')
charity_id
class-attribute
instance-attribute
¶
charity_id = Field(None, alias='charityId', description='The eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds. The charitable organization must be reqistered with the PayPal Giving Fund in order to receive sales proceeds through eBay listings. This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization.')
ErrorParameter ¶
ItemDraftResponse ¶
Bases: EbayModel
item_draft_id
class-attribute
instance-attribute
¶
item_draft_id = Field(None, alias='itemDraftId', description='The eBay generated ID of the listing draft.')
sell_flow_native_uri
class-attribute
instance-attribute
¶
sell_flow_native_uri = Field(None, alias='sellFlowNativeUri', description='The URI the Partner uses to send the seller to their listing draft that was created on the eBay site. From there the seller can change, update, and publish the item on eBay. This is returned when the seller is using a mobile app.')
sell_flow_url
class-attribute
instance-attribute
¶
sell_flow_url = Field(None, alias='sellFlowUrl', description='The web URL the Partner uses to send the seller to the listing draft that was created on the eBay site. From there the seller can change, update, and publish the item on eBay. This is returned when the seller is using mobile web (mweb) or the desktop web. Note: You must construct the URL using the URL returned in this field and a session token. For example: sellFlowUrl?id_token=session_token')
PricingSummary ¶
Bases: EbayModel
auction_reserve_price
class-attribute
instance-attribute
¶
auction_reserve_price = Field(None, alias='auctionReservePrice', description="The minimum amount the seller is willing to sell the item for. If the reserve price isn't met, the item won't be sold. For details, see How reserve prices work. Restrictions: The value is not supported for FIXED_PRICE format. The value format has a maximum of two decimal points.")
auction_start_price
class-attribute
instance-attribute
¶
auction_start_price = Field(None, alias='auctionStartPrice', description='The minimum amount required for the first bid. Note: The auctionStartPrice value must be less than the auctionReservePrice value. Restrictions: The value is not supported for FIXED_PRICE format. The value format has a maximum of two decimal points.')
price
class-attribute
instance-attribute
¶
price = Field(None, description='The Buy It Now Price for the item.')
Product ¶
Bases: EbayModel
aspects
class-attribute
instance-attribute
¶
aspects = Field(None, description='The list of item aspects that describe the item (such as size, color, capacity, model, brand, etc.)')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='The name brand of the item, such as Nike, Apple, etc.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The description of the item that was created by the seller. This field supports plain text or rich content within HTML tags. Note: Active content is not supported. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions. Max Length: 500,000')
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='An EPID is the eBay product identifier of a product from the eBay product catalog. Note: If you submit both a category ID and an EPID, eBay determines the best category based on the EPID and uses that. The category ID will be ignored.')
image_urls
class-attribute
instance-attribute
¶
image_urls = Field(None, alias='imageUrls', description='The image URLs of the item. The first URL will be the primary image, which appears on the View Item page in the eBay listing. The URL can be from the following: The eBay Picture Services (images previously uploaded). A server outside of eBay (self-hosted). For more details, see PictureURL and Introduction to Pictures in Listings.')
title
class-attribute
instance-attribute
¶
title = Field(None, description="The seller-created title of the item. This should include unique characteristics of the item, such as brand, model, color, size, capacity, etc. For example: Levi's 501 size 10 black jeans")
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.')
ItemDraft ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The ID of the leaf category associated with this item. A leaf category is the lowest level in that category and has no children. Note: If you submit both a category ID and an EPID, eBay determines the best category based on the EPID and uses that. The category ID will be ignored.')
condition
class-attribute
instance-attribute
¶
condition = Field(None, description="An enumeration value representing the condition of the item, such as NEW. Note: In all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified Refurbished, and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished, a seller must be pre-qualified by eBay for this feature.")
format
class-attribute
instance-attribute
¶
format = Field(None, description='The format of the listing. Valid Values: FIXED_PRICE and AUCTION For implementation help, refer to eBay API documentation')
pricing_summary
class-attribute
instance-attribute
¶
pricing_summary = Field(None, alias='pricingSummary', description='The container that for the information about the cost of an item, such as the price or auction start price.')
product
class-attribute
instance-attribute
¶
product = Field(None, description='The container for the product details of the item.')
charity
class-attribute
instance-attribute
¶
charity = Field(None, description='This container is used to identify the charitable organization that will receive a percentage of sale proceeds for each sale generated by the listing. This container consists of the charityId field to identify the charitable organization, and the donationPercentage field that will set the percentage of the sales proceeds that will be donated to the charitable organization.')