GetBidderList

Retrieves all items the user is currently bidding on, or has won or purchased. You can control the result set with elements such as ActiveItemsOnly, which limits the result set to active items. Note that since bidder information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers who know the user IDs of their bidders will be able to make this API call successfully. See Working with Anonymous User Information in the eBay Web Services Guide for more information.

See:
    Introduction to Pictures in Item Listings
    GetBidderList

Related calls:



Back to top

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

See also Samples.

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 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"?>
<GetBidderListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <ActiveItemsOnly> boolean </ActiveItemsOnly>
  <EndTimeFrom> dateTime </EndTimeFrom>
  <EndTimeTo> dateTime </EndTimeTo>
  <GranularityLevel> GranularityLevelCodeType </GranularityLevel>
  <UserID> UserIDType (string) </UserID>
</GetBidderListRequest>
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
ActiveItemsOnly boolean Optional Indicates whether to limit the result set to active items. If true, only active items are returned and the EndTimeFrom and EndTimeTo filters are ignored. If false (or not sent), active and ended items are returned.
EndTimeFrom dateTime Conditional Limits returned items to only those for which the item's end date is on or after the date-time specified. Specify an end date within 30 days prior to today. Items that ended more than 30 days ago are omitted from the results. If specified, EndTimeTo must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. (For information on how to convert between your local time zone and GMT, see Time Values Note.) This field is ignored if ActiveItemsOnly is true.
EndTimeTo dateTime Conditional Limits returned items to only those for which the item's end date is on or before the date-time specified. If specified, EndTimeFrom must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. This field is ignored if ActiveItemsOnly is true.
GranularityLevel GranularityLevelCodeType Optional For GetBidderList, you can reduce the ItemType fields and other fields returned by specifying one of two values in the GranularityLevel field, Coarse or Medium. If you specify Coarse, the primary fields returned are the following: Item.ItemID and Item.ListingDetails.EndTime. If you specify Medium, an abbreviated result set is returned that includes many more fields than in the case of Coarse, including the following: Item.BuyItNowPrice, Item.Currency, Item.Site, and Item.Title.

Applicable values:

•   Coarse

(in) For each record in the response, retrieves less data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified.

•   CustomCode

(in)

•   Fine

(in) For each record in the response, retrieves more data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified.

•   Medium

(in) For each record in the response, retrieves more data than Coarse and less data than Fine. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified.


UserID UserIDType (string) Optional The user for whom information should be returned. If provided, overrides user defined via RequesterCredentials in header.



Back to top

GetBidderList Output

