Buy Offer API — client.buy.offer¶
Version v1_beta.0.1 · base path /buy/offer/v1_beta · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_bidding ¶
get_bidding(item_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> buy_offer_models.Bidding
get_bidding(item_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_bidding(item_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> buy_offer_models.Bidding | httpx.Response
This method retrieves the bidding details that are specific to the buyer of the specified auction. This must be an auction where the buyer has already placed a bid. To retrieve the bidding information you use a user access token and pass in the item ID of the auction.
place_proxy_bid ¶
place_proxy_bid(item_id: str, *, body: PlaceProxyBidRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> buy_offer_models.PlaceProxyBidResponse
place_proxy_bid(item_id: str, *, body: PlaceProxyBidRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
place_proxy_bid(item_id: str, *, body: PlaceProxyBidRequest | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> buy_offer_models.PlaceProxyBidResponse | httpx.Response
This method uses a user access token to place a proxy bid for the buyer on a specific auction item. The item must offer AUCTION as one of the buyingOptions . To place a bid, you pass in the item ID of the auction as a URI parameter and the buyer's maximum bid amount ( maxAmount ) in the payload. By placing a proxy bid, the buyer is agreeing to purchase the item if they win the auction.
Models¶
AuctionStatusEnum ¶
CurrencyCodeEnum ¶
Bases: OpenStrEnum
ErrorParameter ¶
PlaceProxyBidResponse ¶
Bases: EbayModel
proxy_bid_id
class-attribute
instance-attribute
¶
proxy_bid_id = Field(None, alias='proxyBidId', description='Identifier of the proxy bid created by the request. This indicates that the bid was placed and is not used for anything else.')
UserConsent ¶
Bases: EbayModel
adult_only_item
class-attribute
instance-attribute
¶
adult_only_item = Field(None, alias='adultOnlyItem', description='The type that defines the fields for buyer consent to bid on adult-only items. This field must be included in the placeProxyBid request and set to true if the buyer is bidding on an adult-only item. For more information about adult-only items on eBay, see Adult-Only items on eBay .')
Amount ¶
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.')
PlaceProxyBidRequest ¶
Bases: EbayModel
max_amount
class-attribute
instance-attribute
¶
max_amount = Field(None, alias='maxAmount', description='The amount of the proxy bid to be placed. This is the maximum amount the buyer is willing to pay for the item. Note: Currency for the bid must be the currency specified by the seller when listing the item. VAT (value added tax) does not need to be added to the proxy bid amount even if VAT applies.')
user_consent
class-attribute
instance-attribute
¶
user_consent = Field(None, alias='userConsent', description='Specifies whether the buyer wants to give their consent to bid on adult-only items. For a buyer to bid on an adult-only item, you must collect their consent using this field, and they must agree to the Terms of Use. For more information about adult-only items on eBay, see Adult-Only items on eBay . Default: false')
ProxyBid ¶
Bases: EbayModel
max_amount
class-attribute
instance-attribute
¶
max_amount = Field(None, alias='maxAmount', description='The maximum amount the buyer is willing to pay for the item.')
proxy_bid_id
class-attribute
instance-attribute
¶
proxy_bid_id = Field(None, alias='proxyBidId', description='Identifier of a specific proxy bid.')
Bidding ¶
Bases: EbayModel
auction_end_date
class-attribute
instance-attribute
¶
auction_end_date = Field(None, alias='auctionEndDate', description='The date the auction will end.')
auction_status
class-attribute
instance-attribute
¶
auction_status = Field(None, alias='auctionStatus', description='An enumeration value that represents the current state of the auction, such as ACTIVE or ENDED . If this value is ENDED and the value of highBidder is true , this indicates the buyer has won the auction.')
bid_count
class-attribute
instance-attribute
¶
bid_count = Field(None, alias='bidCount', description='The number of proxy bids that have been placed for the auction.')
current_price
class-attribute
instance-attribute
¶
current_price = Field(None, alias='currentPrice', description='The amount of the highest bid, which is the current price of the item.')
current_proxy_bid
class-attribute
instance-attribute
¶
current_proxy_bid = Field(None, alias='currentProxyBid', description="The buyer's proxy bid, which is the maxAmount specified in the request.")
high_bidder
class-attribute
instance-attribute
¶
high_bidder = Field(None, alias='highBidder', description='Indicates if the buyer is the highest bidder. If the value is false , this indicates that either the buyer has not bid on this item or has been out-bid. If this value is true , this indicates the buyer is winning the auction and if the value of auctionStatus is ENDED , this indicates the buyer has won the auction.')
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The eBay RESTful identifier of an item being bid on, which was submitted in the request.')
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.')
suggested_bid_amounts
class-attribute
instance-attribute
¶
suggested_bid_amounts = Field(None, alias='suggestedBidAmounts', description='The suggested bid amount for the next bid. Note: These are generated suggestions and do not guarantee the buyer will win the bid. This means these suggestions do not take into account the max bid amount of other bidders. The buyer can be outbid even if they submit the highest suggested bid.')