offer APIv1_beta.0.0.1

getBidding

GET
/bidding/{item_id}
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.

URLs for this method

  • Production URL: https://api.ebay.com/buy/offer/v1_beta/bidding/
  • Sandbox URL: https://api.sandbox.ebay.com/buy/offer/v1_beta/bidding/

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

Input

Resource URI (production)

GET https://api.ebay.com/buy/offer/v1_beta/bidding/{item_id}

URI parameters

ParameterTypeDescription
item_idstringThe 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.

RESTful Item ID example: v1|272394640372|0

For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.

Restriction: The buyer must have placed a bid for this item.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThe ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive.

For example:
  X-EBAY-C-MARKETPLACE-ID = EBAY_US

For a list of supported sites see, API Restrictions.

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/buy.offer.auction

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
auctionEndDatestringThe date the auction will end.

Occurrence: Always

auctionStatusAuctionStatusEnumAn enumeration value that represents the current state of the auction, such as 'ENDED' or 'LIVE'.

If this value is ENDED and the value of highBidder is true, this indicates the buyer has won the auction.

Occurrence: Always

bidCountintegerThe number of proxy bids that have been placed for the auction.

Occurrence: Always

currentPriceAmountThe amount of the highest bid, which is the current price of the item.

Occurrence: Always

currentPrice.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field.

Occurrence: Always

currentPrice.valuestringThe monetary amount.

Occurrence: Always

currentProxyBidProxyBidThe buyer's proxy bid, which is the maxAmount specified in the request.

Occurrence: Always

currentProxyBid.maxAmountAmountThe maximum amount the buyer is willing to pay for the item.

Occurrence: Always

currentProxyBid.maxAmount.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field.

Occurrence: Always

currentProxyBid.maxAmount.valuestringThe monetary amount.

Occurrence: Always

currentProxyBid.proxyBidIdstringIdentifier of a specific proxy bid.

Occurrence: Always

highBidderbooleanIndicates 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.

Occurrence: Always

itemIdstringThe eBay RESTful identifier of an item being bid on, which was submitted in the request.

Occurrence: Always

reservePriceMetbooleanThis 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.

Occurrence: Conditional

suggestedBidAmountsarray of AmountThe 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.

Occurrence: Conditional

suggestedBidAmounts.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field.

Occurrence: Always

suggestedBidAmounts.valuestringThe monetary amount.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200OK
404Not found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
120000API_OFFERAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
120001API_OFFERREQUESTThe item ID {item_id} was not found. Check that this is an active auction item ID.
120015API_OFFERREQUESTThe X-EBAY-C-MARKETPLACE-ID header is missing. This is a required header.
120017API_OFFERREQUESTThe Marketplace {marketplace_id} is not supported. Supported values are [marketplace_ids].
120033API_OFFERREQUESTThere is no bidding activity for this auction (item ID {item_id}).

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retrieve Bidding Information

Retrieves the bidding information for a specific auction where the buyer has placed at least one bid.

Input

The input is the item_id passed in as a URI paramater.
GET
https://api.ebay.com/buy/offer/v1_beta/bidding/v1|202117468662|0

Output

This call returns the bidding information of a specific auction, such as if the buyer is the high bidder, the currentPrice, reservePriceMet, suggestedBidAmounts, etc.