{
"swagger": "2.0",
"info": {
"description": "Note: This is a (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.
The Buy Offer API enables Partners to place proxy bids for a buyer and retrieve the auctions where the buyer is bidding. By placing a proxy bid, the buyer is agreeing to purchase the item if they win the auction.",
"version": "v1_beta.0.1",
"title": "Buy Offer API",
"contact": {
"name": "eBay Inc,"
},
"license": {
"name": "eBay API License Agreement",
"url": "https://go.developer.ebay.com/api-license-agreement"
}
},
"host": "api.ebay.com",
"basePath": "/buy/offer/v1_beta",
"schemes": [
"https"
],
"paths": {
"/bidding/{item_id}": {
"get": {
"tags": [
"bidding"
],
"description": "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. You can also retrieve general bidding details about the auction, such as minimum bid price and the count of unique bidders, using the Browse API getItem method.
For a list of supported sites and other restrictions, see API Restrictions.
", "operationId": "getBidding", "produces": [ "application/json" ], "parameters": [ { "name": "item_id", "in": "path", "description": "The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods.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}
For a list of supported sites and other restrictions, see API Restrictions.
", "operationId": "placeProxyBid", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "item_id", "in": "path", "description": "The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods.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."
},
"currentPrice": {
"$ref": "#/definitions/Amount"
},
"currentProxyBid": {
"$ref": "#/definitions/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": "#/definitions/Amount" } } }, "description": "The type the defines the field for the auction details." }, "PlaceProxyBidRequest": { "type": "object", "properties": { "maxAmount": { "$ref": "#/definitions/Amount" }, "userConsent": { "$ref": "#/definitions/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": { "$ref": "#/definitions/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.