The box below lists all fields that might be returned in the call 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 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"?>
<GetBidderListResponse 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 -->
  <Bidder> UserType 
    <AboutMePage> boolean </AboutMePage>
    <BuyerInfo> BuyerType 
      <ShippingAddress> AddressType 
        <CityName> string </CityName>
        <CompanyName> string </CompanyName>
        <Country> CountryCodeType </Country>
        <CountryName> string </CountryName>
        <InternationalName> string </InternationalName>
        <InternationalStateAndCity> string </InternationalStateAndCity>
        <InternationalStreet> string </InternationalStreet>
        <Phone> string </Phone>
        <PostalCode> string </PostalCode>
        <StateOrProvince> string </StateOrProvince>
        <Street> string </Street>
        <Street1> string </Street1>
        <Street2> string </Street2>
      </ShippingAddress>
    </BuyerInfo>
    <eBayGoodStanding> boolean </eBayGoodStanding>
    <Email> string </Email>
    <FeedbackPrivate> boolean </FeedbackPrivate>
    <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
    <FeedbackScore> int </FeedbackScore>
    <IDVerified> boolean </IDVerified>
    <NewUser> boolean </NewUser>
    <RegistrationDate> dateTime </RegistrationDate>
    <Site> SiteCodeType </Site>
    <Status> UserStatusCodeType </Status>
    <UserID> UserIDType (string) </UserID>
    <UserIDChanged> boolean </UserIDChanged>
    <UserIDLastChanged> dateTime </UserIDLastChanged>
    <VATStatus> VATStatusCodeType </VATStatus>
  </Bidder>
  <BidItemArray> ItemArrayType 
    <Item> ItemType 
      <ApplicationData> string </ApplicationData>
      <ApplyShippingDiscount> boolean </ApplyShippingDiscount>
      <AutoPay> boolean </AutoPay>
      <BestOfferDetails> BestOfferDetailsType 
        <BestOfferCount> int </BestOfferCount>
        <BestOfferEnabled> boolean </BestOfferEnabled>
      </BestOfferDetails>
      <BuyerGuaranteePrice currencyID="CurrencyCodeType"> AmountType (double) </BuyerGuaranteePrice>
      <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
      <BuyerRequirementDetails> BuyerRequirementDetailsType 
        <LinkedPayPalAccount> boolean </LinkedPayPalAccount>
        <MaximumBuyerPolicyViolations> MaximumBuyerPolicyViolationsType 
          <Count> int </Count>
          <Period> PeriodCodeType </Period>
        </MaximumBuyerPolicyViolations>
        <MaximumItemRequirements> MaximumItemRequirementsType 
          <MaximumItemCount> int </MaximumItemCount>
          <MinimumFeedbackScore> int </MinimumFeedbackScore>
        </MaximumItemRequirements>
        <MaximumUnpaidItemStrikesInfo> MaximumUnpaidItemStrikesInfoType 
          <Count> int </Count>
          <Period> PeriodCodeType </Period>
        </MaximumUnpaidItemStrikesInfo>
        <MinimumFeedbackScore> int </MinimumFeedbackScore>
        <ShipToRegistrationCountry> boolean </ShipToRegistrationCountry>
        <VerifiedUserRequirements> VerifiedUserRequirementsType 
          <MinimumFeedbackScore> int </MinimumFeedbackScore>
          <VerifiedUser> boolean </VerifiedUser>
        </VerifiedUserRequirements>
        <ZeroFeedbackScore> boolean </ZeroFeedbackScore>
      </BuyerRequirementDetails>
      <BuyerResponsibleForShipping> boolean </BuyerResponsibleForShipping>
      <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
      <Charity> CharityType 
        <CharityID> string </CharityID>
        <CharityName> string </CharityName>
        <CharityNumber> int </CharityNumber>
        <DonationPercent> float </DonationPercent>
        <LogoURL> string </LogoURL>
        <Mission> string </Mission>
        <Status> CharityStatusCodeType </Status>
      </Charity>
      <Country> CountryCodeType </Country>
      <Currency> CurrencyCodeType </Currency>
      <DisableBuyerRequirements> boolean </DisableBuyerRequirements>
      <DispatchTimeMax> int </DispatchTimeMax>
      <FreeAddedCategory> CategoryType 
        <CategoryID> string </CategoryID>
        <CategoryName> string </CategoryName>
      </FreeAddedCategory>
      <GetItFast> boolean </GetItFast>
      <GiftIcon> int </GiftIcon>
      <GiftServices> GiftServicesCodeType </GiftServices>
      <!-- ... more GiftServices nodes here ... -->
      <HitCount> long </HitCount>
      <HitCounter> HitCounterCodeType </HitCounter>
      <ItemID> ItemIDType (string) </ItemID>
      <ListingDesigner> ListingDesignerType 
        <LayoutID> int </LayoutID>
        <OptimalPictureSize> boolean </OptimalPictureSize>
        <ThemeID> int </ThemeID>
      </ListingDesigner>
      <ListingDetails> ListingDetailsType 
        <Adult> boolean </Adult>
        <BindingAuction> boolean </BindingAuction>
        <BuyItNowAvailable> boolean </BuyItNowAvailable>
        <CheckoutEnabled> boolean </CheckoutEnabled>
        <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
        <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
        <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
        <EndTime> dateTime </EndTime>
        <HasPublicMessages> boolean </HasPublicMessages>
        <HasReservePrice> boolean </HasReservePrice>
        <HasUnansweredQuestions> boolean </HasUnansweredQuestions>
        <RelistedItemID> ItemIDType (string) </RelistedItemID>
        <SecondChanceOriginalItemID> ItemIDType (string) </SecondChanceOriginalItemID>
        <StartTime> dateTime </StartTime>
        <TCROriginalItemID> ItemIDType (string) </TCROriginalItemID>
        <ViewItemURL> anyURI </ViewItemURL>
        <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
      </ListingDetails>
      <ListingDuration> token </ListingDuration>
      <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
      <!-- ... more ListingEnhancement nodes here ... -->
      <ListingType> ListingTypeCodeType </ListingType>
      <Location> string </Location>
      <LocationDefaulted> boolean </LocationDefaulted>
      <LotSize> int </LotSize>
      <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
      <NowAndNew> boolean </NowAndNew>
      <PaymentDetails> PaymentDetailsType 
        <DaysToFullPayment> int </DaysToFullPayment>
        <HoursToDeposit> int </HoursToDeposit>
      </PaymentDetails>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods nodes here ... -->
      <PayPalEmailAddress> string </PayPalEmailAddress>
      <PictureDetails> PictureDetailsType 
        <GalleryType> GalleryTypeCodeType </GalleryType>
        <GalleryURL> anyURI </GalleryURL>
        <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
        <PictureURL> anyURI </PictureURL>
        <!-- ... more PictureURL nodes here ... -->
      </PictureDetails>
      <PostalCode> string </PostalCode>
      <PrimaryCategory> CategoryType 
        <CategoryID> string </CategoryID>
        <CategoryName> string </CategoryName>
      </PrimaryCategory>
      <PrivateListing> boolean </PrivateListing>
      <ProductListingDetails> ProductListingDetailsType 
        <Copyright> string </Copyright>
        <!-- ... more Copyright nodes here ... -->
        <IncludePrefilledItemInformation> boolean </IncludePrefilledItemInformation>
        <IncludeStockPhotoURL> boolean </IncludeStockPhotoURL>
        <ProductID> string </ProductID>
        <StockPhotoURL> anyURI </StockPhotoURL>
        <UseStockPhotoURLAsGallery> boolean </UseStockPhotoURLAsGallery>
      </ProductListingDetails>
      <Quantity> int </Quantity>
      <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
      <ReviseStatus> ReviseStatusType 
        <BuyItNowAdded> boolean </BuyItNowAdded>
        <BuyItNowLowered> boolean </BuyItNowLowered>
        <ItemRevised> boolean </ItemRevised>
        <ReserveLowered> boolean </ReserveLowered>
        <ReserveRemoved> boolean </ReserveRemoved>
      </ReviseStatus>
      <SecondaryCategory> CategoryType 
        <CategoryID> string </CategoryID>
        <CategoryName> string </CategoryName>
      </SecondaryCategory>
      <Seller> UserType 
        <AboutMePage> boolean </AboutMePage>
        <eBayGoodStanding> boolean </eBayGoodStanding>
        <Email> string </Email>
        <FeedbackPrivate> boolean </FeedbackPrivate>
        <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
        <FeedbackScore> int </FeedbackScore>
        <IDVerified> boolean </IDVerified>
        <NewUser> boolean </NewUser>
        <RegistrationDate> dateTime </RegistrationDate>
        <SellerInfo> SellerType 
          <AllowPaymentEdit> boolean </AllowPaymentEdit>
          <CheckoutEnabled> boolean </CheckoutEnabled>
          <CIPBankAccountStored> boolean </CIPBankAccountStored>
          <GoodStanding> boolean </GoodStanding>
          <LiveAuctionAuthorized> boolean </LiveAuctionAuthorized>
          <MerchandizingPref> MerchandizingPrefCodeType </MerchandizingPref>
          <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
          <SafePaymentExempt> boolean </SafePaymentExempt>
          <SellerLevel> SellerLevelCodeType </SellerLevel>
          <StoreOwner> boolean </StoreOwner>
        </SellerInfo>
        <Site> SiteCodeType </Site>
        <Status> UserStatusCodeType </Status>
        <UserID> UserIDType (string) </UserID>
        <UserIDChanged> boolean </UserIDChanged>
        <UserIDLastChanged> dateTime </UserIDLastChanged>
        <VATStatus> VATStatusCodeType </VATStatus>
      </Seller>
      <SellerVacationNote> string </SellerVacationNote>
      <SellingStatus> SellingStatusType 
        <BidCount> int </BidCount>
        <BidIncrement currencyID="CurrencyCodeType"> AmountType (double) </BidIncrement>
        <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
        <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
        <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee>
        <LeadCount> int </LeadCount>
        <ListingStatus> ListingStatusCodeType </ListingStatus>
        <MinimumToBid currencyID="CurrencyCodeType"> AmountType (double) </MinimumToBid>
        <PromotionalSaleDetails> PromotionalSaleDetailsType 
          <EndTime> dateTime </EndTime>
          <OriginalPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalPrice>
          <StartTime> dateTime </StartTime>
        </PromotionalSaleDetails>
        <QuantitySold> int </QuantitySold>
        <ReserveMet> boolean </ReserveMet>
        <SecondChanceEligible> boolean </SecondChanceEligible>
      </SellingStatus>
      <ShippingDetails> ShippingDetailsType 
        <AllowPaymentEdit> boolean </AllowPaymentEdit>
        <ApplyShippingDiscount> boolean </ApplyShippingDiscount>
        <GetItFast> boolean </GetItFast>
        <InsuranceDetails> InsuranceDetailsType 
          <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
          <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        </InsuranceDetails>
        <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        <InternationalInsuranceDetails> InsuranceDetailsType 
          <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
          <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        </InternationalInsuranceDetails>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType 
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShipToLocation> string </ShipToLocation>
          <!-- ... more ShipToLocation nodes here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes here ... -->
        <PaymentInstructions> string </PaymentInstructions>
        <SalesTax> SalesTaxType 
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <ShippingType> ShippingTypeCodeType </ShippingType>
        <TaxTable> TaxTableType 
          <TaxJurisdiction> TaxJurisdictionType 
            <JurisdictionID> string </JurisdictionID>
            <SalesTaxPercent> float </SalesTaxPercent>
            <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
          </TaxJurisdiction>
          <!-- ... more TaxJurisdiction nodes here ... -->
        </TaxTable>
        <ThirdPartyCheckout> boolean </ThirdPartyCheckout>
      </ShippingDetails>
      <ShippingTermsInDescription> boolean </ShippingTermsInDescription>
      <ShipToLocations> string </ShipToLocations>
      <!-- ... more ShipToLocations nodes here ... -->
      <Site> SiteCodeType </Site>
      <SKU> SKUType (string) </SKU>
      <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
      <Storefront> StorefrontType 
        <StoreCategory2ID> long </StoreCategory2ID>
        <StoreCategoryID> long </StoreCategoryID>
        <StoreURL> anyURI </StoreURL>
      </Storefront>
      <SubTitle> string </SubTitle>
      <ThirdPartyCheckoutIntegration> boolean </ThirdPartyCheckoutIntegration>
      <TimeLeft> duration </TimeLeft>
      <Title> string </Title>
      <UUID> UUIDType (string) </UUID>
      <VATDetails> VATDetailsType 
        <RestrictedToBusiness> boolean </RestrictedToBusiness>
        <VATPercent> float </VATPercent>
      </VATDetails>
    </Item>
    <!-- ... more Item nodes here ... -->
  </BidItemArray>
