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

See also the reference documentation for these calls:

GetSellerList - Returns a list of items a seller has listed for auction. Returns an array of zero, one, or multiple items. You can specify that the returned data include only items that start or end within a specified date range.

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 not returned (or soon will not be returned) or are not operational (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"?>
<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>
      <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>
      <ReturnPolicy> ReturnPolicyType 
        <Description> string </Description>
        <EAN> string </EAN>
        <Refund> string </Refund>
        <RefundOption> token </RefundOption>
        <ReturnsAccepted> string </ReturnsAccepted>
        <ReturnsAcceptedOption> token </ReturnsAcceptedOption>
        <ReturnsWithin> string </ReturnsWithin>
        <ReturnsWithinOption> token </ReturnsWithinOption>
        <ShippingCostPaidBy> string </ShippingCostPaidBy>
        <ShippingCostPaidByOption> token </ShippingCostPaidByOption>
        <WarrantyDuration> string </WarrantyDuration>
        <WarrantyDurationOption> token </WarrantyDurationOption>
        <WarrantyOffered> string </WarrantyOffered>
        <WarrantyOfferedOption> token </WarrantyOfferedOption>
        <WarrantyType> string </WarrantyType>
        <WarrantyTypeOption> token </WarrantyTypeOption>
      </ReturnPolicy>
      <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>
          <MerchandizingPref> MerchandizingPrefCodeType </MerchandizingPref>
          <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
          <SafePaymentExempt> boolean </SafePaymentExempt>
          <SellerLevel> SellerLevelCodeType </SellerLevel>
          <StoreOwner> boolean </StoreOwner>
          <TopRatedSeller> boolean </TopRatedSeller>
        </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>
        <SellerExcludeShipToLocationsPreference> boolean </SellerExcludeShipToLocationsPreference>
        <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	Occurrence	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	Conditionally, repeatable: [0..*]	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. See the "Errors by Number" document.
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	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. 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.
Bidder.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. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,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-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,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.
Bidder.FeedbackScore	int	Always	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. 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.
Bidder.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
Bidder.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).
Bidder.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.
Bidder.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. See Working with Anonymous User Information.
Bidder.Status	UserStatusCodeType	Always	Indicates the user's registration/user status. 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.)
Bidder.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 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. For 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". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized. For PlaceOffer, see also SellingStatus.HighBidder. See Working with Anonymous User Information.
Bidder.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.
Bidder.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.
Bidder.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.
BidItemArray	ItemArrayType	Always	Array of items the bidder has bid on, has won or has lost.
BidItemArray.Item	ItemType	Always, repeatable: [1..*]	Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response.
BidItemArray.Item .ApplicationData	string	Conditionally	Returns custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField. Not applicable to Half.com, use SellerInventoryID instead. Max length: 32.
BidItemArray.Item .ApplyShippingDiscount	boolean	Conditionally	Multiple Item Shipping Discount. Seller specifies as input when listing, re-listing, or revising an item to indicate whether a shipping discount is to be applied when the buyer pays for the item in the checkout process and the item's transaction is combined with other transactions into an order. Returned with retrieved item data, indicating a shipping discount is applicable. Not returned by GetItem (see Item.ShippingDetails.ShippingDiscount instead). ApplyShippingDiscount can only be used if the user has not set up a shipping discount profile. Not applicable to Half.com.
BidItemArray.Item.AutoPay	boolean	Always	If true, the seller requests immediate payment for the item. If false or not specified, immediate payment is not requested. (In responses, does not indicate whether the item is actually still a candidate for purchase via immediate payment.) Only applicable to items listed on PayPal-enabled sites in categories that support immediate payment (see AutoPayEnabled in GetCategories), when seller has a Premier or Business PayPal account (see PayPalAccountType in Getuser). If true, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods). See the eBay Web Services guide section on Immediate Payment for additional requirements and dependencies. Also see the section on working with the eBay Motors site for additional rules. To create an Immediate Payment listing ThirdPartyCheckout must be true, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and PaymentMethods must be PayPal. For a non-Immediate Payment listing, if ThirdPartyCheckout is true, AutoPay is not supported. Not applicable to Half.com. See: Requiring Immediate Payment Requiring Immediate Payment of a Vehicle Deposit
BidItemArray.Item .BestOfferDetails	BestOfferDetailsType	Conditionally	Container for BestOffer properties associated with the item. Not applicable to Half.com.
BidItemArray.Item .BestOfferDetails .BestOfferCount	int	Conditionally	The number of best offers made for this item, if any. In other words, if there are no offers made, this container will not appear in the response.
BidItemArray.Item .BestOfferDetails .BestOfferEnabled	boolean	Conditionally	Whether best offer is enabled for this item. A seller of a fixed price format item (in a category for which Best Offer is also enabled) can opt that item into the Best Offer feature. This feature enables a buyer to make a lower priced binding offer on that item. If a listing has no active best offers, you can change this value (true to false, and vice versa). If a listing does have active best offers, you cannot change the value to false.
BidItemArray.Item .BuyerGuaranteePrice	AmountType (double)	Conditionally	For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.
BidItemArray.Item .BuyerGuaranteePrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .BuyerProtection	BuyerProtectionCodeType	Always	Indicates the status of the item's eligibility for the PayPal Buyer Protection program. Not applicable to Half.com. Applicable values: • CustomCode (out) Reserved for internal or future use. • ItemEligible (out) Item is eligible per standard criteria. • ItemIneligible (out) Item is ineligible (e.g., category not applicable). • ItemMarkedEligible (out) Item marked eligible per other criteria. • ItemMarkedIneligible (out) Item marked ineligible per special criteria (e.g., seller's account closed). • NoCoverage (out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be in the following sections of the View Item page: the Buy Safely section and the Payment Details section. See Miscellaneous Item Field Differences.
BidItemArray.Item .BuyerRequirementDetails	BuyerRequirementDetailsType	Conditionally	New Container for buyer requirements. The old container, BuyerRequirements, has been deprecated. All global MyeBay Buyer Requirements are over-ridden by the contents of this container. This means that buyer requirements set in MyeBay cannot be combined with buyer requirements included in this container. When this container is present in an AddItem call, all buyer requirements for the resulting listing are set by this container. Furthermore, individual buyer requirements cannot be modified or added when including this container in a ReviseItem call. The ReviseItem call needs to provide the entire set of buyer requirements to modify or add any of the requirements. Unless otherwise specified, most buyer requirements are only returned if the caller is the seller. Not applicable to Half.com. See Selecting Buyer Requirements (eBay Web site help).
BidItemArray.Item .BuyerRequirementDetails .LinkedPayPalAccount	boolean	Conditionally	If true, only bidders with PayPal accounts may bid. This field can be returned even if the caller is not the seller. For AddItem, the seller's My eBay preference is automatically used with request version 453 and greater. For lower request versions, you must send in explicit BuyerRequirement input even if you have your "global" My eBay preferences set to require PayPal. Default: false.
BidItemArray.Item .BuyerRequirementDetails .MaximumBuyerPolicyViolations	MaximumBuyerPolicyViolationsType	Conditionally	If provided, blocks bidders who have received the maximum allowed buyer policy violation reports (in a specific time period) from bidding on this item.
BidItemArray.Item .BuyerRequirementDetails .MaximumBuyerPolicyViolations .Count	int	Conditionally	Maximum allowed buyer policy violation reports against the buyer. If the limit is reached, the buyer can not bid on this item. Used with Period. Default: 4.
BidItemArray.Item .BuyerRequirementDetails .MaximumBuyerPolicyViolations .Period	PeriodCodeType	Conditionally	If a buyer fails to follow eBay policy guidelines for an auction, they may incur a buyer violation report on their account. The Period and Count elements allow a seller to specify that only buyers with a specified number of buyer violation reports within a given period of time can bid on their item. If a buyer has more buyer violation reports than specified within these limits, the buyer can not bid on this item. The Period is the past number of days (last 60 days, last 180 days, etc.) within which the buyer violation reports are calculated. Used with Count. Default: Days_30. Applicable values: • Days_30 • Days_180 • Days_360 (Not all values in PeriodCodeType apply to this field.)
BidItemArray.Item .BuyerRequirementDetails .MaximumItemRequirements	MaximumItemRequirementsType	Conditionally	If this field is included in your call, you can limit unpaying or low feedback bidders, by setting the MaximumItemCount and MinimumFeedbackScore to define when a bidder is blocked from bidding. Ignored as input if the application uses version 451 or older.
BidItemArray.Item .BuyerRequirementDetails .MaximumItemRequirements .MaximumItemCount	int	Conditionally	If this field is present, blocking is enabled, where the value of this field represents the maximum number of this seller's items a bidder is allowed to bid on in a 10 day period before being blocked. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 25, 50, 75, 100.
BidItemArray.Item .BuyerRequirementDetails .MaximumItemRequirements .MinimumFeedbackScore	int	Conditionally	This field is ignored on input unless MaximumItemCount has been provided. If MaximumItemCount is included in the call, both MaximumItemCount and MinimumFeedbackScore are used to determine whether the bidder is blocked from bidding. A user is blocked from bidding if they have reached or exceeded the MaximumItemCount and the user's feedback score is less than or equal to the value of this field. Valid values: 0, 1, 2, 3, 4, 5.
BidItemArray.Item .BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo	MaximumUnpaidItemStrikesInfoType	Conditionally	If provided, blocks bidders who have received the maximum unpaid item strikes (in a specific time period) from bidding on this item.
BidItemArray.Item .BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo .Count	int	Conditionally	Maximum allowed unpaid item strikes against the buyer. If the limit is reached, the buyer can not bid on this item. Used with Period. Default: 2.
BidItemArray.Item .BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo .Period	PeriodCodeType	Conditionally	If a buyer fails to pay for an item, they incur an unpaid item strike on their account. The Period and Count elements allow a seller to specify that only buyers with a specified number of item strikes (or less) within a given period of time can bid on their item. If a buyer has more strikes than specified within these limits, the buyer can not bid on this item. The Period is the past number of days (last 60 days, last 180 days, etc.) within which the unpaid item buyer strikes are calculated. Used with Count. Default: Days_30. Applicable values: • Days_30 • Days_180 • Days_360 (Not all values in PeriodCodeType apply to this field.)
BidItemArray.Item .BuyerRequirementDetails .MinimumFeedbackScore	int	Conditionally	If true, blocks bidders with this feedback score or lower. Ignored as input if the application uses version 451 or older. Valid values: -3, -2, -1.
BidItemArray.Item .BuyerRequirementDetails .ShipToRegistrationCountry	boolean	Conditionally	If true, blocks bidders who are registered in countries where the seller has specified that he will not ship. Ignored as input if the application uses version 451 or older. Default: false.
BidItemArray.Item .BuyerRequirementDetails .VerifiedUserRequirements	VerifiedUserRequirementsType	Conditionally	If provided, blocks bidders who do not pass a simple check (for example, for credit card on file). Ignored as input if the application uses version 451 or older.
BidItemArray.Item .BuyerRequirementDetails .VerifiedUserRequirements .MinimumFeedbackScore	int	Conditionally	This field is ignored unless VerifiedUser is true. If this field is present, the user's feedback score is also considered: a user is blocked from bidding if the user's feedback score is less than or equal to the value of this field. Default: 5.
BidItemArray.Item .BuyerRequirementDetails .VerifiedUserRequirements .VerifiedUser	boolean	Conditionally	If true, blocks bidding by users who do not pass a simple check (for example, for credit card on file). See "Buyer Requirements - VerifiedUser" in the chapter "Field Differences for eBay Sites." Default: false.
BidItemArray.Item .BuyerRequirementDetails .ZeroFeedbackScore	boolean	Conditionally	If true, blocks bidders with a feedback score of 0 who attempt to bid on Buy It Now items worth 100 RMB or more. Ignored as input if the application uses version 451 or older. This requirement is only enabled for the CN site. Default: false.
BidItemArray.Item .BuyerResponsibleForShipping	boolean	Conditionally	Applicable for listings in vehicle categories on the US eBay Motors site and eBay Canada site. (No business effect if specified for other categories or sites, as the Web site will not display the information to buyers.) If true, the buyer is responsible for vehicle pickup or shipping. If false, specify vehicle shipping arrangements in the item description. Default is true. (The description can also include vehicle shipping arrangements when this value is true.) If the item has bids or ends within 12 hours, you cannot modify this flag. Do not specify ShippingDetails.ShippingServiceOptions for vehicle listings. If true and the listing is on the US eBay Motors site, and you want the listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA. If true and the listing is on the eBay Canada site , and you want your listing to be visible on the US eBay Motors site, set Item.ShipToLocations to US. Not applicable to Half.com.
BidItemArray.Item .BuyItNowPrice	AmountType (double)	Always	For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. See: Longer Lasting Buy It Now Revising US eBay Motors Listings
BidItemArray.Item .BuyItNowPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item.Charity	CharityType	Conditionally	Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller, if any. If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods). When you revise an item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. For an auction listing, you can revise an item to add a charity if there are more than 12 hours left for the listing (whether or not the item has bids). For a fixed-price listing, you can revise an item to add a charity if there are more than 12 hours left for the listing, and the item has not been sold. For a Store Inventory listing, you can revise an item to add a charity if the item has not been sold. You cannot revise listings to add charity for Ad Format listings. When you relist an item, use DeletedField to remove charity information. Not applicable to Half.com. See: Miscellaneous Item Field Differences Identifying Listings that Benefit Nonprofits
BidItemArray.Item.Charity .CharityID	string	Conditionally	A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items.
BidItemArray.Item.Charity .CharityName	string	Conditionally	The name of the benefiting nonprofit charity organization selected by the charity seller. Max length: 150.
BidItemArray.Item.Charity .CharityNumber	int	Conditionally	A unique identification number assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. Being superseded by CharityID. Max 10 digits.
BidItemArray.Item.Charity .DonationPercent	float	Conditionally	The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items.
BidItemArray.Item.Charity .LogoURL	string	Conditionally	The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing.
BidItemArray.Item.Charity .Mission	string	Conditionally	The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing. Max length: 511.
BidItemArray.Item.Charity .Status	CharityStatusCodeType	Conditionally	The status of the nonprofit charity organization. Applicable values: • CustomCode (out) Reserved for internal or future use. • NoLongerValid (out) The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. • Valid (out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider.
BidItemArray.Item.Country	CountryCodeType	Always	Two-letter ISO 3166 country code. In some calls, used with the Location field to indicate the city and country where the item is located. Also applicable as input to AddItem and related calls when you list items to Half.com (specify US). For English names that correspond to each code (e.g., KY="Cayman Islands"), call GeteBayDetails or see the following ISO site: http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html Applicable values: See Country.
BidItemArray.Item.Currency	CurrencyCodeType	Always	Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the item-listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item. Applicable values: See Currency. See Field Differences for eBay Sites.
BidItemArray.Item .DisableBuyerRequirements	boolean	Conditionally	If false (or omitted): if BuyerRequirementDetails are present, those requirements are to be used; otherwise, any requirements specified in My eBay are to be used. If true: no requirements are considered from any source (and if BuyerRequirementDetails are present, they are ignored). Default: false.
BidItemArray.Item .DispatchTimeMax	int	Conditionally	Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. This time does not include the shipping time (the carrier's transit time). For the AddItem family of calls: Required for listings in certain categories when certain shipping services (with delivery) are offered. See HandlingTimeEnabled in GetCategoryFeatures. The seller sets this to a positive integer value corresponding to the number of days. For a list of allowed values on each eBay site, use DispatchTimeMaxDetails in GeteBayDetails. (Typical values are 1, 2, 3, 4, 5, 10, 15, or 20, but this can vary by site and these may change over time.) Valid for flat and calculated shipping. Does not apply when there is no shipping, when it is local pickup only or it is freight shipping. For example, when ShippingService=Pickup or ShipToLocations=None, then DispatchTimeMax is not required (or it can be 0). To add Get It Fast to listings (for domestic shipping), in addition to setting GetItFast to true, DispatchTimeMax must be set to 1 and the seller must specify at least one qualifying expedited shipping service. For ReviseItem only: If the listing has bids or sales and it ends within 12 hours, you can't change this value. If the listing is a GTC listing that has sales or ends within 12 hours (one or the other, but not both), you can add or change this value. If the listing has no bids or sales and more than 12 hours remain before the listing ends, you can add or change the dispatch (handling) time. For GetItem: GetItem returns DispatchTimeMax only when shipping service options are specified for the item and the seller specified a dispatch time. See: Handling Time and Estimated Delivery Time (GetCategoryFeatures) SiteDefaults.HandlingTimeEnabled
BidItemArray.Item .FreeAddedCategory	CategoryType	Conditionally	ID for a second category that eBay added as a free promotion. You cannot add this yourself. Only returned if the item was listed in a single category and eBay added a free second category. Not applicable to Half.com.
BidItemArray.Item .FreeAddedCategory.CategoryID	string	Conditionally	Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetPopularKeywords, -1 represents the root category. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10.
BidItemArray.Item .FreeAddedCategory .CategoryName	string	Conditionally	Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel). In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings. Max length: 30.
BidItemArray.Item.GetItFast	boolean	Conditionally	Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Not supported for UK Store Inventory format items. Not applicable to Half.com. See: Enabling Multi-jurisdiction Sales Tax Miscellaneous Item Field Differences
BidItemArray.Item.GiftIcon	int	Always	If true, a generic gift icon displays next the listing's title in search and browse pages. GiftIcon must be set to be able to use GiftServices options. Note that one/zero is returned instead of true/false. When the Top-Rated Seller program becomes operational in October 2009, some enhanced listing features will be removed or restricted to certain sellers on some sites. Use GeteBayDetails ListingFeatureDetails for more information. Not applicable to Half.com.
BidItemArray.Item.GiftServices	GiftServicesCodeType	Conditionally, repeatable: [0..*]	Optional gift services that the seller is offering if the buyer chooses to purchase the item as a gift. Only returned if offered by the seller. When the Top-Rated Seller program becomes operational in October 2009, some enhanced listing features will be removed or restricted to certain sellers on some sites. Use GeteBayDetails ListingFeatureDetails for more information. Not applicable to Half.com. Applicable values: • CustomCode (in/out) Reserved for internal or future use • GiftExpressShipping (in/out) The seller is offering to ship the item via an express shipping method as explained in the item description. • GiftShipToRecipient (in/out) The seller is offering to ship to the gift recipient (instead of to the buyer) after payment clears. • GiftWrap (in/out) The seller is offering to wrap the item (and optionally include a card) as explained in the item description.
BidItemArray.Item.HitCount	long	Conditionally	The number of page views for the item. This number is calculated by eBay and cannot be set via the API. Returned if the hit counter type is BasicStyle, RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the requestor is the item's seller.
BidItemArray.Item.HitCounter	HitCounterCodeType	Always	Indicates whether an optional hit counter is displayed on the item's listing page and, if so, what type. See HitCounterCodeType for specific values. Not applicable to Half.com. Applicable values: • BasicStyle (in/out) A basic style hit counter. • CustomCode (in/out) Reserved for internal or future use • GreenLED (in/out) A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead. • Hidden (in/out) A hidden hit counter (US only). The number of page views will only be available to the item's seller. For faster "View Item" page loads, use HiddenStyle. • HiddenStyle (in/out) A hidden hit counter. The number of page views will only be available to the item's seller. • HonestyStyle (in/out) A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead. • NoHitCounter (in/out) No hit counter. The number of page views will not be available. • RetroStyle (in/out) A retro, computer-style hit counter.
BidItemArray.Item.ItemID	ItemIDType (string)	Always	The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
BidItemArray.Item .ListingDesigner	ListingDesignerType	Conditionally	Contains the detail data for the Listing Designer theme and template (if either are used), which can optionally be used to enhance the appearance of the description area of an item's description. See ListingDesignerType for its child elements. Not applicable to Half.com.
BidItemArray.Item .ListingDesigner.LayoutID	int	Conditionally	Identifies the Layout template to use when displaying the item's description. Call GetDescriptionTemplates for valid IDs. Set to false in GetDescriptionTemplates (or do not specify LayoutID) to get the standard layout. If a Listing Designer layout is used (except standard layout), PhotoDisplayType must be false (or not be specified). When relisting an item, LayoutID is removed from the listing if you specify ListingDesignerType without LayoutID. Alternatively, to remove this value when revising or relisting an item, use DeletedField.
BidItemArray.Item .ListingDesigner .OptimalPictureSize	boolean	Conditionally	If true, indicates that the item's picture will be enlarged to fit description of the item.
BidItemArray.Item .ListingDesigner.ThemeID	int	Conditionally	ID for the Listing Designer theme template to use when displaying the item's description. When relisting, if you specify ListingDesignerType without ThemeID, ThemeID is removed from the listing. Alternatively, to remove this value when revising or relisting an item, use DeletedField.
BidItemArray.Item .ListingDetails	ListingDetailsType	Always	Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com.
BidItemArray.Item .ListingDetails.Adult	boolean	Always	If true, the item is listed in a Mature category. Users must accept the Mature Category agreement on the eBay site to retrieve items listed in Mature categories. (Users do not need to sign this agreement to be able to list items in Mature Categories.)
BidItemArray.Item .ListingDetails.BindingAuction	boolean	Always	Applicable for Real Estate auctions only. If true, buyers and sellers are expected to follow through on the sale. If false, bids for the Real Estate auction are only expressions of interest.
BidItemArray.Item .ListingDetails .BuyItNowAvailable	boolean	Conditionally	Indicates whether Buy It Now is available for the competitive-bid auction listing. As a general rule, once a Chinese auction has bids (and the high bid exceeds the reserve price, if any), the listing is no longer eligible for Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. See Longer Lasting Buy It Now.
BidItemArray.Item .ListingDetails .CheckoutEnabled	boolean	Always	Indicates whether checkout is enabled for this item. If true, indicates that the seller elects to allow the item purchase to go through the checkout process, if the buyer chooses to do so. See Checkout.
BidItemArray.Item .ListingDetails .ConvertedBuyItNowPrice	AmountType (double)	Always	Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
BidItemArray.Item .ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .ListingDetails .ConvertedReservePrice	AmountType (double)	Conditionally	Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
BidItemArray.Item .ListingDetails .ConvertedReservePrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .ListingDetails .ConvertedStartPrice	AmountType (double)	Always	Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.
BidItemArray.Item .ListingDetails .ConvertedStartPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .ListingDetails.EndTime	dateTime	Always	Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. In GetSearchResults, the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing.
BidItemArray.Item .ListingDetails .HasPublicMessages	boolean	Always	Indicates whether the item has any publicly displayed messages. Use GetMemberMessages to retrieve public messages for the item if this flag indicates that there are any.
BidItemArray.Item .ListingDetails .HasReservePrice	boolean	Always	If true, the seller specified a value in ReservePrice.
BidItemArray.Item .ListingDetails .HasUnansweredQuestions	boolean	Always	Indicates whether the item has any unanswered questions. Use GetMemberMessages to retrieve unanswered questions for the item if this flag indicates that there are any.
BidItemArray.Item .ListingDetails.RelistedItemID	ItemIDType (string)	Conditionally	Indicates the new item ID for a re-listed item. When an item is re-listed, the item ID for the new (re-list) item is added to the old (expired) listing to provide buyers a means to navigate to the new listing. This value only appears when the old listing is retrieved. Output only.
BidItemArray.Item .ListingDetails .SecondChanceOriginalItemID	ItemIDType (string)	Conditionally	The item ID for the original listing from which a second chance offer is made. This value is only returned when the data for the second chance offer listing is retrieved. Output only.
BidItemArray.Item .ListingDetails.StartTime	dateTime	Always	The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
BidItemArray.Item .ListingDetails .TCROriginalItemID	ItemIDType (string)	Conditionally	Indicates the item ID of the original item listing from which a Transaction Confirmation Request (TCR) was created. This value is only returned when the data for a TCR is retrieved.
BidItemArray.Item .ListingDetails.ViewItemURL	anyURI	Always	The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in a search-related call (for example, if you used the AffiliateTrackingDetails container in an applicable call), ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network). In search results (like the GetSearchResults response), this link to the View Item page is configured to select the applicable variation.
BidItemArray.Item .ListingDetails .ViewItemURLForNaturalSearch	anyURI	Conditionally	This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines. The URL includes the item title along with other optimizations. To note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes to "QQ", and "=" (equals sign) optimizes to "Z". If you are an eBAy affiliate, use this URL to promote your affiliate information. Note: This URL may include additional query parameters that don't appear in ViewItemURL and vice versa. You should not modify the query syntax. For example, eBay won't recognize the URL if you change QQ to ?. In search results (like the GetSearchResults response), if the result is a variation from a multi-variation listing, this link to the View Item page is configured to select the applicable variation.
BidItemArray.Item .ListingDuration	token	Conditionally	Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time. The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable). The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information. When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours. Required for Half.com (but only specify GTC). See: GetCategoryFeatures Fees per Site Applicable values: See ListingDurationCodeType
BidItemArray.Item .ListingEnhancement	ListingEnhancementsCodeType	Conditionally, repeatable: [0..*]	Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade. Also includes feature packs for saving on listing upgrades. See Listing Upgrades in the eBay Web site online help. You cannot remove listing upgrades when you revise a listing. When you relist an item, use DeletedField to remove a listing upgrades. Not applicable to Half.com. Applicable values: • BasicUpgradePackBundle (in/out) No longer applicable to any site. Formerly, a feature pack applicable to the Australia site (site ID 15, abbreviation AU) only. Contained the Gallery and Subtitle features. • BoldTitle (in/out) If specified, the seller wants the title for the item's listing to be in boldface type. Applicable listing fees apply. Does not affect the item subtitle (Item.SubTitle), if any. Not applicable to eBay Motors. • Border (in/out) If specified, the seller wants the item to be displayed with a border that goes around the item in search result pages that return multiple items. The border differentiates the item from other items in the list. Applicable listing fees apply. • CustomCode (in/out) Reserved for internal or future use. • Featured (in/out) Listing is a "Featured Plus" item. The item will display prominently in the Featured Items section of its category list, and it will stand out on search results pages. It will also display in the regular, non- featured item list. Only available to users with a Feedback rating of 10 or greater. • Highlight (in/out) Listing is highlighted in a different color in lists. • HomePageFeatured (in/out) Listing will have a chance to rotate into a special display on eBay's Home page. Your item is very likely to show up on the Home page, although eBay does not guarantee that your item will be highlighted in this way. This is the highest level of visibility on eBay. Not applicable for eBay Motors (SiteId 100). In order to feature the listing on eBay Motors home page, use PictureDetails.GalleryType.Featured instead. See GalleryTypeCodeType for more information. • ProPackBundle (in/out) Listing is using ProPackBundle (a feature pack). Applies only to US and Canadian eBay motor vehicle sellers. Contains the BoldTitle, Border, Featured and Highlight features. • ProPackPlusBundle (in/out) Support for this feature varies by site and category. A ProPackPlusBundle listing is using ProPackPlus bundle (a feature pack), which combines the features of BoldTitle, Border, Highlight, Featured (which is equivalent to a GalleryType value of Featured), and Gallery, for a discounted price. Note that if, for example, in AddItem, if you use ProPackPlusBundle and a GalleryType value of Gallery, then the resulting item will have a GalleryType value of Featured. • ValuePackBundle (in/out) Listing is using ValuePack bundle (a feature pack), which combines the features Gallery, Subtitle, and Listing Designer for a discounted price. Support for this feature varies by site and category. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites (starting on the same production date), whenever ValuePackBundle is selected in a request, the basic Gallery feature included in the Value Pack bundle is now automatically upgraded to the Gallery Plus feature at no extra cost (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus). If ValuePackBundle is selected and no Gallery picture is found, the request is still accepted and the ValuePackBundle fee will still apply. Whenever a listing with ValuePackBundle is created on a site that offers free Gallery, the Gallery Plus upgrade will display on all sites and categories that support ValuePackBundle. Note that if Gallery Showcase is automatically included with Gallery Plus, it will be extended to listings with ValuePackBundle that upgrade Gallery to Gallery Plus (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus).
BidItemArray.Item.ListingType	ListingTypeCodeType	Always	The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611. (in/out) Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. Deprecation version: 611. See also Deprecated Objects. • Express Deprecated as of version 561. (in/out) For Germany only: eBay Express format (item is listed only on eBay Express only, not on eBay). You must be an Express Germany seller to use this format. See "Express Format Criteria" in the eBay Web Services guide. As of late April 2008, this value will no longer work, regardless of the API version you are using. Deprecation version: 561. See also Deprecated Objects. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601. (out) Live auction, on-site auction that can include non-eBay bidders. (Use AddLiveAuctionItem to list live auctions.) Live auctions are listed on the eBay Live Auctions site, in live auction categories. They can also appear on eBay if the seller lists the lot in a secondary category that is an eBay category. Deprecation version: 601. See also Deprecated Objects. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) See: Different Ways of Selling Listing Types (Formats) GetCategoryFeatures Fees per Site
BidItemArray.Item.Location	string	Always	Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you do not specify Location, you must specify Item.PostalCode. If you specify a postal code, but do not specify a location, then the location is given a default value derived from the postal code. For the Classified Ad format for eBay Motors vehicles, the value provided in the Location is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location. Also applicable as input to AddItem and related calls when you list items to Half.com. Max length: 45.
BidItemArray.Item .LocationDefaulted	boolean	Conditionally	True if eBay provided a central location as a result of the user not specifying a location. This typically occurs when the seller specifies PostalCode without Location. Not applicable to Half.com.
BidItemArray.Item.LotSize	int	Conditionally	A lot is a set of two or more similar items that must be purchased together in a single transaction. A listing can have multiple lots (instead of multiple items). When LotSize is specified, the listing price reflects the price of each lot (not each item within the lot). In this case, Quantity indicates the number of lots being listed, and LotSize indicates the number of items in each lot. (If a listing has no lots, Quantity indicates the number of separate items being listed.) Important: Lot items can be listed only in lot-enabled categories. GetCategories returns LSD (lot size disabled) with a value of true for categories that do not support lots. Not applicable to Half.com. Max: 100000.
BidItemArray.Item .MotorsGermanySearchable	boolean	Conditionally	Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany. If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site. Not applicable to Half.com.
BidItemArray.Item .PaymentDetails	PaymentDetailsType	Conditionally	Contains data associated with eBay Motors payments (Durations for deposit and full payments). Returned for Motors listings. Not applicable to Half.com. See Payment Methods for Motors.
BidItemArray.Item .PaymentDetails .DaysToFullPayment	int	Conditionally	Applies to vehicle categories on the US and Canada eBay Motors sites (not Parts and Accessories categories). Number of days after a listing closes that the buyer can take to pay the full cost of the vehicle. The choices are 3, 7, 10, and 14, and the default is 7. PayPal and credit cards cannot be used to pay the full cost of a vehicle, so the listing must offer MOCC (cashier's check), PersonalCheck, LoanCheck, CashInPerson, and/or PaymentSeeDescription as payment methods. Default: 7.
BidItemArray.Item .PaymentDetails.HoursToDeposit	int	Conditionally	Applies to US eBay Motors site (except Parts and Accessories category). Number of hours after a listing closes that the buyer can put down a deposit on an item (if the seller specified a deposit). Only takes effect if listing also includes the Deposit Amount and Deposit Type attributes (see AttributeSetArray). The choices are 24, 48, and 72, and the default is 48. Deposits can only be paid using PayPal, so the listing must offer PayPal as a payment method (in addition to the payment methods offered for the full payment). Default: 48.
BidItemArray.Item .PaymentMethods	BuyerPaymentMethodCodeType	Conditionally, repeatable: [0..*]	Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. Use GetCategoryFeatures to determine the payment methods that are allowed for a category on a site. For example, the response data of GetCategoryFeatures will show that on the US site, most categories only allow electronic payments. Also use GetCategoryFeatures to determine the default payment methods for a site. Do not use GeteBayDetails to determine the payment methods for a site. If you specify multiple PaymentMethods fields, the repeating fields must be contiguous. For example, you can specify PayPalEmailAddress after a list of repeating PaymentMethods fields, but not between them: <PaymentMethods>VisaMC</PaymentMethods> <PaymentMethods>PayPal</PaymentMethods> <PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress> In general, if you separate repeating instances of a field, the results will be unpredictable. This rule applies to all repeating fields (maxOccurs="unbounded" or greater than 1) in the schema. See "Overview of the Schema" in the eBay Web Services guide. Note: Required or allowed payment methods vary by site and category. Refer to Payment Method Differences (PaymentMethod) in the eBay Trading API Guide for information to help you determine which payment methods you are required or allowed to specify. Payment methods are not applicable to eBay Real Estate ad format listings, Classified Ad format listings, or Half.com. For ReviseItem and RelistItem only: A listing must have at least one valid payment method. When you revise or relist an item and you specify a payment method that is invalid for the target site, eBay ignores the invalid payment method, applies the other valid changes, and returns a warning to indicate that the invalid payment method was ignored. If multiple payment methods were invalid, the warning indicates that they were all ignored. If you modify the listing so that it includes no valid payment methods, an error is returned. This situation could occur when the seller removes all valid payment methods or when all the payment methods specified for the item are no longer valid on the target site. For GetProducts only: Only PayPal is returned in product search results. Applicable values: See PaymentMethods. See: Payment Method Differences (PaymentMethod) Listing an Item (SetUserPreferences) SellerPaymentPreferences Overview of the API Schema for rules regarding repeating nodes
BidItemArray.Item .PayPalEmailAddress	string	Conditionally	Valid PayPal email address for the PayPal account that the seller will use if they offer PayPal as a payment method for the listing. eBay uses this to identify the correct PayPal account when the buyer pays via PayPal during the checkout process. (As a seller can have more than one PayPal account, you cannot necessarily rely on PayPal account data returned from GetUser for details about the account associated with the PayPal email address that the seller specifies.) Required if seller has chosen PayPal as a payment method (PaymentMethods) for the listing. For digital listings, the seller needs to use an email address that is associated with a PayPal Premier or PayPal business account. For ReviseItem and RelistItem only: To remove this value when you revise or relist an item, use DeletedField. When you revise a listing, if the listing has bids (or items have been sold) or it ends within 12 hours, you can add PayPalEmailAddress, but you cannot remove it. Not applicable to eBay Motors listings. Not applicable to Half.com. See: Listing an Item (SetUserPreferences) SellerPaymentPreferences
BidItemArray.Item .PictureDetails	PictureDetailsType	Conditionally	Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. See Introduction to Pictures in Item Listings.
BidItemArray.Item .PictureDetails.GalleryType	GalleryTypeCodeType	Conditionally	Indicates whether listing images are included in the search results (in both Picture Gallery and List Views) and, if so, which image listing enhancements apply to them. Items that have pictures but do not have image listing enhancements display a generic photo image in search results. If the value is Gallery, Plus, or Featured, eBay checks the available image URLs in the following order to determine which URL to use (if more than one of these URLs is available): a) Use the URL in GalleryURL, if it is specified. b) Otherwise, if ProductListingDetails.UseStockPhotoURLAsGallery is true, use the eBay stock photo. c) Otherwise, use the value of the first PictureURL in the array of PictureURL fields, if any. d) Otherwise, if ProductListingDetails.ProductID is specified, use the eBay stock photo for that ProductID (eBay resets UseStockPhotoURLAsGallery to true in this case). e) If eBay is unable to find an image URL for the listing, an error is returned. Note that you can use the Gallery Plus feature whether or not the image is hosted with eBay Picture Services (EPS). Selecting Gallery Plus does not incur a separate Gallery fee. See "Describing Items in a Listing" in the eBay Web Services Guide for additional information about working with pictures and related validation rules. You cannot remove Gallery, Plus, or Featured when revising an item, however you can upgrade to a higher feature. On upgrade, the original feature fee is credited, and the new feature fee is charged. There are a number of categories on some eBay sites that always offer the Gallery feature for free. (The API doesn't flag these categories in any meta-data calls.) In these categories, if you specify a picture and you don't specify GalleryType, eBay may add GalleryType=Gallery to the listing (for free) and return a warning (error code 219243). The Knowledge Base explains an edge case that could result in an unexpected gallery fee if the seller moves the item to a category that doesn't offer the free gallery feature. This fee can also appear when if the seller moves the item from a site that offers free Gallery (across all its categories) to one where free Gallery is not yet available. Whenever you change the primary category, it is a good idea to clearly specify whether the seller is intentionally requesting the gallery option. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), UK (site ID 3), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay will automatically create a Gallery thumbnail for the listing in search results by selecting a picture from one of the image URLs specified in the request (either Item.PictureDetails.PictureURL or Item.PictureDetails.GalleryURL) or from an available stock photo. Thus, a Gallery thumbnail will be created whenever Item.PictureDetails.GalleryType is None or is not specified in the request. A Gallery fee will apply whenever GalleryType specifies the Plus or Featured image enhancements (there will be no Gallery fee whenever GalleryType is Gallery, None or is not specified in the request). eBay will select the image for the thumbnail depending on which of the image URLs above was specified in the request (there are selection rules for four cases). Note that the selected image will not necessarily be the image you have specified in Item.PictureDetails.GalleryURL. Note that a Gallery thumbnail will not be automatically created if PictureURL and GalleryURL are not supplied and UseStockPhotoURLAsGallery and IncludeStockURL are set to false. The most common case occurs when both GalleryURL and PictureURL are specified in the request. eBay will use the image referenced by PictureURL as the Gallery thumbnail. As three other cases exist, please refer to "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information on how eBay selects an image for the gallery thumbnail on these sites. You cannot remove Gallery or Featured when revising an item, however you can upgrade to a higher feature. On upgrade, the original feature fee is credited, and the new feature fee is charged. (This does not apply to Gallery Plus on sites with free Gallery; see Plus below for more information.) Applicable values: • CustomCode (in/out) Reserved for internal or future use. • Featured (in/out) Listing is highlighted and included at the top of search results. When "Featured" is included in an item listing, the listing also automatically gets the Gallery and Gallery Plus functionality. "Gallery" and "Plus" do not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. For eBay Motors (SiteId 100), this may also feature certain items on the eBay Motors home page. Not applicable to eBay Stores Inventory listings. Note: Gallery Featured is now known as Featured First on several eBay sites, including US (main site, not motors), CA, CAFR, UK, IE, DE, AT, CH, and IT. • Gallery (in/out) Listing image is included in the search results (in both Picture Gallery and List Views). Items that have pictures but do not have the Gallery feature will have a generic photo image shown in search results. Some listing enhancements (for example, "Featured" and "Plus") automatically include the Gallery functionality, so "Gallery" does not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. • None (in/out) Listing image is not included in the search results (in either Picture Gallery or List Views), and no other image listing enhancements apply. Items that have pictures but do not have image listing enhancements display a generic photo image in search results. Mainly useful for RelistItem use cases when you want to remove an existing gallery setting. However, not all image listing enhancements can be removed on revise or relist. Note that specifying None is not necessarily the same as omitting GalleryType from a request. For example, specifying other item properties may cause the listing to be included in the search results Gallery by default if GalleryType is not specified. • Plus (in/out) Listing image has Gallery Plus funtionality. That is, listing includes a Gallery Plus icon that, when moused over or clicked, displays a large (400 px x 400 px) preview image of the item. Clicking the image displays the View Item page for that listing. Listing images that are originally smaller than 400 px x 400 px are centered in the preview frame. Images that are originally larger than 400 px x 400 px are scaled down to 400 px on their longest side (maintaining their original aspect ratio). Note that you can use the Gallery Plus feature whether or not the image is hosted with eBay Picture Services (EPS). One EPS image is included at no cost with the Gallery Plus feature. When "Plus" is included in an item listing, the listing also automatically gets the Gallery functionality at no extra cost. "Gallery" does not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites (starting on the same production date), whenever Plus is selected in a request that specifies at least two eBay Picture Services (EPS) hosted images (using ItemType.PictureDetailsType.PictureURL), the Gallery Plus feature now automatically includes a Gallery Showcase of all the listing's images at no extra cost. If Plus is selected and the request includes only one EPS image or any self-hosted images, regular Gallery Plus applies. The Gallery Showcase displays when mousing over or clicking on the listing's Gallery Plus icon in the search results. The Showcase window displays a large (400 px x 400 px) preview image which is usually the first specified PictureURL, as well as up to four (64 px x 64 px) selectable thumbnails for the remaining EPS images (the Showcase window contains pagination controls for observing all EPS images in the request). Clicking on the preview image displays the item's listing page. When using RelistItem or ReviseItem (item has no bids and more than 12 hours before the listing's end), Plus can be unselected in the request. However, the Plus fee will still apply if a previous request selected Plus. There is at most one Plus fee per listing. Not applicable to eBay Stores Inventory listings. See: Introduction to Pictures in Item Listings Using Gallery Features on Sites with Free Gallery for complete details on how eBay selects a gallery thumbnail. KB article: Why am I getting charged a GalleryFee in my RelistItem call...?
BidItemArray.Item .PictureDetails.GalleryURL	anyURI	Conditionally	URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CA (site ID 2), UK (site ID 3), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. See: Introduction to Pictures in Item Listings Using Gallery Features on Sites with Free Gallery for complete details on how eBay selects a gallery thumbnail. (ReviseItem) DeletedField
BidItemArray.Item .PictureDetails.PhotoDisplay	PhotoDisplayCodeType	Conditionally	Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • None (in/out) No special image display options. Valid for US Motors listings. • PicturePack (in/out) Increase the number of images displayed. Only available for images hosted with eBay. See GetCategoryFeatures and the online Help (on the eBay site) for additional information. Picture Pack applies to all sites (including US Motors), except for NL (site ID 146). You can specify a minimum of one EPS picture, or no SuperSize-qualified EPS pictures in the request. For the NL site, PicturePack is replaced with SuperSize. • SiteHostedPictureShow (in/out) This value is no longer applicable. Formerly, the value displays multiple, site-hosted pictures in a slideshow format. • SuperSize (in/out) Increase the size of each image and allow buyers to enlarge images further. Only available for site-hosted (EPS) images. Not valid for US Motors listings. For all sites that do not automatically upgrade SuperSize to PicturePack (see note below), specifying no SuperSize-qualified images is now accepted in the request. Note: SuperSize is automatically upgraded to PicturePack for the same SuperSize fee on the US Motors Parts & Accessories Category and US (site ID 0) and CA (site ID 2) and CAFR (site ID 210). This upgrade applies only to EPS images (including Picture Manager images). • SuperSizePictureShow (in/out) This value is no longer applicable. Use SuperSize instead. Formerly, the value displays multiple, super-size, site-hosted pictures in a slideshow format. Valid for US Motors listings. • VendorHostedPictureShow (in/out) This value is no longer applicable. Formerly, the value displays multiple, vendor-hosted pictures in a slideshow format. Not valid for US Motors listings. (Not all values in PhotoDisplayCodeType apply to this field.)
BidItemArray.Item .PictureDetails.PictureURL	anyURI	Conditionally, repeatable: [0..*]	Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CA (site ID 2), UK (site ID 3), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). As a result of these changes, the top of an item's listing page may not necessarily be the image you have specified in PictureURL for certain scenarios. For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. Contains the URL for an image associated with the item. Images can be hosted by eBay Picture Services (EPS) (or by eBay Picture Manager) or they can be self-hosted. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL value. If specified, this cannot have an empty/null value. To specify multiple pictures, send each URL in a separate, adjacent PictureURL element. In most cases, the image at the first URL is also used for the picture at the top of the View Item page on the Web site. On the main eBay site, a listing can have a maximum of 12 picture URLs hosted by eBay Picture Services or 1 picture URL hosted by a third-party vendor. You cannot mix vendor-hosted and site-hosted pictures within the same listing. On the US eBay Motors site (for all vehicle listings), and on the eBay Canada site for motors, the picture pack of a listing can contain up to 24 photos. On the eBay Live Auctions site, a listing can have a maximum of 5 picture URLs hosted by eBay Picture Services. If you embed pictures in the description (by using IMG tags) instead of using PictureURL, but you want a camera icon to appear in search and listing pages, specify the following "clear image" URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif. Note: On sites that offer free Gallery, the camera icon will not be available to appear as a gallery thumbnail or in a listing page whenever the first PictureURL field in the request is set to the "clear image" URL. In this case, eBay will attempt to use the image referenced by GalleryURL as the gallery thumbnail. If GalleryURL has not been specified, a blank (camera-less) gallery thumbnail displays in the search results and at the top of the listing page. If you have set the first PictureURL to the "clear image" URL, you can either Item.ProductListingDetails.UseStockPhotoURLAsGallery or Item.ProductListingDetails.UseStockPhotoURL to true and eBay will use a stock photo, if available, for the gallery thumbnail as well as the picture that displays at the top of the listing page. Note that a gallery picture will not be generated if UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to false (or not set) and no alternative picture in PictureURL. A Gallery fee applies only if you have specified GalleryType as either Plus or Featured (see Item.PictureDetails.GalleryType above for information). See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for information on eBay's selection rules for Gallery pictures on sites with free Gallery. For VerifyAddItem only: For VerifyAddItem, you can use the following fake eBay Picture Services URL (http://i2.ebayimg.com/abc/M28/dummy.jpg) to verify that your application is obtaining the correct fees for the quantity of images you pass in. For ReviseItem and RelistItem only: To remove a picture when revising or relisting an item, specify PictureDetails with all the pictures that you want the listing to include. That is, you need to completely replace the original set of URLs with the revised set. To remove all PictureURL fields from a listing, specify item.PictureDetails.PictureURL in DeletedField. However, please note that if the listing also includes a gallery image that is based on the first picture in the listing, you may need to supply an alternate image to use as the gallery image if you delete all PictureURL fields. There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for details about fees that could be charged if you change the category in these cases (or when revising a listing from a site with free gallery to one where free gallery is not yet available.) Max length: 150. See: Using Gallery Features on Sites with Free Gallery for complete details on how eBay selects a gallery thumbnail. Introduction to Pictures in Item Listings eBay Live Auctions (ReviseItem) DeletedField (RelistItem) GalleryType
BidItemArray.Item.PostalCode	string	Conditionally	Postal code of the place where the item is located. This value is used for proximity searches. To remove this value when revising or relisting an item, use DeletedField. If you do not specify PostalCode, you must specify Item.Location. If you specify PostalCode, but do not specify Item.Location, then Item.Location is given a default value derived from the postal code. Not applicable to Half.com.
BidItemArray.Item .PrimaryCategory	CategoryType	Always	Category ID for the first (or only) category in which the item is listed (or will be listed, if the item is new). A number of listing features have dependencies on the primary category. We have pointed out a few of the notable dependencies below. See the descriptions of the fields you are using to determine whether the feature you're supporting depends on the listing's primary category. For the AddItem family of calls: Use calls like GetCategories and GetCategoryFeatures to determine valid values for the site on which you are listing (see the eBay Web Services Guide for information on working with categories). Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for information about fees that could be charged if you change the category in these cases. Not applicable to Half.com. For ReviseItem only: When revising a listing, you can change the primary category only if an item has no bids (or no items have sold) and the listing does not end within 12 hours. If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. See Item.AttributeSetArray. For the eBay US site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details. You cannot change the meta-categories for vehicles (i.e., you cannot change a truck to a motorcycle), but you can change the leaf category (e.g., change one motorcycle subcategory to another motorcycle subcategory). See the eBay Web Services Guide for additional rules. International sites (such as the eBay Germany site) have similar rules for revising vehicle categories. For GetItemRecommendations only: For GetItemRecommendations, use this value to control the category that is searched for recommendations. Specify the category in which the item will be listed. See Getting Recommendations to Improve a Listing in the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attribute engine. For GetProducts: Use GetCategories if you need to determine the name of the category. See: Categories Specifying eBay Live Auctions Categories Listing US and CA eBay Motors Items (RelistItem) GalleryType KB Article: Listing with ExternalProductID and CategoryID
BidItemArray.Item .PrimaryCategory.CategoryID	string	Always	Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetPopularKeywords, -1 represents the root category. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10.
BidItemArray.Item .PrimaryCategory.CategoryName	string	Always	Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel). In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings. Max length: 30.
BidItemArray.Item .PrivateListing	boolean	Always	If true, designates the listing as private. When you create a private listing, a buyer's User ID will not appear in the listing or in the listing's bid history. Sellers may want to use this option when they believe that potential bidders for a listing would not want their User IDs disclosed to others. Not applicable to Half.com.
BidItemArray.Item .ProductListingDetails	ProductListingDetailsType	Conditionally	Specifies stock product information to include in a listing. Only applicable when listing items with product details. See the eBay Trading API Guide for information on listing with product details. As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails, eBay attempts to find a matching product on your behalf and use it in the listing. If no match is found, you can try using the catalog search calls (such as GetProductSearchResults or GetProducts) to find a ProductID or ProductReferenceID. When you specify ProductListingDetails, you must specify at least one product ID for the listing (ProductID, ProductReferenceID, ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails). If you specify more than one of these values (such as UPC and BrandMPN), eBay uses the first one that matches a product in eBay's catalog system. (This may be useful if you aren't sure which ID is more likely to result in a match.) If you do not specify a primary category, eBay determines the category based on the product ID (if a matching product is found in the system). If you do specify the category, it takes precedence (and it must be a catalog-enabled category that is valid for the product ID). If you list in two categories and the primary and secondary categories are both catalog-enabled, this product should correspond to the primary category (not the secondary category). If only one category is catalog-enabled, the product listing details should correspond to the catalog-enabled category. (Use GetCategory2CS to determine which categories are catalog-enabled.) Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. (ExternalProductID will be deprecated in a future release.) For ReviseItem and RelistItem only: If a listing includes product details and you change a category, the rules for continuing to include product details depend on whether or not the new category is mapped to a characteristic set associated with the same product ID. When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product ID and you cannot remove existing product data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request. For GetItemRecommendations only: For GetItemRecommendations, see the eBay Web Services guide for validation rule differences when using the Product Pricing engine. Not applicable to Half.com. See: The Catalog Product (Product Details) API Getting eBay Pricing Data for Listings with Product Details
BidItemArray.Item .ProductListingDetails .Copyright	string	Conditionally, repeatable: [0..*]	Copyright statement indicating the source of the product information. This information will be included in the listing with Pre-filled Item Information. Your application should also display the copyright statement when rendering the Pre-filled Item Information. If more than one copyright statement is applicable, they can be presented to the user in alphabetical order. Returned as HTML. Output only.
BidItemArray.Item .ProductListingDetails .IncludePrefilledItemInformation	boolean	Conditionally	If true, specifies that the listing should include additional information about the product, such as a publisher's description or film credits. Such information is hosted through the eBay site and cannot be edited. If true, Item.Description is optional in item-listing requests.
BidItemArray.Item .ProductListingDetails .IncludeStockPhotoURL	boolean	Conditionally	If true, indicates that the item listing includes the stock photo. To use an eBay stock photo in an item listing, set IncludeStockPhotoURL to true. If a stock photo is available, it is used at the top of the View Item page and in the Item Specifics section of the listing. If you also include Item.PictureDetails.PictureURL, the stock photo only appears in the Item Specifics section of the listing. Other pictures you specify by using Item.PictureDetails.PictureURL appear in a separate section of the listing. If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL to true (and you cannot set it to false). In GetItem, the URL of the stock photo will be returned in StockPhotoURL. If you set IncludeStockPhotoURL to false, the stock photo does not appear in the listing at all. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). Along with these changes, IncludeStockPhotoURL will be used in the request. In some cases, if IncludeStockPhotoURL is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information. Not applicable to Half.com. See: Introduction to Pictures in Item Listings Using Gallery Features on Sites with Free Gallery for complete details on how eBay selects a gallery thumbnail.
BidItemArray.Item .ProductListingDetails .ProductID	string	Conditionally	eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.) If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). In item-listing requests, if you pass in an old product ID, eBay lists the item with the latest version of the product and the latest product ID, and the call returns a warning indicating that the data has changed. As of mid-2008, some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, replacing, deleting, or merging some products (as a result of migrating from one catalog data provider to another). If you specify one of these products in a request, the call may return the product with a warning, or it may fail with an error if the product has been deleted. Max length: 4000.
BidItemArray.Item .ProductListingDetails .StockPhotoURL	anyURI	Conditionally	Fully qualified URL for a standard image (if any) that is associated with the product. A seller includes the stock photo in the listing by setting IncludeStockPhotoURL.
BidItemArray.Item .ProductListingDetails .UseStockPhotoURLAsGallery	boolean	Conditionally	If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery Featured (but not both). Passing in Item.PictureDetails.GalleryURL takes precedence over UseStockPhotoURLAsGallery. See the eBay Trading API guide for additional validation rules for pictures. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). Along with these changes, UseStockPhotoURLAsGallery will be used in the request. In some cases, if UseStockPhotoURLAsGallery is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information. See: Using Gallery Features on Sites with Free Gallery for complete details on how eBay selects a gallery thumbnail. Introduction to Pictures in Item Listings
BidItemArray.Item.Quantity	int	Always	This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. See Selecting a Selling Format.
BidItemArray.Item.ReservePrice	AmountType (double)	Conditionally	The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. Not applicable to Half.com. See: Revising US eBay Motors Listings Reserve Price (eBay Web site help) Fees Overview (eBay Web site help)
BidItemArray.Item.ReservePrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item.ReturnPolicy	ReturnPolicyType	Conditionally	Describes the seller's return policy. Most eBay categories require the seller to clearly specify whether or not returns are accepted (see ReturnsAcceptedOption). For the AddItem family of calls: Required for most categories on most sites. Use ReturnPolicyEnabled in GetCategoryFeatures to determine which categories require this field. Also use ReturnPolicyDetails in GeteBayDetails to determine which ReturnPolicy fields can be used on each site. For ReviseItem only: If the listing has bids or sales and it ends within 12 hours, you can't change the return policy details. If the listing is a GTC listing that has sales or ends within 12 hours (one or the other, but not both), you can add a return policy to the GTC listing (but you can't change return policy details if already present). If the listing has no bids or sales and more than 12 hours remain before the listing ends, you can add or change the return policy. When you revise your return policy, you only need to specify the fields you want to add or change. You don't need to specify all the other ReturnPolicy fields again. The other fields will retain their existing settings. For the GetItem family of calls: Only returned if the site you sent the request to supports the seller's return policy. Typically, the return policy details are only returned when the request is sent to the listing site. GranularityLevel: Fine, Medium. See: Offering a Clear Return Policy (GetCategoryFeatures) Category.ReturnPolicyEnabled for categories that require a return policy (GeteBayDetails) ReturnPolicyDetails for return policy fields that each site reports
BidItemArray.Item.ReturnPolicy .Description	string	Conditionally	A detailed explanation of the seller's return policy. For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but does not specify this field when listing the item, GetItem returns this as an empty node For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. Max length: 5000. GranularityLevel: Fine, Medium. See (GeteBayDetails) ReturnPolicyDetails.Description for sites that support this field.
BidItemArray.Item.ReturnPolicy .EAN	string	Conditionally	The European Article Number (EAN) associated with the item, if any. Refer to the ReturnPolicyDetails node in GeteBayDetails to determine which sites support this field. Only returned if the seller has specified this value in their return policy. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. GranularityLevel: Fine, Medium. See (GeteBayDetails) ReturnPolicyDetails.EAN for sites that support this field.
BidItemArray.Item.ReturnPolicy .Refund	string	Conditionally	Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the Refund.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use RefundOption instead.) GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy .RefundOption	token	Conditionally	Indicates how the seller will compensate the buyer for a returned item. Use the ReturnPolicy.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details.). Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (RefundOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem (and corresponding FixedPrice calls): If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this RefundOption field when listing the item, some eBay sites may set a default value (like MoneyBack), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. GranularityLevel: Fine, Medium. See (GeteBayDetails) RefundOption for sites that support this field, and applicable values. Applicable values: See RefundOptionsCodeType
BidItemArray.Item.ReturnPolicy .ReturnsAccepted	string	Conditionally	Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ReturnsAccepted.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.) GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy .ReturnsAcceptedOption	token	Conditionally	Indicates whether the seller allows the buyer to return the item. This field is required when ReturnPolicy is specified. (If you specify ReturnsNotAccepted, the View Item page may initially show the return policy as unspecified. In a future release, the View Item page will be updated to indicate that returns are not accepted instead.) On the eBay UK and Ireland sites, business sellers must accept returns for fixed price items (including auction items with Buy It Now, and any other fixed price formats) when the category requires a return policy. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (ReturnsAcceptedOptionsCodeType defines all the possible values.) For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. GranularityLevel: Fine, Medium. See: (GeteBayDetails) ReturnsAcceptedOption for sites that support this field, and applicable values Returns and the Law (UK) Applicable values: See ReturnsAcceptedOptionsCodeType
BidItemArray.Item.ReturnPolicy .ReturnsWithin	string	Conditionally	Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ReturnsWithin.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.) GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy .ReturnsWithinOption	token	Conditionally	The buyer can return the item within this period of time from the day they receive the item. Use the ReturnPolicy.Description field to explain the policy details. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (ReturnsWithinOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ReturnsWithinOption field when listing the item, some eBay sites may set a default value (like Days_7), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. GranularityLevel: Fine, Medium. See (GeteBayDetails) ReturnsWithinOption for sites that support this field, and applicable values. Applicable values: See ReturnsWithinOptionsCodeType
BidItemArray.Item.ReturnPolicy .ShippingCostPaidBy	string	Conditionally	Display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ShippingCostPaidBy.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ShippingCostPaidByOption instead.) GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy .ShippingCostPaidByOption	token	Conditionally	The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Description field to explain any additional details. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (ShippingCostPaidByOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ShippingCostPaidByOption field when listing the item, some eBay sites may set a default value (like Buyer), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. GranularityLevel: Fine, Medium. See (GeteBayDetails) ShippingCostPaidByOption for sites that support this field, and applicable values. Applicable values: See ShippingCostPaidByOptionsCodeType
BidItemArray.Item.ReturnPolicy .WarrantyDuration	string	Conditionally	Display string that buyer applications can use to present WarrantyDurationOption in a more user-friendly format to buyers. For example, For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyDuration.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use WarrantyDurationOption instead.) GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy .WarrantyDurationOption	token	Conditionally	The warranty period. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (WarrantyDurationOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyDurationOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. GranularityLevel: Fine, Medium. See (GeteBayDetails) WarrantyDurationOption for sites that support this field, and applicable values. Applicable values: See WarrantyDurationOptionsCodeType
BidItemArray.Item.ReturnPolicy .WarrantyOffered	string	Conditionally	Display string that buyer applications can use to present WarrantyOfferedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyOffered.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use WarrantyOfferedOption instead.) GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy .WarrantyOfferedOption	token	Conditionally	Indicates whether a warranty is offered for the item. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (WarrantyOfferedCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyOfferedOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. Note: For the US eBay Motors limited warranty (Short-Term Service Agreement) option, use Item.LimitedWarrantyEligible instead. For the US eBay Motors "Is There an Existing Warranty?" option, use Item.AttributeSetArray instead. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. GranularityLevel: Fine, Medium. See: Warranties (eBay India) Guidelines for Creating Legally Compliant Listings (eBay India) (GeteBayDetails) WarrantyOfferedOption for sites that support this field, and applicable values Short-Term Service Agreement (Limited Warranty) (AddItem) Item.LimitedWarrantyEligible for US eBay Motors Short-Term Service Agreement Valid Item Specifics for Listing eBay Motors US Cars & Trucks for US eBay Motors existing warranty option (AddItem) Item.AttributeSetArray for US eBay Motors existing warranty option Applicable values: See WarrantyOfferedCodeType
BidItemArray.Item.ReturnPolicy .WarrantyType	string	Conditionally	Display string that buyer applications can use to present WarrantyTypeOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyType.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use WarrantyTypeOption instead.) GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy .WarrantyTypeOption	token	Conditionally	Indicates the source or type of the warranty, if any. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (WarrantyTypeOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyTypeOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. GranularityLevel: Fine, Medium. See (GeteBayDetails) WarrantyTypeOption for sites that support this field, and applicable values. Applicable values: See WarrantyTypeOptionsCodeType
BidItemArray.Item.ReviseStatus	ReviseStatusType	Always	An output value only, indicates whether an item has been revised since the listing became active and, if so, which among a subset of properties have been changed by the revision. Not applicable to Half.com.
BidItemArray.Item.ReviseStatus .BuyItNowAdded	boolean	Conditionally	If true, indicates that a Buy It Now Price was added for the item. Only applicable to US eBay Motors items. Output only.
BidItemArray.Item.ReviseStatus .BuyItNowLowered	boolean	Conditionally	If true, indicates that the item's Buy It Now price was lowered. Only applicable to US eBay Motors items. Output only.
BidItemArray.Item.ReviseStatus .ItemRevised	boolean	Always	If true, indicates the item was revised since the listing became active. Output only.
BidItemArray.Item.ReviseStatus .ReserveLowered	boolean	Conditionally	If true, indicates that the reserve price was lowered for the item. Only applicable to US eBay Motors items. Output only.
BidItemArray.Item.ReviseStatus .ReserveRemoved	boolean	Conditionally	If true, indicates that the reserve price was removed from the item. Only applicable to US eBay Motors items. Output only.
BidItemArray.Item .SecondaryCategory	CategoryType	Conditionally	ID for second category in which the item is listed (also see Item.PrimaryCategory). For the AddItem family of calls: Listing an item in a second category is optional. Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. Not applicable to Half.com. On the eBay UK, Ireland, Germany, Austria, Switzerland, and Italy sites you can list Store Inventory listings in two categories. On the eBay US and other sites, you cannot list Store Inventory listings in two categories. You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. The Final Value Fee is based on the primary category in which the item is listed. Furthermore, you can list the same item in an eBay Motors Parts & Accessories category and in an eligible eBay category, as long as the primary category is associated with the site on which you are listing. That is, the two categories can be a mix of Motors Parts & Accessories and eBay site categories. (Real Estate, Mature Audience (adult), and Business & Industrial categories are not eligible for listing in two categories in this manner.) For example, if you list on Motors, the primary category could be 6750 (eBay Motors > Parts & Accessories > Apparel & Merchandise > Motorcycle > Jackets & Leathers), and the secondary category could be 57988 (eBay > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). If you list on the main eBay site, the primary category could be 57988 and the secondary category could be 6750. To remove this value when relisting an item, use DeletedField. For ReviseItem only: When revising a listing, you can add, remove, or change the secondary category only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you change the secondary category, any corresponding Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the category. See Item.AttributeSetArray. When you revise an item, you can change the secondary category from a Motors Parts & Accessories category to an eBay category or vice versa if the listing has no bids (or no items have sold) and it does not end within 12 hours. For GetItemRecommendations only: For GetItemRecommendations, use this to control the category that will be searched for recommendations. Specify the category in which the item will be listed. See the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine. See Categories.
BidItemArray.Item .SecondaryCategory.CategoryID	string	Conditionally	Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetPopularKeywords, -1 represents the root category. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10.
BidItemArray.Item .SecondaryCategory .CategoryName	string	Conditionally	Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel). In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings. Max length: 30.
BidItemArray.Item.Seller	UserType	Always	Container for information about this listing's seller. Not applicable to Half.com. Returned by GetItemsAwaitingFeedback if Buyer is making the request.
BidItemArray.Item.Seller .AboutMePage	boolean	Always	If true, indicates that the user has set up an About Me page.
BidItemArray.Item.Seller .eBayGoodStanding	boolean	Always	If true, indicates that the user is in good standing with eBay.
BidItemArray.Item.Seller.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.
BidItemArray.Item.Seller .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. 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.
BidItemArray.Item.Seller .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. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,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-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,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.
BidItemArray.Item.Seller .FeedbackScore	int	Always	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. 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.
BidItemArray.Item.Seller .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
BidItemArray.Item.Seller .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).
BidItemArray.Item.Seller .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.
BidItemArray.Item.Seller .SellerInfo	SellerType	Always	Contains information about the user as a seller, such as whether the seller is authorized to list Live Auction items or opts to have items cross-promoted. This field is replaced by the SellerBusinessType field if the user is a business seller with a site ID of 77 (Germany), 3 (UK), 205 (Ireland) or 100 (Motors). See SellerType or SellerBusinessCodeType for the child elements.
BidItemArray.Item.Seller .SellerInfo.AllowPaymentEdit	boolean	Always	Indicates whether the user as a seller by default allows buyers to edit the total cost of an item (while in checkout). (Sellers enable this property in their My eBay user preferences on the eBay site.)
BidItemArray.Item.Seller .SellerInfo.CheckoutEnabled	boolean	Always	Indicates whether the user as a seller has the option set to default new item listings to go through checkout. (Sellers enable this property in their My eBay user preferences on the eBay site.)
BidItemArray.Item.Seller .SellerInfo .CIPBankAccountStored	boolean	Always	If true, indicates that the user has stored bank account information with eBay in order to use the "CIP in checkout" feature. Applicable to all eBay sites that support CIP as a payment method.
BidItemArray.Item.Seller .SellerInfo.GoodStanding	boolean	Always	If true, indicates that the user is in good standing with eBay. (One of the requirements for listing a new item with Immediate Payment.)
BidItemArray.Item.Seller .SellerInfo.MerchandizingPref	MerchandizingPrefCodeType	Always	Indicates whether the seller participates in the Merchandising Manager feature. If so, the seller can set up rules for cross-promoting items from the seller's store. If not, eBay cross-promotes items as the seller's items are being viewed or purchased. Applicable values: • CustomCode (out) Reserved for internal or future use. • OptIn (out) Seller allows item cross-promotion. • OptOut (out) Seller does not allow item cross-promotion.
BidItemArray.Item.Seller .SellerInfo.QualifiesForB2BVAT	boolean	Always	Indicates whether the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT.
BidItemArray.Item.Seller .SellerInfo.SafePaymentExempt	boolean	Always	If true, the user is currently exempt from the requirement to offer at least one safe payment method (PayPal/PaisaPay or one of the credit cards specified in Item.PaymentMethods) when listing items. This value should only return true for sellers who registered before January 17, 2007. Otherwise, it should return false. This setting overrides both the site and category values for SafePaymentRequired. Default: false. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidItemArray.Item.Seller .SellerInfo.SellerLevel	SellerLevelCodeType	Always	The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list. Applicable values: • Bronze (out) Bronze (lowest tier) • CustomCode (out) Reserved for internal or future use • Gold (out) Gold (between Silver and Platinum) • None (out) Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or you have not chosen to be a member of the PowerSeller program, or you lost your PowerSeller status due to a policy violation.) • Platinum (out) Platinum (between Gold and Titanium) • Silver (out) Silver (between Bronze and Gold) • Titanium (out) Titanium (highest tier)
BidItemArray.Item.Seller .SellerInfo.StoreOwner	boolean	Always	Indicates whether the user has an eBay Store (boolean value).
BidItemArray.Item.Seller .SellerInfo.TopRatedSeller	boolean	Conditionally	Coming soon. Whether seller is certified as a Top-Rated Seller, and is qualified for benefits such as final value fee discount and increased visibility in fixed-price searches. Returned when seller is a Top-Rated Seller.
BidItemArray.Item.Seller.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. See Working with Anonymous User Information.
BidItemArray.Item.Seller .Status	UserStatusCodeType	Always	Indicates the user's registration/user status. 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.)
BidItemArray.Item.Seller .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 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. For 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". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized. For PlaceOffer, see also SellingStatus.HighBidder. See Working with Anonymous User Information.
BidItemArray.Item.Seller .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.
BidItemArray.Item.Seller .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.
BidItemArray.Item.Seller .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.
BidItemArray.Item .SellerVacationNote	string	Conditionally	The seller is on vacation (as determined by the seller's store preferences) in two cases: i.) the item is a Store Inventory item and the seller has chosen to hide Store Inventory items while on vacation, and ii.) the seller has chosen to add a message to listed items while on vacation. Not applicable to Half.com.
BidItemArray.Item .SellingStatus	SellingStatusType	Always	Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com.
BidItemArray.Item .SellingStatus.BidCount	int	Always	Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).
BidItemArray.Item .SellingStatus.BidIncrement	AmountType (double)	Always	Smallest amount a bid must be above the current high bid. Only applicable to competitive-bid item listings (Chinese auctions). Returns zero (0.00) for Ad type, eBay Stores Inventory (Stores Fixed-price), and Basic Fixed-Price (Fixed Price Item) listings.
BidItemArray.Item .SellingStatus.BidIncrement [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .SellingStatus .ConvertedCurrentPrice	AmountType (double)	Conditionally	Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.
BidItemArray.Item .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .SellingStatus.CurrentPrice	AmountType (double)	Always	For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.
BidItemArray.Item .SellingStatus.CurrentPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .SellingStatus.FinalValueFee	AmountType (double)	Conditionally	You are charged a Final Value Fee (FVF) if your item is sold, ends with a winning bid, or is purchased. This fee applies whether or not you actually complete the sale with the buyer. The Final Value Fee is returned in Transaction.FinalValueFee. See the eBay.com Web site online help for more information about the final value fee. The Final Value Fee for fixed price format (FixedPriceItem) and Store Inventory (StoresFixedPrice) items is returned by GetSellerTransactions, GetItemTransactions, and GetOrderTransactions on a transaction-by-transaction basis, regardless of the listing status. For all other listing types, (excluding Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed. If you request a Final Value Fee Credit, the value of Transaction.FinalValueFee will not change for the item if a credit is issued. (The credit only appears in the seller's account data.) If the item was a Dutch auction that ended with bids (not Buy It Now purchases), the Final Value Fee is returned on a transaction-by-transaction basis in Item.SellingStatus.FinalValueFee. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.
BidItemArray.Item .SellingStatus.FinalValueFee [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .SellingStatus.LeadCount	int	Conditionally	Applicable to Ad type listings only. Indicates how many leads to potential buyers are associated with this item. Returns 0 (zero) for listings in other formats. You must be the seller of the item to retrieve the lead count.
BidItemArray.Item .SellingStatus.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., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing. 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 (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding Buy It Now purchases) require the listing status to be Completed before the Final Value Fee is returned. Dutch (multi-listing) Buy It Now auctions are Completed on a transaction-by-transaction basis, and the Final Value Fee is returned by GetSellerTransactions and GetItemTransactions. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. • 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.
BidItemArray.Item .SellingStatus.MinimumToBid	AmountType (double)	Always	Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to competitive-bid item listings (Chinese auctions). Returns null for basic Fixed Price (FixedPriceItem), Store Inventory (StoresFixedPrice), and Ad type listings. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.
BidItemArray.Item .SellingStatus.MinimumToBid [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .SellingStatus .PromotionalSaleDetails	PromotionalSaleDetailsType	Conditionally	If a seller has reduced the price of a listed item with the Promotional Price Display feature, this field contains the original price of the discounted item, along with the start-time and end-time of the discount.
BidItemArray.Item .SellingStatus .PromotionalSaleDetails .EndTime	dateTime	Conditionally	End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
BidItemArray.Item .SellingStatus .PromotionalSaleDetails .OriginalPrice	AmountType (double)	Conditionally	Original price of an item whose price a seller has reduced with the Promotional Price Display feature.
BidItemArray.Item .SellingStatus .PromotionalSaleDetails .OriginalPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .SellingStatus .PromotionalSaleDetails .StartTime	dateTime	Conditionally	Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
BidItemArray.Item .SellingStatus.QuantitySold	int	Always	For most listings, this is the total number of items purchased so far (in the listing's lifetime). (If the seller has not changed the original quantity, subtract from the value returned in Quantity to calculate the number of items still available for purchase.) If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations.
BidItemArray.Item .SellingStatus.ReserveMet	boolean	Always	Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
BidItemArray.Item .SellingStatus .SecondChanceEligible	boolean	Always	Part of the Second Chance Offer feature, indicates whether the seller can extend a second chance offer for the item.
BidItemArray.Item .ShippingDetails	ShippingDetailsType	Conditionally	The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. See: Determining Shipping Costs for a Listing Revising Items for restrictions on changing item properties with ReviseItem
BidItemArray.Item .ShippingDetails .AllowPaymentEdit	boolean	Conditionally	Instead of using this tag, see the PaymentEdited tag. Originally, the AllowPaymentEdit tag specified whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enabled this property in their My eBay user preferences on the eBay site.) ShippingDetails.AllowPaymentEdit is no longer being populated by calls to GetItemTransactions. Not applicable to Half.com.
BidItemArray.Item .ShippingDetails .ApplyShippingDiscount	boolean	Conditionally	Whether the seller specifies that a shipping discount is to be applied (in the event that an item's transaction is later combined with others into a single order). Not applicable to Half.com.
BidItemArray.Item .ShippingDetails.GetItFast	boolean	Conditionally	Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Applicable to Half.com for GetOrders.
BidItemArray.Item .ShippingDetails .InsuranceDetails	InsuranceDetailsType	Conditionally	Container for domestic insurance information. Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used. Valid only on the following sites: AU, FR, and IT
BidItemArray.Item .ShippingDetails .InsuranceDetails.InsuranceFee	AmountType (double)	Conditionally	Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders).
BidItemArray.Item .ShippingDetails .InsuranceDetails.InsuranceFee [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .ShippingDetails .InsuranceDetails .InsuranceOption	InsuranceOptionCodeType	Conditionally	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders). Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
BidItemArray.Item .ShippingDetails.InsuranceFee	AmountType (double)	Conditionally	Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request. Valid only on the following sites: AU, FR, and IT Applicable to Half.com for GetOrders. Default: 0.00.
BidItemArray.Item .ShippingDetails.InsuranceFee [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .ShippingDetails .InsuranceOption	InsuranceOptionCodeType	Conditionally	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored. Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged. This field is always returned with a request version lower than 635. With a request version of 635 or higher, this field is only returned if the value is other than NotOffered. Valid only on the following sites: AU, FR, and IT If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing. Applicable to Half.com Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
BidItemArray.Item .ShippingDetails .InternationalInsuranceDetails	InsuranceDetailsType	Conditionally	Container for international insurance information. Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used. Valid only on the following sites: AU, FR, and IT
BidItemArray.Item .ShippingDetails .InternationalInsuranceDetails .InsuranceFee	AmountType (double)	Conditionally	Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders).
BidItemArray.Item .ShippingDetails .InternationalInsuranceDetails .InsuranceFee [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .ShippingDetails .InternationalInsuranceDetails .InsuranceOption	InsuranceOptionCodeType	Conditionally	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders). Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
BidItemArray.Item .ShippingDetails .InternationalShippingServiceOption	InternationalShippingServiceOptionsType	Conditionally, repeatable: [0..*]	Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions. If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes. If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
BidItemArray.Item .ShippingDetails .InternationalShippingServiceOption .ShippingService	token	Conditionally	An international shipping service offered for shipping the item. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. See GeteBayDetails. Applicable values: See ShippingServiceCodeType
BidItemArray.Item .ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost	AmountType (double)	Conditionally	Cost of shipping each additional item beyond the first item. Should be zero for single-item listings. Default value is 0.00. For flat shipping only.
BidItemArray.Item .ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost	AmountType (double)	Conditionally	The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. See Shipping.
BidItemArray.Item .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item .ShippingDetails .InternationalShippingServiceOption .ShippingServicePriority	int	Conditionally	Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping.
BidItemArray.Item .ShippingDetails .InternationalShippingServiceOption .ShipToLocation	string	Conditionally, repeatable: [0..*]	An international location or region to where the item seller will ship the item. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. For the AddItem family of calls, this field is required if any international shipping service is specified. See ShipToLocation. Applicable values: See CountryCodeType, ShippingRegionCodeType
BidItemArray.Item .ShippingDetails .PaymentInstructions	string	Conditionally	Payment instructions (or message) from the seller to the buyer. These instructions appear on eBay's View Item page and on eBay's checkout page when the buyer pays for the item. Sellers usually use this field to specify payment instructions, how soon the item will shipped, feedback instructions, and other reminders that the buyer should be aware of when they bid on or buy an item. This field can be specified regardless of the shipping type eBay only allows 500 characters as input, but due to the way the eBay Web site UI treats characters, this field can return more than 500 characters in the response. Characters like & and ' (apostrophe/single quote) count as 5 characters each. Use DeletedField to remove this value when revising or relisting an item. Applicable to eBay Motors (usually used to elaborate on the return policy). Not applicable to Half.com. Max length: 1000. See: Offering a Clear Return Policy (AddItem) Item.AttributeSetArray (GetItem) Item.AttributeSetArray
BidItemArray.Item .ShippingDetails.SalesTax	SalesTaxType	Conditionally	Sales tax details. US site only. Flat and calculated shipping. Not applicable to eBay Motors vehicle listings. Applicable to Half.com (for GetOrders). See Enabling Multi-jurisdiction Sales Tax.
BidItemArray.Item .ShippingDetails.SalesTax .SalesTaxPercent	float	Conditionally	Percent of an item's price to be charged as the sales tax for the transaction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). Applicable to Half.com (for GetOrders).
BidItemArray.Item .ShippingDetails.SalesTax .SalesTaxState	string	Conditionally	State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. Applicable to Half.com (for GetOrders).
BidItemArray.Item .ShippingDetails.SalesTax .ShippingIncludedInTax	boolean	Conditionally	(US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Applicable to Half.com (for GetOrders).
BidItemArray.Item .ShippingDetails .SellerExcludeShipToLocationsPreference	boolean	Conditionally	Sellers can set up a global Exclude Ship-To List through their My eBay account. The Exclude Ship-To List defines the countries to where the seller does not ship, by default. This flag returns true if the Exclude Ship-To List is enabled by the seller for the associated item. If false, the seller's Exclude Ship-To List is either not set up, or it has been overridden by the seller when they listed the item with ExcludeShipToLocation fields. In the response, ExcludeShipToLocation fields detail the locations to where the seller will not ship the item, regardless of the value returned in this field.
BidItemArray.Item .ShippingDetails.ShippingType	ShippingTypeCodeType	Conditionally	The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • Freight (out) Freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code). Currently, Freight can only be specified on input via eBay Web site, not API. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. See "Specifying Freight Shipping" in the Shipping chapter for details on freight shipping. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.)
BidItemArray.Item .ShippingDetails.TaxTable	TaxTableType	Conditionally	Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned. For GetItem, a tax table is returned if it exists when: - DetailLevel is set to ReturnAll or ItemReturnDescription (in this case, the value of IncludeTaxTable does not matter). - IncludeTaxTable is set to true and DetailLevel is not set or it is set to ItemReturnAttributes. Not applicable to Half.com.
BidItemArray.Item .ShippingDetails.TaxTable .TaxJurisdiction	TaxJurisdictionType	Conditionally, repeatable: [0..*]	Sales tax details for zero or more jurisdictions (states, provinces, etc). For GetTaxTable: If DetailLevel is not specified, information is returned only for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned, but are empty.
BidItemArray.Item .ShippingDetails.TaxTable .TaxJurisdiction .JurisdictionID	string	Conditionally	Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California).
BidItemArray.Item .ShippingDetails.TaxTable .TaxJurisdiction .SalesTaxPercent	float	Conditionally	The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). For GetTaxTable: this tag has no value if the user's tax table has not been set.
BidItemArray.Item .ShippingDetails.TaxTable .TaxJurisdiction .ShippingIncludedInTax	boolean	Conditionally	Whether shipping costs are to be part of the base amount that is taxed. For GetTaxTable: This tag is empty if the user did not previously provide information.
BidItemArray.Item .ShippingDetails .ThirdPartyCheckout	boolean	Conditionally	Whether checkout for this is to be handled by a Third-Party Checkout application. The counterpart in the AddItem family of calls is Item.ThirdPartyCheckout. Not applicable to Half.com. See: Third Party Checkout (AddItem) Item.ThirdPartyCheckout
BidItemArray.Item .ShippingTermsInDescription	boolean	Conditionally	Indicates whether details about shipping costs and arrangements are specified in the item description. Not applicable to Half.com. See Search Results and Shipping Costs.
BidItemArray.Item .ShipToLocations	string	Always, repeatable: [1..*]	An international location or region to which the seller is willing to ship, regardless of shipping service. The country of the listing site is added by eBay. Use GeteBayDetails with a DetailName of ShippingLocationDetails to determine which international locations are valid for the site. Omit ShipToLocations if you want to ship only within the country of the listing site. To state that you do not wish to ship at all, set ShipToLocations to None. ReviseItem can add a ShipToLocations. On output, ShipToLocations is the collection of all input item-level ShipToLocations plus international shipping service-level ShipToLocation values. If you have specified a region to which you will ship (such as Asia), you can use ExcludeShipToLocation to exclude certain countries within that region to where you will not ship (such as Afghanistan). Not applicable to Half.com. Max length: length of longest name in ShippingRegionCodeType and CountryCodeType. See: ShipToLocation GeteBayDetails Applicable values: See CountryCodeType, ShippingRegionCodeType
BidItemArray.Item.Site	SiteCodeType	Always	The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing. When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API). Not applicable to Half.com. Applicable values: See Site. See: The US and International eBay Sites Specifying the Target Site Field Differences for eBay Sites
BidItemArray.Item.SKU	SKUType (string)	Conditionally	A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.
BidItemArray.Item.StartPrice	AmountType (double)	Always	The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items--it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.
BidItemArray.Item.StartPrice [ attribute currencyID ]	CurrencyCodeType	Conditionally	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.
BidItemArray.Item.Storefront	StorefrontType	Conditionally	Contains information related to the item in the context of a seller's eBay Store. Applicable for auction formats, Basic Fixed Price, and Store Inventory format items listed by eBay Stores sellers. Not applicable to Half.com.
BidItemArray.Item.Storefront .StoreCategory2ID	long	Conditionally	Applicable for eBay Store sellers only. Numeric ID for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other"). If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the seondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.
BidItemArray.Item.Storefront .StoreCategoryID	long	Conditionally	Numeric ID for a custom category that the seller created in their eBay Store, if any. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in store categories that have no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the Other store category. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.
BidItemArray.Item.Storefront .StoreURL	anyURI	Conditionally	The URL of the seller's eBay Store page. GetProducts only returned a default URL at the time of this writing.
BidItemArray.Item.SubTitle	string	Conditionally	Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees). Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle. When you revise a item, you can add, change, or remove the subtitle. Not applicable to Half.com. Max length: 55. See: Removing a Field When Relisting an Item (RelistItem) DeletedField Valid Item Specifics for Listing eBay Motors US Cars & Trucks Specifying a Subtitle for a Motors Vehicle Listing
BidItemArray.Item .ThirdPartyCheckoutIntegration	boolean	Conditionally	Only authorized Third-Party Checkout providers can use this flag. If you are a seller, subscribe to Checkout notifications through a supporting application. Set this flag to true to enable Checkout notifications for a particular listing. IMPORTANT: If you are not authorized to support Third Party Checkout and your application is not the original listing application, never specify ThirdPartyCheckout or ThirdPartyCheckoutIntegration in your request (even if you revise a listing that already includes these flags). Otherwise you may get unexpected results. Returned only if true for a listing. Not applicable to Half.com. See Working with Platform Notifications.
BidItemArray.Item.TimeLeft	duration	Always	Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
BidItemArray.Item.Title	string	Always	Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55.
BidItemArray.Item.UUID	UUIDType (string)	Conditionally	Universally unique constraint tag. Use UUID to ensure that you only list a particular item once, particularly if you are listing many items at once. If you add an item and do not get a response, resend the request with the same UUID. If the item was successfully listed the first time, you will receive an error message for trying to use a UUID that you have already used. The error will also include the item ID for the duplicated item and a boolean value indicating whether the duplicate UUID was sent by the same application. We recommend you use Item.UUID with calls that add item objects (for example, AddItem and RelistItem). For calls that modify an existing item, such as ReviseItem, use InvocationID instead. The UUID can only contain digits from 0-9 and letters from A-F and must be 32 characters long. The UUID value must be unique across all item listings on all sites. Also applicable as input to AddItem and related calls when you list items to Half.com. Max length: 32.
BidItemArray.Item.VATDetails	VATDetailsType	Conditionally	Container for eBay's VAT features. A business seller can choose to offer an item exclusively to bidders and buyers that also represent businesses. Only applicable when the item is listed in a B2B-enabled category (on a site that supports B2B business features). Note: The India site (Global ID 203) does not accept VAT values in item listings. If you submit an item to the India site with a VAT value, eBay generates a warning message that indicates the listing was accepted, but the VAT value was removed. To include the VAT, relist the item with a Price value that includes the VAT. Sellers are solely responsible for compliance relating to tax legislation in India. Not applicable to Half.com. See: Working with Business Features and VAT Business Feature Field Differences
BidItemArray.Item.VATDetails .RestrictedToBusiness	boolean	Conditionally	If true, this indicates that the seller elects to offer the item exclusively to business users. If false (or not returned), this indicates that the seller elects to offer the item to all users. Applicable only to business sellers residing in Germany, Austria, or Switzerland who are listing in a B2B VAT-enabled category on the eBay Germany (DE), Austria (AT), or Switzerland (CH) sites. If this argument is true, the seller must have a valid VAT-ID registered with eBay, and BusinessSeller must also be true.
BidItemArray.Item.VATDetails .VATPercent	float	Conditionally	VAT rate for the item, if any. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346.) Note: The View Item page may display the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Min: 0. Max: 30.

