![\"Limited](\"/cms/img/docs/partners-api.svg\" "\\"Limited")
(Limited Release) API available only to select developers approved by business units. For information on how to obtain access to this API in production, see the Buy APIs Requirements.(Limited Release) API available only to select developers approved by business units. For information on how to obtain access to this API in production, see the Buy APIs Requirements.For a list of supported sites and other restrictions, see API Restrictions.
", "operationId": "getBidding", "parameters": [ { "name": "item_id", "in": "path", "description": "This path parameter specifies the unique eBay RESTful identifier of an item for which you want the buyer's bidding information.v1|2**********2|0 X-EBAY-C-MARKETPLACE-ID = EBAY_US AUCTION as one of the buyingOptions. After this bid is placed, if someone else outbids the buyer a bid, eBay automatically bids again for the buyer up to the amount of their maximum bid. When the bid exceeds the buyer's maximum bid, eBay will notify them that they have been outbid.
To find auctions, you can use the Browse API to search for items and use a filter to return only auction items. For example:
/buy/browse/v1/item_summary/search?q=iphone&filter=buyingOptions:{AUCTION}
v1|2**********2|0 X-EBAY-C-MARKETPLACE-ID = EBAY_US ACTIVE or ENDED. ENDED and the value of highBidder is true, this indicates the buyer has won the auction. For implementation help, refer to eBay API documentation"
},
"bidCount": {
"type": "integer",
"description": "The number of proxy bids that have been placed for the auction.",
"format": "int32"
},
"currentPrice": {
"description": "The amount of the highest bid, which is the current price of the item.",
"$ref": "#/components/schemas/Amount"
},
"currentProxyBid": {
"description": "The buyer's proxy bid, which is the maxAmount specified in the request. ",
"$ref": "#/components/schemas/ProxyBid"
},
"highBidder": {
"type": "boolean",
"description": "Indicates if the buyer is the highest bidder. false, this indicates that either the buyer has not bid on this item or has been out-bid. 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.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.
" }, "suggestedBidAmounts": { "type": "array", "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.", "items": { "$ref": "#/components/schemas/Amount" } } }, "description": "The type the defines the field for the auction details." }, "Error": { "type": "object", "properties": { "category": { "type": "string", "description": "Identifies the type of erro." }, "domain": { "type": "string", "description": "Name for the primary system where the error occurred. This is relevant for application errors." }, "errorId": { "type": "integer", "description": "A unique number to identify the error.", "format": "int32" }, "inputRefIds": { "type": "array", "description": "An array of request elements most closely associated to the error.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "A more detailed explanation of the error." }, "message": { "type": "string", "description": "Information on how to correct the problem, in the end user's terms and language where applicable." }, "outputRefIds": { "type": "array", "description": "An array of request elements most closely associated to the error.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.", "items": { "$ref": "#/components/schemas/ErrorParameter" } }, "subdomain": { "type": "string", "description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc." } }, "description": "This type defines the fields that can be returned in an error." }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "The object of the error." }, "value": { "type": "string", "description": "The value of the object." } } }, "PlaceProxyBidRequest": { "type": "object", "properties": { "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.For more information about adult-only items on eBay, see Adult-Only items on eBay.
Default: false
", "$ref": "#/components/schemas/UserConsent" } }, "description": "The type that defines the fields for placing a proxy bid." }, "PlaceProxyBidResponse": { "type": "object", "properties": { "proxyBidId": { "type": "string", "description": "Identifier of the proxy bid created by the request. This indicates that the bid was placed and is not used for anything else." } }, "description": "The type that defines the fields for the place proxy bid response." }, "ProxyBid": { "type": "object", "properties": { "maxAmount": { "description": "The maximum amount the buyer is willing to pay for the item.", "$ref": "#/components/schemas/Amount" }, "proxyBidId": { "type": "string", "description": "Identifier of a specific proxy bid." } }, "description": "The type the defines the fields for the proxy bid information." }, "UserConsent": { "type": "object", "properties": { "adultOnlyItem": { "type": "boolean", "description": "The type that defines the fields for buyer consent to bid on adult-only items.true if the buyer is bidding on an adult-only item.