</GetBidderListResponse>
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
Bidder UserType Always Data for one eBay bidder.
Bidder.AboutMePage boolean Always If true, indicates that the user has set up an About Me page.
Bidder.BuyerInfo BuyerType Conditionally 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.
Bidder.BuyerInfo
  .ShippingAddress
AddressType Conditionally 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.
Bidder.BuyerInfo
  .ShippingAddress.CityName
string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: 64.
Bidder.BuyerInfo
  .ShippingAddress.CompanyName
string Conditionally User's company name. Only returned if available. Not applicable to Half.com.
Bidder.BuyerInfo
  .ShippingAddress.Country
CountryCodeType Conditionally 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.
Bidder.BuyerInfo
  .ShippingAddress.CountryName
string Conditionally The name of the user's country. Also applicable to Half.com (for GetOrders).
Bidder.BuyerInfo
  .ShippingAddress
  .InternationalName
string Conditionally Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Bidder.BuyerInfo
  .ShippingAddress
  .InternationalStateAndCity
string Conditionally International state and city for the seller's payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Bidder.BuyerInfo
  .ShippingAddress
  .InternationalStreet
string Conditionally Seller's international street address that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
Bidder.BuyerInfo
  .ShippingAddress.Phone
string Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number. Also applicable to Half.com (for GetOrders).
Bidder.BuyerInfo
  .ShippingAddress.PostalCode
string Conditionally 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.
Bidder.BuyerInfo
  .ShippingAddress
  .StateOrProvince
string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: 64.
Bidder.BuyerInfo
  .ShippingAddress.Street
string Conditionally A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com.
Bidder.BuyerInfo
  .ShippingAddress.Street1
string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: 100.
Bidder.BuyerInfo
  .ShippingAddress.Street2
string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: 100.
Bidder.eBayGoodStanding boolean Always If true, indicates that the user is in good standing with eBay.
Bidder.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.
Bidder.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 onl