GetAllBidders
Use this call to retrieve bidding activity for a list of eBay users that have bid on an active or recently-ended auction listing.
Usage Details
GetAllBidders provides three modes for retrieving a list of bidders. The call is primarily used as part of the Second Chance Offer feature. In this case, the seller selects one bidder from the list of bidders returned by GetAllBidders. Then, using the bidder's UserID, they extend a Second Chance Offer for the item using AddSecondChanceItem. While this is the primary use-case scenario for GetAllBidders, the data returned in this call can be used for other purposes.
Working with the Response
GetAllBidders returns a list of the item's bidders with their associated bid information (bid time, bid amount, and so on). Traverse the elements in each Offer container to obtain details on each bid. As applicable to the application, store the pertinent data for later use.
If the listing has ended, determine which of the high bidders are actually eligible to purchase items from the listing (i.e., how many are actually winning bidders) and how many items each is eligible to purchase.
Note that if the seller designated the listing as a private auction, the user IDs of some bidders will not be returned. While the private listing is still active, the seller will only have access to the user IDs of the winning bidder(s). For any other bidders the user ID is returned as Invalid Request
. If the function requester is other than the seller, all of the user IDs will be returned as Invalid Request
(except for a bid by the requester). The seller will only have access to all bidders' user IDs through GetAllBidders (winning and non-winning bidders alike) after the listing has ended.
Testing GetAllBidders
You can test this call in the Sandbox environment. However, before testing GetAllBidders, you should have at least three test users. One is needed to list the item and two or more to bid on the listing. If the testing is part of Second Chance Offer functionality, use EndItem to end the item early after the bids have been placed.
It is a good idea to test GetAllBidders using all of the available inputs for limiting the list of bidders. For example, filter on second chance offer enabled and the bidder type. Test using these inputs individually and in combination.
Related Information
See Second change offers.
Output Detail Controls Samples Change History |
Input
See also Samples.
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?> <GetAllBiddersRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <CallMode> GetAllBiddersModeCodeType </CallMode> <IncludeBiddingSummary> boolean </IncludeBiddingSummary> <ItemID> ItemIDType (string) </ItemID> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <OutputSelector> string </OutputSelector> <!-- ... more OutputSelector values allowed here ... --> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </GetAllBiddersRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
CallMode | GetAllBiddersModeCodeType | Optional |
The enumeration value that is passed into this field will control the set of bidders that will be retrieved in the response. To retrieve bidders from a recently-ended auction listing, any of the three values can be used. To retrieve bidders for an active auction listing, only the ViewAll enumeration value can be used. These values are discussed in GetAllBiddersModeCodeType. Default: EndedListing. Applicable values: |
IncludeBiddingSummary | boolean | Conditional |
The user must include this field and set its value to true if the user wishes to retrieve the BiddingSummary container for each bidder. The BiddingSummary container consists of more detailed bidding information on each bidder.
|
ItemID | ItemIDType (string) | Required |
This is the unique identifier of the auction listing for which bidders are being retrieved. This auction listing can be active or recently ended. However, to retrieve bidders for an active auction listing, the only CallMode enumeration value that can be used is ViewAll .
|
Standard Input Fields |
ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
||||||||||||||||||||||||||||||||||||||||
OutputSelector | string | Optional,
repeatable: [0..*] |
You can use the OutputSelector field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload. For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example: If the following output selectors are used: See OutputSelector. |
||||||||||||||||||||||||||||||||||||||||
Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
||||||||||||||||||||||||||||||||||||||||
WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Input Detail Controls Samples Change History |
Output
See also Samples.
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?xml version="1.0" encoding="utf-8"?> <GetAllBiddersResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <BidArray> OfferArrayType <Offer> OfferType <Action> BidActionCodeType </Action> <ConvertedPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedPrice> <Currency> CurrencyCodeType </Currency> <HighestBid currencyID="CurrencyCodeType"> AmountType (double) </HighestBid> <MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid> <MyMaxBid currencyID="CurrencyCodeType"> AmountType (double) </MyMaxBid> <Quantity> int </Quantity> <SecondChanceEnabled> boolean </SecondChanceEnabled> <SiteCurrency> CurrencyCodeType </SiteCurrency> <TimeBid> dateTime </TimeBid> <User> UserType <AboutMePage> boolean </AboutMePage> <BiddingSummary> BiddingSummaryType <BidActivityWithSeller> int </BidActivityWithSeller> <BidRetractions> int </BidRetractions> <BidsToUniqueCategories> int </BidsToUniqueCategories> <BidsToUniqueSellers> int </BidsToUniqueSellers> <ItemBidDetails> ItemBidDetailsType <BidCount> int </BidCount> <CategoryID> string </CategoryID> <ItemID> ItemIDType (string) </ItemID> <LastBidTime> dateTime </LastBidTime> <SellerID> UserIDType (string) </SellerID> </ItemBidDetails> <!-- ... more ItemBidDetails nodes allowed here ... --> <SummaryDays> int </SummaryDays> <TotalBids> int </TotalBids> </BiddingSummary> <BuyerInfo> BuyerType <ShippingAddress> AddressType <Country> CountryCodeType </Country> <PostalCode> string </PostalCode> </ShippingAddress> </BuyerInfo> <eBayGoodStanding> boolean </eBayGoodStanding> <Email> string </Email> <FeedbackPrivate> boolean </FeedbackPrivate> <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar> <FeedbackScore> int </FeedbackScore> <IDVerified> boolean </IDVerified> <NewUser> boolean </NewUser> <PositiveFeedbackPercent> float </PositiveFeedbackPercent> <RegistrationDate> dateTime </RegistrationDate> <Site> SiteCodeType </Site> <Status> UserStatusCodeType </Status> <UserAnonymized> boolean </UserAnonymized> <UserID> UserIDType (string) </UserID> <UserIDChanged> boolean </UserIDChanged> <UserIDLastChanged> dateTime </UserIDLastChanged> <VATStatus> VATStatusCodeType </VATStatus> </User> </Offer> <!-- ... more Offer nodes allowed here ... --> </BidArray> <HighBidder> UserIDType (string) </HighBidder> <HighestBid currencyID="CurrencyCodeType"> AmountType (double) </HighestBid> <ListingStatus> ListingStatusCodeType </ListingStatus> <!-- Standard Output Fields --> <Ack> AckCodeType </Ack> <Build> string </Build> <CorrelationID> string </CorrelationID> <Errors> ErrorType <ErrorClassification> ErrorClassificationCodeType </ErrorClassification> <ErrorCode> token </ErrorCode> <ErrorParameters ParamID="string"> ErrorParameterType <Value> string </Value> </ErrorParameters> <!-- ... more ErrorParameters nodes allowed here ... --> <LongMessage> string </LongMessage> <SeverityCode> SeverityCodeType </SeverityCode> <ShortMessage> string </ShortMessage> </Errors> <!-- ... more Errors nodes allowed here ... --> <HardExpirationWarning> string </HardExpirationWarning> <Timestamp> dateTime </Timestamp> <Version> string </Version> </GetAllBiddersResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
BidArray | OfferArrayType | Always | This container consists of an array of bids made on the specified auction listing. Each OfferType object represents the data for one bid. |
BidArray.Offer | OfferType | Conditionally,
repeatable: [0..*] |
Each Offer container consists of detailed information on each bid made on an auction listing that is specified in the call request. Information in this container includes the amount of the bid, the time of the bid, and data for the user making the bid. |
BidArray.Offer.Action | BidActionCodeType | Always |
Indicates the type of offer being made on the specified listing. If the item is Best Offer-enabled and the buyer makes a Best Offer (or a counter offer), then after the PlaceOffer call, the buyer can get the status of the Best Offer (and a seller-counter-offer, etc.) using the GetBestOffers call. See Best Offer for information about Best Offer-enabled listings and about GetBestOffers.
Applicable values: See Action. Code so that your app gracefully handles any future changes to this list. |
BidArray.Offer.ConvertedPrice | AmountType (double) | Always | Dollar amount of the bid in the user's currency. This field is always returned but its amount will be the same as the value in the MaxBid field, unless currency conversion was actually performed. |
BidArray.Offer.ConvertedPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Dollar amount of the bid in the user's currency. This field is always returned but its amount will be the same as the value in the MaxBid field, unless currency conversion was actually performed. For a list of possible enumeration values, see CurrencyCodeType. |
BidArray.Offer.Currency | CurrencyCodeType | Always |
Three-digit currency code for the currency used for the auction. Valid values can be viewed in the CurrencyCodeType code list.
Applicable values: See Currency. Code so that your app gracefully handles any future changes to this list. |
BidArray.Offer.HighestBid | AmountType (double) | Always | This amount indicates the highest bid that the corresponding bidder has made on the auction item. If that specific bidder has only made one bid on the auction listing, this value will be the same value as in the MaxBid field, but if the bidder has made multiple bids on the auction item, the HighestBid will show the highest of the bidder's bids, but MaxBid will show the value of the corresponding bid. |
BidArray.Offer.HighestBid [ attribute currencyID ] |
CurrencyCodeType | Always |
This amount indicates the highest bid that the corresponding bidder has made on the auction item. If that specific bidder has only made one bid on the auction listing, this value will be the same value as in the MaxBid field, but if the bidder has made multiple bids on the auction item, the HighestBid will show the highest of the bidder's bids, but MaxBid will show the value of the corresponding bid. For a list of possible enumeration values, see CurrencyCodeType. |
BidArray.Offer.MaxBid | AmountType (double) | Always | Amount of the offer placed. For auction listings, the amount bid on the item (subject to outbid by other buyers). For fixed-price listings, the fixed sale price at which the item is purchased. For auction listings with an active Buy It Now option, this amount will be either the Buy It Now price for purchase or the amount of a bid, depending on the offer type (as specified in Action). For PlaceOffer, the CurrencyID attribute is ignored if provided. Regarding Value-Added Tax (VAT): Even if VAT applies, you do not need to add VAT to the MaxBid value. If VAT applies to the listing, the seller can specify a VAT percent value when they list the item. |
BidArray.Offer.MaxBid [ attribute currencyID ] |
CurrencyCodeType | Always |
Amount of the offer placed. For auction listings, the amount bid on the item (subject to outbid by other buyers). For fixed-price listings, the fixed sale price at which the item is purchased. For auction listings with an active Buy It Now option, this amount will be either the Buy It Now price for purchase or the amount of a bid, depending on the offer type (as specified in Action). For PlaceOffer, the CurrencyID attribute is ignored if provided. Regarding Value-Added Tax (VAT): Even if VAT applies, you do not need to add VAT to the MaxBid value. If VAT applies to the listing, the seller can specify a VAT percent value when they list the item. For a list of possible enumeration values, see CurrencyCodeType. |
BidArray.Offer.MyMaxBid | AmountType (double) | Conditionally | The maximum bid placed by the user making the call. This field is only returned if the corresponding bid was made by the user making the call. |
BidArray.Offer.MyMaxBid [ attribute currencyID ] |
CurrencyCodeType | Always |
The maximum bid placed by the user making the call. This field is only returned if the corresponding bid was made by the user making the call. For a list of possible enumeration values, see CurrencyCodeType. |
BidArray.Offer.Quantity | int | Always | Specifies the quantity of items from the specified listing that the user tendering the offer intends to purchase, bid on, or make a Best Offer on. For auctions, the value is always 1 . For multiple-quantity listings, this value must be greater than zero but not exceeding the quantity available for sale in the listing. |
BidArray.Offer .SecondChanceEnabled |
boolean | Always |
Indicates the user's preference to accept second chance offers. If true , the user is willing to be the recipient of second chance offers.
|
BidArray.Offer.SiteCurrency | CurrencyCodeType | Always |
Unique ID identifying the currency in which the localized offer amounts are expressed.
Applicable values: See SiteCurrency. Code so that your app gracefully handles any future changes to this list. |
BidArray.Offer.TimeBid | dateTime | Always | Timestamp indicating the date and time that the bid was placed. |
BidArray.Offer.User | UserType | Always | This container consists of detailed information on the user that made the bid. Some information in this container will be masked unless the call is made by the owner of the listing. |
BidArray.Offer.User .AboutMePage |
boolean | Always |
A value of true indicates that the user has set up an About Me page. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. |
BidArray.Offer.User .BiddingSummary |
BiddingSummaryType | Conditionally |
Contains information about the user as a bidder on a certain item. Returned by GetAllBidders if IncludeBiddingSummary = true is included in the request.
|
BidArray.Offer.User .BiddingSummary .BidActivityWithSeller |
int | Conditionally |
This integer value is actually a percentage value that indicates what percentage of the user's total number of bids during the last 30 days (or the number of days specified in the SummaryDays field) has been placed on auction items that the seller has listed. The percentage value is rounded up to the highest whole percentage number. This field is always returned with the BiddingSummary container. |
BidArray.Offer.User .BiddingSummary.BidRetractions |
int | Conditionally |
This integer value indicates the total number of bids that the user has retracted (from any and all sellers) during the last 30 days (or the number of days specified in the SummaryDays field). This field is always returned with the BiddingSummary container. |
BidArray.Offer.User .BiddingSummary .BidsToUniqueCategories |
int | Conditionally |
This integer value indicates the total number of bids made with unique listing categories that the user has placed during the last 30 days (or the number of days specified in the SummaryDays field). This field is always returned with the BiddingSummary container. |
BidArray.Offer.User .BiddingSummary .BidsToUniqueSellers |
int | Conditionally |
This integer value indicates the total number of bids to unique sellers that the user has placed during the last 30 days (or the number of days specified in the SummaryDays field). This field is always returned with the BiddingSummary container. |
BidArray.Offer.User .BiddingSummary.ItemBidDetails |
ItemBidDetailsType | Conditionally,
repeatable: [0..*] |
This container provides information on each auction item that the user has placed a bid on during the last 30 days (or the number of days specified in the SummaryDays field). |
BidArray.Offer.User .BiddingSummary.ItemBidDetails .BidCount |
int | Conditionally | The total number of bids that the user has placed on the auction item. |
BidArray.Offer.User .BiddingSummary.ItemBidDetails .CategoryID |
string | Conditionally | Unique identifier of the eBay category that the auction item is listed under. |
BidArray.Offer.User .BiddingSummary.ItemBidDetails .ItemID |
ItemIDType (string) | Conditionally |
The unique identifier of an item listed on the eBay site. Since a bidder's user information is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. (GetMyeBayBuying only) when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". (GetMyeBayBuying only) when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". (GetBestOffers only) - all sites: The last part of the user ID is replaced with asterisks for users that submit best offers on an item. The seller of the item will be able to see the full User ID. |
BidArray.Offer.User .BiddingSummary.ItemBidDetails .LastBidTime |
dateTime | Conditionally | This timestamp indicates the date/time at which the user placed the last bid on the auction item. |
BidArray.Offer.User .BiddingSummary.ItemBidDetails .SellerID |
UserIDType (string) | Conditionally |
The eBay ID of the seller who listed the item. This will be returned with the anonymous value "Seller X", where X indicates where the seller falls in the sequence of sellers that the user has purchased items from. For example, if the seller is the third seller that the user has purchased items from, the value "Seller 3" is returned. |
BidArray.Offer.User .BiddingSummary.SummaryDays |
int | Conditionally |
This integer value indicates the length of time (in number of days) that is being used to calculate all counts in the BiddingSummary container. This value is generally 30 (days), which means that all counts in the container have been calculated from the present time and going back 30 days in the past. This field is always returned with the BiddingSummary container. |
BidArray.Offer.User .BiddingSummary.TotalBids |
int | Conditionally |
This integer value indicates the total number of bids (from any and all eBay sellers) that the user has placed during the last 30 days (or the number of days specified in the SummaryDays field). This field is always returned with the BiddingSummary container. |
BidArray.Offer.User.BuyerInfo | BuyerType | Always |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. |
BidArray.Offer.User.BuyerInfo .ShippingAddress |
AddressType | Always |
This container shows the buyer's shipping address. Note: For an Authenticity Guarantee program order returned in GetItemTransactions or GetSellerTransactions, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address. Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order. This is only applicable for GetItemTransactions and GetSellerTransactions calls. Note: For eBay Vault scenarios: GetItemTransactions calls, and GetSellerTransactions calls (Seller View only), mock address details are returned for: <ShippingAddress> |
BidArray.Offer.User.BuyerInfo .ShippingAddress.Country |
CountryCodeType | Always |
The two-digit code representing the country of the user. If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. |
BidArray.Offer.User.BuyerInfo .ShippingAddress.PostalCode |
string | Always |
User's postal code. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. |
BidArray.Offer.User .eBayGoodStanding |
boolean | Always |
This boolean field is returned as true if the eBay user is in good standing with eBay. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. |
BidArray.Offer.User.Email | string | Conditionally |
Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field . |
BidArray.Offer.User .FeedbackPrivate |
boolean | Always |
Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). The percentage of positive feedback can still be returned, even if other feedback details are private. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. |
BidArray.Offer.User .FeedbackRatingStar |
FeedbackRatingStarCodeType | Always |
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See FeedbackRatingStar. Code so that your app gracefully handles any future changes to this list. |
BidArray.Offer.User .FeedbackScore |
int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true . In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.
|
BidArray.Offer.User.IDVerified | boolean | Always |
Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. |
BidArray.Offer.User.NewUser | boolean | Always |
This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less. Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. |
BidArray.Offer.User .PositiveFeedbackPercent |
float | Conditionally |
Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Positive Feedback Percentage value for the user is returned to the buyer or seller, but a dummy value of 0.0 will be returned to all third parties.
|
BidArray.Offer.User .RegistrationDate |
dateTime | Always |
Indicates the date the specified user originally registered with eBay. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. |
BidArray.Offer.User.Site | SiteCodeType | Always |
eBay site the user is registered with. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Applicable values: See Site. Code so that your app gracefully handles any future changes to this list. |
BidArray.Offer.User.Status | UserStatusCodeType | Always |
Indicates the user's registration/user status.
Applicable values: See Status. Code so that your app gracefully handles any future changes to this list. |
BidArray.Offer.User .UserAnonymized |
boolean | Always |
Indicates whether or not the User container has been made anonymous. If true , some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed. Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true .
|
BidArray.Offer.User.UserID | UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot , it might be displayed as, "I****A". Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3 . Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". For PlaceOffer, see also SellingStatus.HighBidder. |
BidArray.Offer.User .UserIDChanged |
boolean | Always |
If true , identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser). Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. |
BidArray.Offer.User .UserIDLastChanged |
dateTime | Always |
Date and time when the user last changed their eBay user ID (in GMT). Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. |
BidArray.Offer.User.VATStatus | VATStatusCodeType | Always |
Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).
Applicable values: Code so that your app gracefully handles any future changes to this list. See Vat-exempt sellers. |
HighBidder | UserIDType (string) | Always | The eBay user ID for the user with the winning bid (if auction has ended) or current highest bid (if auction is still active). The seller should take note of or save this User ID as this user may be a a Second Chance Offer candidate. |
HighestBid | AmountType (double) | Always | This is the dollar amount of the winning bid (if auction has ended) or dollar amount of the current highest bid (if auction is still active). |
HighestBid [ attribute currencyID ] |
CurrencyCodeType | Always |
This is the dollar amount of the winning bid (if auction has ended) or dollar amount of the current highest bid (if auction is still active). For a list of possible enumeration values, see CurrencyCodeType. |
ListingStatus | ListingStatusCodeType | Always |
This enumeration value indicates the listing status of the specified listing.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Standard Output Fields |
Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
CorrelationID | string | Conditionally |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Errors.ErrorCode | token | Conditionally |
A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
See Errors By Number. |
Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
Errors.ErrorParameters.Value | string | Conditionally | This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID. |
Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Error handling section of the Making a Trading API call guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
Input Output Samples Change History |
Detail Controls
DetailLevel
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Input Output Detail Controls Change History |
Samples
New to making API calls? Please see Making a Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Available samples:
- Basic Call ↓ - Retrieving non-winning bidders for an ended listing.
- Bidding Summary ↓ - Retrieves a bidding summary.
Retrieving non-winning bidders for an ended listing.
Description
This call returns a list of the highest bidders who did not win a completed auction.
Input
XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetAllBiddersRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<ItemID>1**********2</ItemID>
</GetAllBiddersRequest>
Output
XML format.
<GetAllBiddersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-04T17:53:55.018Z</Timestamp>
<Ack>Success</Ack>
<Version>1125</Version>
<Build>E1125_CORE_API_19070409_R1</Build>
<BidArray>
<Offer>
<Action>Bid</Action>
<Currency>USD</Currency>
<MaxBid currencyID="USD">4.5</MaxBid>
<Quantity>1</Quantity>
<SecondChanceEnabled>true</SecondChanceEnabled>
<SiteCurrency>USD</SiteCurrency>
<TimeBid>2019-10-26T23:53:20.000Z</TimeBid>
<HighestBid currencyID="USD">4.5</HighestBid>
<ConvertedPrice currencyID="USD">4.5</ConvertedPrice>
<User>
<AboutMePage>false</AboutMePage>
<Email>Invalid Request</Email>
<FeedbackScore>750</FeedbackScore>
<PositiveFeedbackPercent>0.0</PositiveFeedbackPercent>
<FeedbackPrivate>false</FeedbackPrivate>
<FeedbackRatingStar>Purple</FeedbackRatingStar>
<IDVerified>true</IDVerified>
<eBayGoodStanding>true</eBayGoodStanding>
<NewUser>false</NewUser>
<RegistrationDate>2007-10-21T00:00:00.000Z</RegistrationDate>
<Site>US</Site>
<Status>Confirmed</Status>
<UserID>b********r</UserID>
<UserIDChanged>false</UserIDChanged>
<UserIDLastChanged>2009-10-21T18:58:21.000Z</UserIDLastChanged>
<VATStatus>NoVATTax</VATStatus>
<BuyerInfo>
<ShippingAddress>
<Country>US</Country>
<PostalCode>98102</PostalCode>
</ShippingAddress>
</BuyerInfo>
<UserAnonymized>false</UserAnonymized>
</User>
</Offer>
<Offer>
<Action>Bid</Action>
<Currency>USD</Currency>
<MaxBid currencyID="USD">4.0</MaxBid>
<Quantity>1</Quantity>
<SecondChanceEnabled>true</SecondChanceEnabled>
<SiteCurrency>USD</SiteCurrency>
<TimeBid>2019-10-26T23:51:43.000Z</TimeBid>
<HighestBid currencyID="USD">4.0</HighestBid>
<ConvertedPrice currencyID="USD">4.0</ConvertedPrice>
<User>
<AboutMePage>false</AboutMePage>
<Email>Invalid Request</Email>
<FeedbackScore>800</FeedbackScore>
<PositiveFeedbackPercent>0.0</PositiveFeedbackPercent>
<FeedbackPrivate>false</FeedbackPrivate>
<FeedbackRatingStar>Purple</FeedbackRatingStar>
<IDVerified>true</IDVerified>
<eBayGoodStanding>true</eBayGoodStanding>
<NewUser>false</NewUser>
<RegistrationDate>2005-01-01T00:00:00.000Z</RegistrationDate>
<Site>US</Site>
<Status>Confirmed</Status>
<UserID>b********r</UserID>
<UserIDChanged>false</UserIDChanged>
<UserIDLastChanged>2009-10-21T20:22:51.000Z</UserIDLastChanged>
<VATStatus>NoVATTax</VATStatus>
<BuyerInfo>
<ShippingAddress>
<Country>US</Country>
<PostalCode>98102</PostalCode>
</ShippingAddress>
</BuyerInfo>
<UserAnonymized>false</UserAnonymized>
</User>
</Offer>
</BidArray>
<HighBidder>b*******r</HighBidder>
<HighestBid currencyID="USD">4.5</HighestBid>
<ListingStatus>Completed</ListingStatus>
</GetAllBiddersResponse>
Retrieves a bidding summary.
Description
Set IncludeBiddingSummary to true
to return a complete bidding summary on the associated item.
Input
XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetAllBiddersRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<ItemID>1**********2</ItemID>
<IncludeBiddingSummary>true</IncludeBiddingSummary>
</GetAllBiddersRequest>
Output
XML format.
<GetAllBiddersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-04T17:53:55.018Z</Timestamp>
<Ack>Success</Ack>
<Version>1125</Version>
<Build>E1125_CORE_API_19070409_R1</Build>
<BidArray>
<Offer>
<Action>Bid</Action>
<Currency>USD</Currency>
<MaxBid currencyID="USD">4.5</MaxBid>
<Quantity>1</Quantity>
<SecondChanceEnabled>true</SecondChanceEnabled>
<SiteCurrency>USD</SiteCurrency>
<TimeBid>2019-10-27T23:53:20.000Z</TimeBid>
<HighestBid currencyID="USD">4.5</HighestBid>
<ConvertedPrice currencyID="USD">4.5</ConvertedPrice>
<User>
<AboutMePage>false</AboutMePage>
<Email>Invalid Request</Email>
<FeedbackScore>750</FeedbackScore>
<PositiveFeedbackPercent>0.0</PositiveFeedbackPercent>
<FeedbackPrivate>false</FeedbackPrivate>
<FeedbackRatingStar>Purple</FeedbackRatingStar>
<IDVerified>true</IDVerified>
<eBayGoodStanding>true</eBayGoodStanding>
<NewUser>false</NewUser>
<RegistrationDate>2007-10-21T00:00:00.000Z</RegistrationDate>
<Site>US</Site>
<Status>Confirmed</Status>
<UserID>b********r</UserID>
<UserIDChanged>false</UserIDChanged>
<UserIDLastChanged>2009-10-21T18:58:21.000Z</UserIDLastChanged>
<VATStatus>NoVATTax</VATStatus>
<BuyerInfo>
<ShippingAddress>
<Country>CustomCode</Country>
<PostalCode>98102</PostalCode>
</ShippingAddress>
</BuyerInfo>
<BiddingSummary>
<SummaryDays>30</SummaryDays>
<TotalBids>11</TotalBids>
<BidActivityWithSeller>100</BidActivityWithSeller>
<BidsToUniqueSellers>1</BidsToUniqueSellers>
<BidsToUniqueCategories>2</BidsToUniqueCategories>
<BidRetractions>0</BidRetractions>
<ItemBidDetails>
<ItemID>1**********1</ItemID>
<CategoryID>377</CategoryID>
<BidCount>2</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-26T16:53:20.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>1**********2</ItemID>
<CategoryID>377</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-27T11:55:02.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>1**********3</ItemID>
<CategoryID>1463</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-28T17:14:37.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>1**********4</ItemID>
<CategoryID>1463</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-26T07:08:28.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>1**********5</ItemID>
<CategoryID>1463</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-27T07:07:41.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>1**********6</ItemID>
<CategoryID>1463</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-26T07:05:08.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>1**********7</ItemID>
<CategoryID>1463</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-26T17:50:37.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>1**********8</ItemID>
<CategoryID>1463</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-26T17:49:32.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>1**********9</ItemID>
<CategoryID>1463</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-26T17:48:42.000Z</LastBidTime>
</ItemBidDetails>
<ItemBidDetails>
<ItemID>2**********0</ItemID>
<CategoryID>1463</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-26T17:42:21.000Z</LastBidTime>
</ItemBidDetails>
</BiddingSummary>
<UserAnonymized>false</UserAnonymized>
</User>
<BidCount>2</BidCount>
</Offer>
<Offer>
<Action>Bid</Action>
<Currency>USD</Currency>
<MaxBid currencyID="USD">4.0</MaxBid>
<Quantity>1</Quantity>
<SecondChanceEnabled>true</SecondChanceEnabled>
<SiteCurrency>USD</SiteCurrency>
<TimeBid>2019-10-26T23:51:43.000Z</TimeBid>
<HighestBid currencyID="USD">4.0</HighestBid>
<ConvertedPrice currencyID="USD">4.0</ConvertedPrice>
<User>
<AboutMePage>false</AboutMePage>
<Email>Invalid Request</Email>
<FeedbackScore>800</FeedbackScore>
<PositiveFeedbackPercent>0.0</PositiveFeedbackPercent>
<FeedbackPrivate>false</FeedbackPrivate>
<FeedbackRatingStar>Purple</FeedbackRatingStar>
<IDVerified>true</IDVerified>
<eBayGoodStanding>true</eBayGoodStanding>
<NewUser>false</NewUser>
<RegistrationDate>2005-01-01T00:00:00.000Z</RegistrationDate>
<Site>US</Site>
<Status>Confirmed</Status>
<UserID>b********r</UserID>
<UserIDChanged>false</UserIDChanged>
<UserIDLastChanged>2009-10-21T20:22:51.000Z</UserIDLastChanged>
<VATStatus>NoVATTax</VATStatus>
<BuyerInfo>
<ShippingAddress>
<Country>CustomCode</Country>
<PostalCode>98102</PostalCode>
</ShippingAddress>
</BuyerInfo>
<BiddingSummary>
<SummaryDays>30</SummaryDays>
<TotalBids>1</TotalBids>
<BidActivityWithSeller>100</BidActivityWithSeller>
<BidsToUniqueSellers>1</BidsToUniqueSellers>
<BidsToUniqueCategories>1</BidsToUniqueCategories>
<BidRetractions>0</BidRetractions>
<ItemBidDetails>
<ItemID>1**********1</ItemID>
<CategoryID>377</CategoryID>
<BidCount>1</BidCount>
<SellerID>S********1</SellerID>
<LastBidTime>2019-10-26T16:51:43.000Z</LastBidTime>
</ItemBidDetails>
</BiddingSummary>
<UserAnonymized>false</UserAnonymized>
</User>
<BidCount>1</BidCount>
</Offer>
</BidArray>
<HighBidder>b*******r</HighBidder>
<HighestBid currencyID="USD">4.5</HighestBid>
<ListingStatus>Completed</ListingStatus>
</GetAllBiddersResponse>
Input Output Detail Controls Samples |
Change History
Change Date | Description |
---|---|
1323 2023-08-25 |
|
1027 2017-08-04 |
|
0897 2014-10-21 |
|
0637 2009-09-30 |
|
0573 2008-07-09 |
|
0555 2008-03-05 |
|
0535 2007-10-17 |
|
0491 2006-12-13 |
|
0485 2006-11-01 |
|
0427 2005-09-21 |
|