GetBidderList Detail Controls

Detail Control: DetailLevel

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

Detail Control: GranularityLevel

This is a work in progress.

The GranularityLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of GranularityLevel.)

The none column indicates the fields that are returned when you do not specify a GranularityLevel.

Y	The field is always returned.
(Y)	The field is conditionally returned. See the field description for clarification of conditions.
-	The field is not returned.

Output Field	Fine	Medium
BidItemArray.Item.ReturnPolicy	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.Description	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.EAN	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.Refund	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.RefundOption	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.ReturnsAccepted	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.ReturnsAcceptedOption	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.ReturnsWithin	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.ReturnsWithinOption	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.ShippingCostPaidBy	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.ShippingCostPaidByOption	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.WarrantyDuration	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.WarrantyDurationOption	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.WarrantyOffered	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.WarrantyOfferedOption	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.WarrantyType	(Y)	(Y)
BidItemArray.Item.ReturnPolicy.WarrantyTypeOption	(Y)	(Y)

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

GetBidderList Change History

Version	Description
635 2009-09-16	ExcludeShipToLocation, SellerExcludeShipToLocationsPreference (added): Sellers can now exclude specific regions and countries from where they will ship items. InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites: `BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US` Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
629 2009-08-05	TopRatedSeller (added): Returned when seller is a Top-Rated Seller.
605 2009-02-18	NowAndNew (deprecated): Now & New (Sofort & Neu) has been retired as of this release.
599 2009-1-07	NowAndNew (doc change): eBay will retire Now & New (Sofort & Neu) by March 2009.
581 2008-09-03	ItemArray.Item.ReturnPolicy (added): Specifies the seller's return policy.
573 2008-07-09	BidArray.Offer.User.Email (modified): Starting in September 2008, email tag in the User container will be made anonymous. BidItemArray.Item.DigitalDeliveryDetails (deprecated): The digital delivery feature is disabled as of March 28, 2008. Digitally delivered items must be listed in the Classified Ad Format in the Everything Else>Information Products category only. Information specific to digital delivery listings is no longer returned.
563 2008-04-30	Item.BuyerGuaranteePrice (added): On the Australia site, by early June 2008, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section. BuyerProtection.NoCoverage (added): On the Australia site, by early June 2008, indicates that there is no PayPal Buyer Protection coverage.
561 2008-04-16	Item.ListingType.Express (deprecated): Due to the shutdown of UK and Germany eBay Express sites Item.ListingType.Express has been deprecated.
559 2008-04-02	Item.PictureDetails.PhotoDisplay.SuperSizePictureShow (modified): This value is no longer applicable. Returns SuperSize instead. Item.PictureDetails.PhotoDisplay.SiteHostedPictureShow, Item.PictureDetails.PhotoDisplay.VendorHostedPictureShow (modified): These values are no longer applicable. Returns None instead.
555 2008-03-05	GetBidderListRequestType (modified): 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.
537 2007-10-31	BidItemArray.Item.PaymentMethods.PaisaPayEscrow, BidItemArray.Item.PaymentMethods.PaisaPayEscrowEMI (added): These enum will be returned for items offering PaisaPayEscrow and PaisaPayEscrowEMI payment methods.
521 2007-07-11	Item.FinanceOfferID (deprecated): Finance-offer functionality has been deprecated with this version.
503 2007-03-07	SellerType.SafePaymentExcempt (added): This field indicates whether a seller is exempt from providing a safe payment method. If a seller is exempt, any safe payment restrictions for a site or a category do not apply.
499 2007-02-07	AnythingPoints, ProximitySearchDetails.PostalCode, ShippingDetails.AllowPaymentEdit, ShippingDetails.SellerPostalCode, SiteHostedPicture, SkypeOption, VendorHostedPicture (modified): Deleted previously deprecated objects from the latest schema. Some of these objects are still supported with lower request versions. See Deprecated Objects. BidItemArray.Item.Storefront.StoreCategory2ID, BidItemArray.Item.Storefront.StoreCategoryID (modified): The data types for IDs used for eBay Stores have changed from xs:int to xs:long to prepare for future increases in ID values. ExtendedSellerContactDetails (added): Returns seller contact details.
497 2007-01-24	BidItemArray.Item.SellingStatus.PromotionalSaleDetails (added): If a seller has reduced the price of a listed item with the Promotional Price Display feature, this field contains the original price of the discounted item, along with the start-time and end-time of the discount.
491 2006-12-13	Item.ListingDetails.ViewItemURLForNaturalSearch (added): A variation of ViewItemURL optimized for popular search engines. 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. Item.ShippingDetails.PaymentInstructions (doc change): PaymentInstructions can return values longer than 500 characters, and that it can be used without other shipping details (e.g., for eBay Motors vehicles). Various (doc change): Moved the SellerInfo container into a Seller container within the Item container. Documentation correction of removing the following fields: Item.Description, Seller.PositiveFeedbackPercent, Seller.SiteVerified, Seller.UniqueNegativeFeedbackCount, Seller.UniquePositiveFeedbackCount, SellerInfo.PaisaPayStatus, SellerInfo.SellerBusinessType, SellerInfo.SellerGuaranteeLevel
483 2006-10-18	Item.AnythingPoints (deprecated): No longer returned as of request version 483. Item.ProximitySearchDetails (deprecated): No longer returned as of request version 483. Use Item.PostalCode instead. Item.ShippingDetails.SellerPostalCode (deprecated): No longer returned as of request version 483. Use Item.PostalCode instead.
477 2006-09-06	PromotionSchemeCodeType.RelatedCategoryRule (added): New output to identify Related Category as the scheme used for promoting items. ListingType (modified): Chinese auction listings with Buy It Now are eligible for Express US. (various) (modified): See GetItem changes related to shipping. See the Shipping documentation for details.
465 2006-06-14	BidItemArray.Item.ListingDetails.ExpressListing (added): Indicates if the item is qualified for the eBay Express site associated with the listing site. BidItemArray.Item.ListingDetails.TCROriginalItemID (added): Indicates the item ID of the original item listing from which a Transaction Confirmation Request (TCR) was created.
453 2006-03-22	MaximumItemRequirements (added): Indicates whether blocking is enabled to prevent bidding by unpaying or low-feedback bidders.
455 2006-5-5	Item.ThirdPartyCheckoutIntegration (added): Used by third party checkout providers to opt an item into eBay Express (and thus approve handling of checkout by eBay Express).
453 2006-3-22	Item.BuyerRequirements and Item.DisableBuyerRequirements (added): Buyer requirements can now be specified per listing (and not just via My eBay). Buyer requirements can also be updated on active listings, applying only to subsequent bids.
439 2005-12-14	Item.PictureDetails (added): SiteHostedPicture and VendorHostedPicture contain data for pictures associated with an item. With compatibility level 439 and higher, that data will be returned in PictureDetails instead, regardless of the input.
427 2005-09-21	Item.SellingStatus.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.

This document was generated with a customized version of the apireferencedocs tool.

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.

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	Optional, repeatable: [0..*]	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.

eBay Trading API Call Reference Version 643

eBay Trading API
Call Reference Version 643