GetAllBidders - Call Reference - eBay Trading Web Services

GetAllBidders

Provides three modes for retrieving a list of the users that bid on a listing. One of the modes is of particular value in support of the Second Chance Offer feature. Includes the list of bidders for the requested item as part of the general item listing data.

See:
Extending a Second Chance Offer for detailed information on working with the result set
Making Second Chance Offers for Items

GetAllBidders Input

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

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific 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. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 (repeatable)	Optional	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. 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: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
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 in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
CallMode	GetAllBiddersModeCodeType	Required	Specifies which bidder information to return. Applicable values: • CustomCode (in) Reserved for internal or future use. • EndedListing (in) Returns all non-winning bidders for ended listings only. It may be used only by a seller. • SecondChanceEligibleEndedListing (in) Returns all non-winning bidders for an ended listing who have not yet received a Second Chance Offer and noted interest in receiving a Second Chance Offer. It may be used only by a seller. • ViewAll (in) Returns all bidders for an ended or still-active listing. It may be used by any user.
IncludeBiddingSummary	boolean	Conditional	Specifies whether return BiddingSummary container for each offer.
ItemID	ItemIDType (string)	Required	The item ID for which to retrieve the list of bidders. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

See also Samples.

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

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetAllBiddersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- 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>
      <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 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 here ... -->
  </BidArray>
  <HighBidder> UserIDType (string) </HighBidder>
  <HighestBid currencyID="CurrencyCodeType"> AmountType (double) </HighestBid>
  <ListingStatus> ListingStatusCodeType </ListingStatus>
</GetAllBiddersResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific 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 Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
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	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
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.
Errors.ErrorParameters	ErrorParameterType (repeatable)	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 [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
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: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
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 Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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 "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
BidArray	OfferArrayType	Always	Contains a list of OfferType objects. Each OfferType object represents the data for one bidder and bid.
BidArray.Offer	OfferType (repeatable)	Conditionally	Contains the data for one offer. This includes: data for the user making the offer, the amount of the offer, the quantity of items being bought from the listing, the type of offer being made, and more.
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 counter-offer, etc.), then after the PlaceOffer call, the buyer can get the status of the best offer (and of a possible seller-counter-offer, etc.) using the GetBestOffers call. See the Trading Web Services Guide for information about best-offer enabled items and about GetBestOffers. Applicable values: • Absentee (out) The offer placed was an absentee bid. (This can only be done on the eBay site, not via API.) • Accept (in/out) If an item is best-offer enabled, use this value if a buyer is accepting a counteroffer of a seller. • AutoCancel (out) The offer was automatically cancelled. (This can only be done on the eBay site, not via API.) • AutoRetraction (out) The offer was automatically retracted. (This can only be done on the eBay site, not via API.) • Bid (in/out) Bid. The offer is being or was placed on a competitive-bidding listing (a Chinese or Dutch auction). • BuyItNow (out) The offer resulted in the successful exercise of the Buy It Now option for a Chinese auction. • Cancelled (out) The offer was cancelled. (This can only be done on the eBay site, not via API.) • Counter (in/out) If an item is best-offer enabled, use this value if a buyer is making a counteroffer to a seller's counteroffer. • CustomCode (out) Reserved for future use. • Decline (in/out) If an item is best-offer enabled, use this value if a buyer is declining a counteroffer of a seller. • NotUsed (out) Not used. • Offer (in/out) If an item is best-offer enabled, use this value if a buyer is making a best offer on the item. After a buyer makes a best offer (or counter-offer, etc.), the buyer can get the status of the best offer (and of a possible seller-counter-offer, etc.) using the GetBestOffers call. See the Trading Web Services Guide for information about best-offer enabled items and about GetBestOffers. • Purchase (in/out) The offer is being or was placed on a fixed-price listing. This value is used for fixed-price listings (Basic Fixed-Price and eBay Stores Inventory listings) to purchase an item. In the case of PlaceOffer, for Chinese items with the BIN option, specify Purchase to buy an item. In the case of items listed with AutoPay, PlaceOffer can be used to bid, but not to purchase. • Retraction (out) The offer was retracted by the user who extended the offer. (This can only be done on the eBay site, not via API.) • Unknown (out) Unknown.
BidArray.Offer.ConvertedPrice	AmountType (double)	Conditionally	Localized amount for the item's current price.
BidArray.Offer.ConvertedPrice [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
BidArray.Offer.Currency	CurrencyCodeType	Always	Numeric ID for the currency for the auction. Valid values are enumerated in the CurrencyCodeType code list. Applicable values: See Currency.
BidArray.Offer.HighestBid	AmountType (double)	Always	Amount the highest bidder had bid on the item. Applicable only to competitive-bidding listings (Chinese and Dutch auctions) where there is progressive bidding and winning bidders are determined based on the highest bid.
BidArray.Offer.HighestBid [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
BidArray.Offer.MaxBid	AmountType (double)	Always	Amount of the offer placed. For competitive-bidding 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 competitive-bidding 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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
BidArray.Offer.Quantity	int	Always	Specifies the number of items from the specified listing the user tendering the offer intends to purchase, bid on, or make a best offer on. For Chinese auctions and other listing formats that only allow one item per listing, value may not exceed one. For multi-item listings, must be greater than zero and not exceeding the number of items offered 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.
BidArray.Offer.TimeBid	dateTime	Always	Date and time the offer or bid was placed.
BidArray.Offer.User	UserType	Always	Bidder information. See the schema documentation for UserType for details on its properties and their meanings.
BidArray.Offer.User .AboutMePage	boolean	Always	If true, indicates that the user has set up an About Me page.
BidArray.Offer.User .BiddingSummary	BiddingSummaryType	Conditionally	Contains information about the user as a bidder on a certain item. Returned for GetAllBidders if IncludeBiddingSummary = true is included in the request.
BidArray.Offer.User .BiddingSummary .BidActivityWithSeller	int	Conditionally	Percentage of the bidder's total bids that the bidder placed on items that the seller is offering.
BidArray.Offer.User .BiddingSummary.BidRetractions	int	Conditionally	The total number of bids that the bidder has retracted.
BidArray.Offer.User .BiddingSummary .BidsToUniqueCategories	int	Conditionally	For items that the bidder has bid on, the number of unique categories that they belong to.
BidArray.Offer.User .BiddingSummary .BidsToUniqueSellers	int	Conditionally	Number of unique sellers whose items the bidder has placed bids on.
BidArray.Offer.User .BiddingSummary.ItemBidDetails	ItemBidDetailsType (repeatable)	Conditionally	Detail bidding information on the items that the bidder has bid on.
BidArray.Offer.User .BiddingSummary.ItemBidDetails .BidCount	int	Conditionally	The total number of bids the user placed on the item.
BidArray.Offer.User .BiddingSummary.ItemBidDetails .CategoryID	string	Conditionally	Numeric ID for the category that the item belongs to.
BidArray.Offer.User .BiddingSummary.ItemBidDetails .ItemID	ItemIDType (string)	Conditionally	The unique identifier of an item listed on the eBay site. For GetAllBidders, an anonymous user ID is returned. Since a bidder's user info 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, "IA". 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 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 UserID. See Working with Anonymous User Information in the eBay Web Services Guide for more information. See Working with Anonymous User Information.
BidArray.Offer.User .BiddingSummary.ItemBidDetails .LastBidTime	dateTime	Conditionally	The time at which the user placed the last bid on the item.
BidArray.Offer.User .BiddingSummary.ItemBidDetails .SellerID	UserIDType (string)	Conditionally	The eBay ID of the seller who listed the item. Starting Jan 2007, when a bidder's user info is made anonymous, this tag 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. See Working with Anonymous User Information.
BidArray.Offer.User .BiddingSummary.SummaryDays	int	Conditionally	The number of days included in the summary. Currently always set to 30 days.
BidArray.Offer.User .BiddingSummary.TotalBids	int	Conditionally	The total number of bids that the bidder has placed.
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. See Working with Anonymous User Information.
BidArray.Offer.User.BuyerInfo .ShippingAddress	AddressType	Always	Contains the address of the buyer in the transaction, to which the seller would ship the item(s). See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.
BidArray.Offer.User.BuyerInfo .ShippingAddress.Country	CountryCodeType	Always	The country code of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Applicable values: See Country.
BidArray.Offer.User.BuyerInfo .ShippingAddress.PostalCode	string	Always	User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Max length: 12.
BidArray.Offer.User .eBayGoodStanding	boolean	Always	If true, indicates that the user is in good standing with eBay.
BidArray.Offer.User.Email	string	Conditionally	Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. 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. See Working with Anonymous User Information.
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). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. To be eligible to list on Express, a seller's feedback needs to be public. See "eBay Express" in the eBay Web Services guide. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. 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. See Working with Anonymous User Information.
BidArray.Offer.User .FeedbackRatingStar	FeedbackRatingStarCodeType	Always	Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values. Applicable values: • Blue (out) Blue Star, feedback score 50-99. • CustomCode (out) Reserved for internal or future use. • Green (out) Green Star, feedback score 5,000-9,999. • None (out) No graphic displayed, feedback score 0-9. • Purple (out) Purple Star, feedback score 500-999. • PurpleShooting (out) Purple Shooting Star, feedback score 50,000-99,999. • Red (out) Red Star, feedback score 1,000-4,999 • RedShooting (out) Red Shooting Star, feedback score 100,000 and above. • Turquoise (out) Turquoise Star, feedback score 100-499. • TurquoiseShooting (out) Turquoise Shooting Star, feedback score 25,000-49,999. • Yellow (out) Yellow Star, feedback score 10-49. • YellowShooting (out) Yellow Shooting Star, feedback score 10,000-24,999.
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 transactions. Each transaction 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. To be eligible to list on Express, a seller's feedback score needs to be 100 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. 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. See Working with Anonymous User Information.
BidArray.Offer.User.IDVerified	boolean	Always	Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html
BidArray.Offer.User.NewUser	boolean	Always	If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).
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. To be eligible to list on Express, a seller's feedback percent needs to be 98 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request.
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. See Working with Anonymous User Information.
BidArray.Offer.User.Site	SiteCodeType	Always	eBay site the user is registered with. To be eligible to list on Express US, a seller must be registered on the eBay US or Canada site. To be eligible to list on Express Germany, a seller must registered on the eBay Germany site. See "eBay Express" in the eBay Web Services guide. Note: At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information. 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. See Working with Anonymous User Information.
BidArray.Offer.User.Status	UserStatusCodeType	Always	Indicates the user's registration/user status. To be eligible to list on Express, a seller's status must be Confirmed. See "eBay Express" in the eBay Web Services guide. Applicable values: • AccountOnHold (out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items • Confirmed (out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category • CreditCardVerify (out) User has completed registration and confirmation, but is pending a verification of credit card information • CreditCardVerifyHalfOptIn (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the verification of credit card information is still pending • CustomCode (out) Reserved for internal or future use • Deleted (out) Records for the specified user have been deleted • Ghost (out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay • Guest (out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow. • InMaintenance (out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status • Merged (out) User record has been merged with another account record for the same user • RegistrationCodeMailOut (out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email • Suspended (out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement • TermPending (out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user • Unconfirmed (out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email • UnconfirmedExpress Deprecated as of version 579. (out) Half.com User; user has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending Deprecation version: 579. See also Deprecated Objects. • UnconfirmedHalfOptIn (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending • Unknown (out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem (Not all values in UserStatusCodeType apply to this field.)
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. See Working with Anonymous User Information.
BidArray.Offer.User.UserID	UserIDType (string)	Conditionally	Unique eBay user ID for the user. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. Since a bidder's user info 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, "IA". 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 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". (GetSearchResults only)When IncludeFeedback is set to true in GetSearchResults request, the call response returns the seller's User ID. Please note seller's UserID is not anonymized. See Working with Anonymous User Information.
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. See Working with Anonymous User Information.
BidArray.Offer.User .UserIDLastChanged	dateTime	Always	Date and time the user's data was last changed (in GMT). 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. See Working with Anonymous User Information.
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: • CustomCode (out) Reserved for internal or future use • NoVATTax (out) VAT is not applicable • VATExempt (out) Residence in a country with VAT and user is registered as VAT-exempt • VATTax (out) Residence in a country with VAT and user is not registered as VAT-exempt See VAT-exempt Sellers.
HighBidder	UserIDType (string)	Always	eBay user ID for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance offer candidate.
HighestBid	AmountType (double)	Always	Bid amount offered by the HighBidder.
HighestBid [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ListingStatus	ListingStatusCodeType	Always	Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., winning bidder) and other information. This processing can take several minutes. If you retrieve a sold item, use this listing status information to determine whether eBay has finished processing the listing so that you can be sure the winning bidder and other details are correct and complete. Applicable values: • Active (out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing. • Completed (out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned by GetSellerTransactions and GetItemTransactions on a transaction by transaction basis, all other listing types, including Chinese and Dutch (no Buy It Now purchases), require the listing status to be Completed before the Final Value Fee is returned. • Custom (out) Reserved for internal or future use. • CustomCode (out) Reserved for internal or future use. • Ended (out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available.

GetAllBidders Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

GetAllBidders Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetAllBidders.

GetAllBidders Change History

Version	Description
573 2008-07-09	BidArray.Offer.User.Email (modified): Starting in September 2008, email tag in the User container will be made anonymous.
555 2008-03-05	GetAllBiddersResponseType, UserType (modified): Some bidder information is anonymous, to protect bidders from fraud. If the seller makes this API call, the actual ids of all bidders on the seller's item will be returned. If a bidder makes this API call, the bidder's actual id will be returned. Information for all competing bidders or outside watchers will be returned as anonymized userIDs. See Working with Anonymous User Informationin the eBay Web Services Guide for more information.
535 2007-10-17	Item.Seller.PositiveFeedbackPercent (added): Added to the response as an enhancement for the Countdown application.
491 2006-12-13	UserType (modified): Starting Jan 2007, selected tags in the User container will be made anonymous for listings that have a current price of $200.00 USD or higher. See Working with Anonymous User Information for a list of effected fields.
485 2006-11-01	GetAllBidders.IncludeBiddingSummary (added): Indicates whether or not to include the BiddingSummary node in the response.
427 2005-09-21	ListingStatus (added): Specifies an active or ended listing's status in eBay's processing workflow. For items that have sold, this to determine whether eBay has finished processing total price, winning bidder/buyer, and Final Value Fee details.

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 585

eBay Trading API
Call Reference Version 585