eBay Trading API893

GetBidderList

Use this call to retrieve all items on which a user is currently bidding, and the ones that they have won or purchased.

By default, GetBidderList returns bid information pertaining to the authorized caller. However, you can specify a UserID to indicate that you want to return information for a different user.

Usage Details

There are several mechanisms that you can use to control the output of your GetBidderList calls. To limit the items returned to a specific time range, use the EndTimeFrom and EndTimeTo filters. You can also limit the items returned to the user's active listings by setting ActiveItemsOnly to true.

To give you control over the fields returned, GetBidderList supports the GranularityLevel input field, which accepts values of either Fine or Medium. Setting GranularityLevel to Medium returns the fewest number of output fields, while setting it to Fine produces the most robust output. For information about the GranularityLevel field, see Specifying Detail Levels and Granularity Levels.

GetBidderList returns a maximum of 200 items when all of the available fields are returned. You can reduce the number of fields returned by specifying a Medium GranularityLevel. Setting GranularityLevel to Fine adds the Email field, as well as the ListingDesigner and TaxTable nodes to the response.

Because the call returns items won by the specified user, it is possible for the call to return a Bidcount of 0. This indicates an item purchased with Buy It Now, or the purchase of a fixed-price item.

Item details do not change very often. If you are going to retrieve information for a bidder more than once, do not retrieve the item details in subsequent calls. If the bidder has bid on items whose details were not retrieved in the initial call, your application should use GetItem to retrieve item details.

Testing GetBidderList

You can test GetBidderList in the Sandbox. When testing, make a call with no additional input fields. This returns items for the user authenticated by the call. Next, try calling GetBidderList with UserID set to an eBay store owner to see how the call returns information for different users.

Related Information

See also the reference documentation for these calls:



Back to top

GetBidderList Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype 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"?>
<GetBidderListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ActiveItemsOnly> boolean </ActiveItemsOnly>
  <EndTimeFrom> dateTime </EndTimeFrom>
  <EndTimeTo> dateTime </EndTimeTo>
  <GranularityLevel> GranularityLevelCodeType </GranularityLevel>
  <UserID> UserIDType (string) </UserID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector values allowed here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetBidderListRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
ActiveItemsOnly boolean Optional Indicates whether or not 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), both active and ended items are returned.
EndTimeFrom dateTime Conditional Used in conjunction with EndTimeTo. 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 Used in conjunction with EndTimeFrom. 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. Note that for GTC items, whose end times automatically increment by 30 days every 30 days, an EndTimeTo within in the first 30 days of a listing will refer to the listing's initial end time.
GranularityLevel GranularityLevelCodeType Optional You can control some of the fields returned in the response by specifying one of two values in the GranularityLevel field: Fine or Medium. Fine returns more fields than the default, while setting this field to Medium returns an abbreviated set of results.

Applicable values:

Coarse
(in) For each record in the response, retrieves less data than Medium. See the eBay Features 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 Features 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 Features 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.
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector string Optional,
repeatable: [0..*]
You can use the OutputSelector field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the fields you specified in the request. For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as 'ViewItemURL' and 'BuyItNowPrice' as in the following example:

 ...
<OutputSelector>ViewItemURL</OutputSelector>
<OutputSelector>BuyItNowPrice</OutputSelector>

...

See Selecting Fields to Retrieve.

Version string Conditional The version number of the API code that you are programming against (e.g., 859). 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:
    Routing the Request (Gateway URLs)
    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 performed in the Production environment.

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.



Back to top

GetBidderList Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

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

<?xml version="1.0" encoding="utf-8"?>
<GetBidderListResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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>
      <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 values allowed 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 values allowed here ... -->
      <ListingType> ListingTypeCodeType </ListingType>
      <Location> string </Location>
      <LocationDefaulted> boolean </LocationDefaulted>
      <LotSize> int </LotSize>
      <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
      <PaymentDetails> PaymentDetailsType
        <DaysToFullPayment> int </DaysToFullPayment>
        <DepositAmount currencyID="CurrencyCodeType"> AmountType (double) </DepositAmount>
        <DepositType> DepositTypeCodeType </DepositType>
        <HoursToDeposit> int </HoursToDeposit>
      </PaymentDetails>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods values allowed here ... -->
      <PayPalEmailAddress> string </PayPalEmailAddress>
      <PictureDetails> PictureDetailsType
        <GalleryURL> anyURI </GalleryURL>
        <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
        <PictureURL> anyURI </PictureURL>
        <!-- ... more PictureURL values allowed here ... -->
      </PictureDetails>
      <PostalCode> string </PostalCode>
      <PrimaryCategory> CategoryType
        <CategoryID> string </CategoryID>
        <CategoryName> string </CategoryName>
      </PrimaryCategory>
      <PrivateListing> boolean </PrivateListing>
      <ProductListingDetails> ProductListingDetailsType
        <Copyright> string </Copyright>
        <!-- ... more Copyright values allowed 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>
        <RestockingFeeValue> token </RestockingFeeValue>
        <RestockingFeeValueOption> token </RestockingFeeValueOption>
        <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 (token) </MerchandizingPref>
          <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
          <SafePaymentExempt> boolean </SafePaymentExempt>
          <SellereBayPaymentProcessConsent> SellereBayPaymentProcessConsentCodeType
            <PayoutMethod> PayoutMethodType </PayoutMethod>
            <PayoutMethodSet> boolean </PayoutMethodSet>
            <UserAgreementInfo> UserAgreementInfoType
              <AcceptedTime> dateTime </AcceptedTime>
              <SellereBayPaymentProcessEnableTime> dateTime </SellereBayPaymentProcessEnableTime>
              <SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
              <Site> SiteCodeType </Site>
              <UserAgreementURL> anyURI </UserAgreementURL>
            </UserAgreementInfo>
            <!-- ... more UserAgreementInfo nodes allowed here ... -->
          </SellereBayPaymentProcessConsent>
          <SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
          <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>
        <HighBidder> 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>
          <Site> SiteCodeType </Site>
          <Status> UserStatusCodeType </Status>
          <UserID> UserIDType (string) </UserID>
          <UserIDChanged> boolean </UserIDChanged>
          <UserIDLastChanged> dateTime </UserIDLastChanged>
          <VATStatus> VATStatusCodeType </VATStatus>
        </HighBidder>
        <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>
        <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 values allowed here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes allowed 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 allowed here ... -->
        </TaxTable>
      </ShippingDetails>
      <ShippingTermsInDescription> boolean </ShippingTermsInDescription>
      <ShipToLocations> string </ShipToLocations>
      <!-- ... more ShipToLocations values allowed 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>
      <TimeLeft> duration </TimeLeft>
      <Title> string </Title>
      <UUID> UUIDType (string) </UUID>
      <VATDetails> VATDetailsType
        <RestrictedToBusiness> boolean </RestrictedToBusiness>
        <VATPercent> float </VATPercent>
      </VATDetails>
    </Item>
    <!-- ... more Item nodes allowed here ... -->
  </BidItemArray>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetBidderListResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard 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 shipping address of the buyer. 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: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .
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 two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

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).
Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .
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.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .
Bidder.BuyerInfo
  .ShippingAddress.PostalCode
string Conditionally User's postal code.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .
Bidder.BuyerInfo
  .ShippingAddress
  .StateOrProvince
string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. .
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: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .
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: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .
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. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

For the order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

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.

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 either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned.

GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling.

Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned.

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 needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
CreditCardVerifyHalfOptIn
(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
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. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
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, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID can change for each auction.

For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

For PlaceOffer, see also SellingStatus.HighBidder.

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 Value-Added Tax (VAT).

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 an order 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.AutoPay boolean Always To create a requirement that a buyer pays immediately (through PayPal or PaisaPay) for an auction (Buy It Now only) or fixed-price item, the seller can include and set the AutoPay field to 'true' for an Add/Revise/Relist API call. If the seller does not want to create an immediate payment item, this field is either omitted, or included and set to 'false'.

If this feature is enabled for a listing, the buyer must pay immediately for the item through PayPal or PaisaPay (India site only), and the buyer's funds are transferred instantly to the seller's PayPal or PaisaPay account. The seller's item will remain available for purchase by other buyers until the buyer actually completes the payment.

In order for a seller to apply an immediate payment requirement for an item, the following must be true:
  • seller must have a Premier or Business PayPal account (or PaisaPay for India sellers);
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal (or PaisaPay for India site) payments;
  • the category supports PayPal (or PaisaPay for India site) payments;
  • the listing type is fixed-price or auction (with Buy It Now option).
To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:
  • seller must provide a valid Item.PayPalEmailAddress value (not required for India site);
  • seller must offer PayPal as the only payment method, or for the India site, one or more of the three supported PaisaPay payment methods;
  • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
  • seller must include and set the PromotionalShippingDiscount field to true if a promotional shipping discount is being applied to the listing;
  • seller must include the ShippingDiscountProfileID and reference a valid flat or calculated Shipping Discount Profile ID if a flat or calculated shipping rule is being applied to the listing.
In the Trading API calls that return the AutoPay field, be aware that the field's appearance in the output does not necessarily indicate that the immediate payment feature was successfully enabled/used for the active or ended listing, but only that the seller attempted to enable (by including and setting AutoPay to 'true' in the request) the immediate payment feature for the listing.
To discover if a category supports immediate payment for an item, use GetCategories and look for the appearance of the AutoPayEnabled boolean field in the output for that category (identified by CategoryID). AutoPayEnabled is returned as an empty element if the category supports immediate payment, and is not returned at all if the category does not support immediate payment.

Not applicable to Half.com.

See:
    Specifying a Payment Method
    Requiring Immediate Payment of a Vehicle Deposit

BidItemArray.Item
  .BestOfferDetails
BestOfferDetailsType Conditionally For Add/Revise/Relist/Verify calls: This container is used to enable the Best Offer feature on a listing. The Best Offer feature is not available for auction listings.

For GetItem and other calls that retrieve item data, this container will include the status (GetMyeBayBuying only) and dollar amount of the latest Best Offer on a fixed-price listing, and the number of Best Offers received for the fixed-price listing.

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 Best Offers made, this container will not appear in the response.
BidItemArray.Item
  .BestOfferDetails
  .BestOfferEnabled
boolean Conditionally This field indicates whether or not the Best Offer feature is enabled for this item. A seller of a fixed-price 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.

As long as a fixed-price listing has no Best Offer transaction completed or pending, or is not scheduled to end within 12 hours, a seller can change this value (enable or disable).

Note: Some large merchant accounts are enabled to revise this field through a Revise call even within 12 hours of the listing's scheduled end time. The exception to this rule is that Best Offers can not be disabled if the listing has any completed or pending Best Offers.
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 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.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item
  .BuyerProtection
BuyerProtectionCodeType Conditionally Flag to indicate an item's eligibility for the PayPal Purchase Protection program. This field is only returned if 'true'. If this field is not returned, the item is not eligible for PayPal Purchase Protection. For more information on items that are eligible for PayPal Purchase Protection, see the PayPal Purchase Protection help page.

Not applicable to Half.com.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
ItemEligible
(out) This value indicates that the item is eligible for buyer protection.
ItemIneligible
(out) This value indicates that the item is ineligible for buyer protection. In many cases, the item is ineligible for buyer protection due to the category it is listed under.
ItemMarkedEligible
(out) This value indicates that the eBay customer support has marked the item as eligible per special criteria.
ItemMarkedIneligible
(out) This value indicates that the eBay customer support has marked the item as ineligible per special criteria (e.g., seller's account closed).
NoCoverage
(out) This value indicates that the item is ineligible for coverage under any buyer protection program.

See Miscellaneous Item Field Differences.

BidItemArray.Item
  .BuyerRequirementDetails
BuyerRequirementDetailsType Conditionally When this container is present in an AddItem or AddFixedPriceItem 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. All global My eBay Buyer Requirements are overridden by the contents of this container. This means that buyer requirements set in My eBay cannot be combined with buyer requirements included in this container.

Not applicable to Half.com.

See Selecting Buyer Requirements (eBay Web site help).

BidItemArray.Item
  .BuyerRequirementDetails
  .LinkedPayPalAccount
boolean Conditionally The seller includes and sets this field to 'true' as a mechanism to block bidders who do not have a PayPal account linked to their eBay account.
Default: false.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
MaximumBuyerPolicyViolationsType Conditionally The seller uses this container as a mechanism to block prospective buyers who have one or more buyer policy violations on their account during a specified time period.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .Count
int Conditionally This integer value sets the maximum number of buyer policy violations that a prospective buyer is allowed to have during a specified time period (MaximumBuyerPolicyViolations.Period) before being blocked from buying/bidding on the item.

To retrieve a list of allowed values for this field, the seller should call GeteBayDetails, including BuyerRequirementDetails in the DetailName field of the request, and then look for the BuyerRequirementDetails.MaximumBuyerPolicyViolations.NumberOfPolicyViolations.Count fields in the response.
Default: 4.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .Period
PeriodCodeType Conditionally This enumerated value defines the length of time over which a prospective buyer's buyer policy violations will be counted. If the prospective buyer's number of buyer policy violations during this defined period exceeds the value set in the Count field, that prospective buyer is blocked from buying/bidding on the item.

If the Count value is 2, and the specified Period is 'Days_30' (counting back 30 days from the present day), any prospective buyer that has had three or more buyer policy violations is blocked from buying/bidding on the item.
Default: Days_30.

Applicable values:

Days_180
(in/out) This value indicates that the evaluation period is set back 180 days from the present date.
Days_30
(in/out) This value indicates that the evaluation period is set back 30 days from the present date.

(Not all values in PeriodCodeType apply to this field.)
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
MaximumItemRequirementsType Conditionally The seller uses this container as a mechanism to restrict the number of items (specifying a MaximumItemCount value) a prospective buyer can purchase from the seller during a 10-day period. The seller also has the option of setting a MinimumFeedbackScore requirement. If both fields of the MaximumItemRequirements container are set, the MaximumItemCount limit will only apply to those prospective buyers that don't equal or exceed the specified minimum Feedback Score.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
  .MaximumItemCount
int Conditionally This field is conditionally required if the MaximumItemRequirements container is used.

The value of this field specifies the maximum number of items a prospective buyer can purchase from the seller during a 10-day period. The prospective buyer will be blocked from bidding/buying once this value is reached. To see the valid values for your site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.MaximumItemRequirements.MaximumItemCount fields. As of Jan. 2013, the valid values for the US site are: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 25, 50, and 75.

If the MaximumItemRequirements.MinimumFeedbackScore field is also specified, the MaximumItemCount limit will only apply to those prospective buyers who don't meet the specified Minimum Feedback Score threshold.

See Buyers Who May Bid on Several of My Items and Not Pay.

BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
  .MinimumFeedbackScore
int Conditionally This is an optional field that is ignored if a MaximumItemCount value has not been provided.

If this field is used, a prospective buyer is blocked from bidding/buying if they have reached or exceeded the MaximumItemCount and their feedback score is less than the value of this field. To see the valid values for your site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.MaximumItemRequirements.MinimumFeedbackScore fields. Currently, the valid values for the US site are: 0, 1, 2, 3, 4, and 5.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
MaximumUnpaidItemStrikesInfoType Conditionally The seller uses this container as a mechanism to block prospective buyers who have one or more unpaid item strikes on their account during a specified time period.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .Count
int Conditionally This integer value sets the maximum number of unpaid item strikes that a prospective buyer is allowed to have during a specified time period (MaximumUnpaidItemStrikesInfo.Period) before being blocked from buying/bidding on the item.

To retrieve a list of allowed values for this field, the seller should call GeteBayDetails, including BuyerRequirementDetails in the DetailName field of the request, and then look for the BuyerRequirementDetails.MaximumUnpaidItemStrikesInfo.MaximumUnpaidItemStrikesCount.Count fields in the response.
Default: 2.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .Period
PeriodCodeType Conditionally This enumerated value defines the length of time over which a prospective buyer's unpaid item strikes will be counted. If the prospective buyer's number of unpaid item strikes during this defined period exceeds the value set in the Count field, that prospective buyer is blocked from buying/bidding on the item.

If the Count value is 2, and the specified Period is 'Days_30' (counting back 30 days from the present day), any prospective buyer that has had three or more unpaid item strikes is blocked from buying/bidding on the item.
Default: Days_30.

Applicable values:

Days_180
(in/out) This value indicates that the evaluation period is set back 180 days from the present date.
Days_30
(in/out) This value indicates that the evaluation period is set back 30 days from the present date.
Days_360
(in/out) This value indicates that the evaluation period is set back 360 days from the present date.

(Not all values in PeriodCodeType apply to this field.)
BidItemArray.Item
  .BuyerRequirementDetails
  .MinimumFeedbackScore
int Conditionally The seller includes this field as a mechanism to block bidders who have a Feedback Score less than the specified value. To obtain the list of supported values, call GeteBayDetails, include BuyerRequirementDetails as a DetailName value in the request, and then look for the list of Minimum Feedback Score values returned under the MinimumFeedbackScore container in the response. Currently, the valid values for the US site are -3, -2, and -1.
BidItemArray.Item
  .BuyerRequirementDetails
  .ShipToRegistrationCountry
boolean Conditionally The seller includes and sets this field to 'true' as a mechanism to block bidders who reside (according to their eBay primary shipping address) in countries that are on the ship-to exclusion list. Sellers add countries or regions to their ship-to exclusion list by adding those countries or regions using one or more ExcludeShipToLocation fields in an Add/Revise/Relist call.
Default: false.
BidItemArray.Item
  .BuyerRequirementDetails
  .VerifiedUserRequirements
VerifiedUserRequirementsType Conditionally The seller uses this container as a mechanism to block prospective buyers who are not verified users on PayPal, or in the case of eBay India, not verified users on PaisaPay.

The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.VerifiedUserRequirements container.
BidItemArray.Item
  .BuyerRequirementDetails
  .VerifiedUserRequirements
  .MinimumFeedbackScore
int Conditionally This field is ignored unless the VerifiedUser field is included and set to 'true'.

The seller includes this field as a mechanism to block verified users who have a feedback score less than the specified value.

The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.VerifiedUserRequirements container. The valid MinimumFeedbackScore values will be seen in the BuyerRequirementDetails.VerifiedUserRequirements.FeedbackScore fields.
Default: 5.
BidItemArray.Item
  .BuyerRequirementDetails
  .VerifiedUserRequirements
  .VerifiedUser
boolean Conditionally To block non-verified users from buying/bidding on their items, the seller should include this field and set its value to 'true'.

The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.VerifiedUserRequirements container.
Default: false.

See Field Differences for eBay Sites.

BidItemArray.Item
  .BuyerRequirementDetails
  .ZeroFeedbackScore
boolean Conditionally This Buyer Requirements feature is only available to sellers on the China site, and is only applicable to fixed-price or auction Buy It Now items.

The seller includes and sets this field to 'true' as a mechanism to block prospective buyers with a feedback score of 0 from buying items with a price of 100 RMB or higher.
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 auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an 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 still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

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:
    Seller Limits
    GeteBayDetails
    Revising US eBay Motors Listings

BidItemArray.Item
  .BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an 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 still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

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.

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.

When you relist an item, use DeletedField to remove charity information.

Not applicable to Half.com.

See:
    Miscellaneous Item Field Differences
    Working with 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 identifier assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. This value can contain up to 10 digits. This value is superseded by CharityID.
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 Defines the 2-letter country code set.

To see the list of currently supported country codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call GeteBayDetails with DetailName set to CountryDetails, and then look for CountryDetails.Country fields in the response.

Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list. (Additional codes appear at the end of this code list and are noted as non-ISO.)

Also applicable as input to AddItem and related calls when you list items to Half.com (specify 'US').

Applicable values: See Country.

See GeteBayDetails.

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

To see the list of currently supported currency codes, call GeteBayDetails with DetailName set to CurrencyDetails, and then look for the CurrencyDetails.Currency fields in the response.

Applicable values: See Currency.

See:
    GeteBayDetails
    Field Differences for eBay Sites

BidItemArray.Item
  .DisableBuyerRequirements
boolean Conditionally If true: all buyer requirements (from Item.BuyerRequirementDetails or Buyer requirements preferences in My eBay) are ignored.

If false (or omitted): Item.BuyerRequirementDetails or Buyer requirements preferences are used, with Item.BuyerRequirementDetails having the higher precedence.
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 field to a positive integer value indicating the number of days. For a list of allowed values on each eBay site, use GeteBayDetails with DetailName set to DispatchTimeMaxDetails. (Typical values are 0, 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 when it is freight shipping. For example, when ShippingService=Pickup or ShipToLocations=None, then DispatchTimeMax is not required.

A DispatchTimeMax value of 0 indicates same day handling for an item. In this case, the seller's shipping commitment depends on the order cut off time set in the seller's user preferences. This defaults to 2:00 PM local time on most sites, which can be overridden by using SetUserPreferences to set DispatchCutoffTimePreference.CutoffTime for the eBay site on which the item is listed. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays).

Note: If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. With Add, Relist, Revise and Verify calls, if you wish to indicate that a listing with flat or calculated shipping has no handling time commitment, submit Item.DispatchTimeMax as an empty field.

To add Get It Fast to listings (for domestic shipping), in addition to setting GetItFast to true, DispatchTimeMax must be set to 0 or 1 and the seller must specify at least one qualifying expedited shipping service.

Note: To receive a Top-Rated Plus seal for their listing, Top-Rated Sellers must offer same day or 1-day handling (DispatchTimeMax=0 or DispatchTimeMax=1) and accept returns (ReturnPolicy.ReturnsAcceptedOption=ReturnsAccepted). Top-Rated listings qualify for the greatest average boost in Best Match and the 20 percent Final Value Fee discount. For more information on changes to eBay's Top-rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page. 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:
    GeteBayDetails
    (GetCategoryFeatures) SiteDefaults.HandlingTimeEnabled
    Same Day Handling

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 GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is also required if a Secondary Category is used.
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 committed to the GetItFast shipping rules for this listing. If the GetItFast field is set to true, and the seller's first priority domestic shipping service (the service that has the ShippingServicePriority field set to 1) is an expedited shipping service, then every shipping service offered for this listing is considered a GetItFast service. Therefore, the seller commits to delivering the item to the buyer-selected shipping service within one day.
Not applicable to Half.com.

See:
    Enabling Multi-Jurisdiction Sales Tax
    Miscellaneous Item Field Differences

BidItemArray.Item.GiftIcon int Always If turned on at listing time, this flag allows the seller to offer one or more gift services to buyers, and a generic gift icon displays next to the listing's title in Search and View Item pages. GiftIcon must be included at listing time and set to '1' to be able to use one or more GiftServices options. The value of '1' indicates that this feature is on, and the value of '0' indicates that the feature is off.

Gift Services are only available on the following eBay sites:
  • Belgium (Dutch)
  • Belgium (French)
  • France
  • Italy
  • Netherlands
  • Poland
  • Spain
To verify if Gift Services are enabled for an eBay site, call , call GeteBayDetails with DetailName set to ListingFeatureDetails. Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response.

Not applicable to Half.com.

See GeteBayDetails.

BidItemArray.Item.GiftServices GiftServicesCodeType Conditionally,
repeatable: [0..*]
This field allows the seller to offer optional gift services to the buyer. To offer one or more gift services to the buyer through an Add/Revise/Relist API call, the seller must also include the GiftIcon field and set that flag to 'true'.

Gift Services are only available on the following eBay sites:
  • Belgium (Dutch)
  • Belgium (French)
  • France
  • Italy
  • Netherlands
  • Poland
  • Spain

This field is only returned in GetItem (and other calls that retrieve Item object) if it is set for the listing.
To verify if Gift Services are enabled for an eBay site, call GeteBayDetails with DetailName set to ListingFeatureDetails. Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response.

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.

See GeteBayDetails.

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 order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. 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.
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 This flag indicates whether the Buy It Now feature is available for an auction listing. As a general rule, once an auction listing has bids (and the high bid exceeds the reserve price, if any), the Buy It Now feature becomes disabled for the listing.
BidItemArray.Item
  .ListingDetails
  .CheckoutEnabled
boolean Always This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.

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

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 listings.
BidItemArray.Item
  .ListingDetails
  .ConvertedReservePrice
  [ attribute currencyID ]
CurrencyCodeType 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 listings.

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

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.
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 item is added to the old listing, so buyers can navigate to the new listing. This value only appears when the old listing is retrieved. The RelistedItemID of the original item should reflect the last relist.
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.
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).
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 ?.
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. To set a duration of 1 day, the seller must have a Feedback score of at least 10.

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..*]
This field can be used by the seller to activate one or more listing upgrades for a listing, such as a Bold Title, a Subtitle, or a Value Pack bundle. A ListingEnhancement field is required for each listing upgrade that the seller wants to activate. There is a small fee associated with each listing upgrade. See the Listing Upgrades help page for more information on the available listing upgrades.

The listing upgrades that are available vary by site and by the seller's account status. To discover which listing upgrades are available, call GeteBayDetails with DetailName set to ListingFeatureDetails and pass in the appropriate SiteID value. Then look for the ListingFeatureDetails container in the response. Listing upgrades will either be listed as 'Enabled' or 'Disabled'.

GetItem (and other calls that retrieve Items) will only return this field if one or more listing upgrades are set for the listing.

You cannot remove listing upgrades when you revise a listing. When you relist an item, use DeletedField to remove a listing upgrade.

Not applicable to Half.com.

Applicable values:

BasicUpgradePackBundle
(in/out) No longer applicable to any site.
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 to add a border around the listing's pictures. Applicable listing fees apply.

Note: The Picture Border feature is no longer available on the US site.
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. 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 vehicle listings on eBay Motors (US and Canada), and to the Parts and Accessories category in the eBay Motors US site. 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.

Whenever ValuePackBundle is selected in a request, the Value Pack bundle is automatically upgraded to the Gallery Plus feature at no extra cost (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus). The Gallery Plus upgrade will display on all sites and categories that support ValuePackBundle.

See GeteBayDetails.

BidItemArray.Item.ListingType ListingTypeCodeType Always The format of the listing the seller wants to use, such as auction style or fixed price.

Optional for eBay.com listings (defaults to auction style) 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 in a contact form that eBay forwards to 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.
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 auctions).

Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See eBay Features Guide for more information.

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).
LeadGeneration
(in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).
Shopping
(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.

(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) to be displayed on eBay listing pages. 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.

Note: If you specify both Location and PostalCode, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. 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 included in a single listing that must be purchased together in a single order line item. The Item.LotSize value is the number of items in the lot. This field is required if two or more items are including in one listing.

Lots can be used for auction and fixed price listings. Lot items can be listed only in lot-enabled categories. Call GetCategories to determine if a category supports lots. If the returned CategoryArray.Category.LSD (LotSize Disabled) value is true, the category does not support lots.

Not applicable to Half.com.
Max: 100000.
BidItemArray.Item
  .MotorsGermanySearchable
boolean Conditionally If this field is included and set to 'true' for a motor vehicle listing on the Germany site, the seller's motor vehicle listing will also appear on the mobile.de partner site. This field is only applicable to the eBay Germany site and only applicable when listing a motor vehicle on that site. If this field is used in any other situation, it is ignored.

Listing on the mobile.de is considered a listing upgrade so the seller will be charged a listing upgrade fee.

Not applicable to Half.com.

See Cross-Promoting Vehicles on the Mobile.de Site.

BidItemArray.Item
  .PaymentDetails
PaymentDetailsType Conditionally This container is used by the seller to specify amounts and due dates for deposits and full payment on motor vehicle listings.

The PaymentDetails container and its child fields are only applicable to vehicle listings on eBay Motors (US and CA).

See Payment Methods for Motors.

BidItemArray.Item
  .PaymentDetails
  .DaysToFullPayment
int Conditionally This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are '3', '7' (default), '10', and '14'.

In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following PaymentMethods values must be specified for the listing:
  • CashInPerson
  • LoanCheck
  • MOCC (money order or cashier's check)
  • PaymentSeeDescription (indicates to prospective buyers that payment instructions are in the item's description
  • PersonalCheck

Min: 3. Max: 14. Default: 7.
BidItemArray.Item
  .PaymentDetails.DepositAmount
AmountType (double) Conditionally This dollar value indicates the amount of the deposit that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00. If not specified, this value defaults to '0.0'. If the seller is requiring that the buyer put down a deposit on the vehicle, the seller must include and set the DepositType field to 'OtherMethod' and specify an HoursToDeposit value. If specified, then also specify HoursToDeposit

Deposits can only be paid using PayPal, so if DepositAmount is specified (and not '0.0'), then the listing must offer 'PayPal' as a payment method (in addition to the payment methods offered for the full payment). Unlike other listings, PayPal is not automatically added to a Motors listing even if the seller has a PayPal preference set in My eBay. The seller also needs to have a linked PayPal account in order to require a deposit.

The deposit amount appears in the shipping, payment details and return policy section of the View Item page.

For ReviseItem and related calls: If the listing has no bids, the seller can add or lower a deposit; and they can increase the deposit if the listing doesn't require Immediate Payment. The seller can also remove the Immediate Payment option (if any). If the listing has bids, the seller can only lower an existing deposit; but not add or increase a deposit. The seller can't remove Immediate Payment when a listing with a deposit has bids.
Min: 0.0. Max: 2000.0. Default: 0.0.
BidItemArray.Item
  .PaymentDetails.DepositAmount
  [ attribute currencyID ]
CurrencyCodeType Conditionally This dollar value indicates the amount of the deposit that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00. If not specified, this value defaults to '0.0'. If the seller is requiring that the buyer put down a deposit on the vehicle, the seller must include and set the DepositType field to 'OtherMethod' and specify an HoursToDeposit value. If specified, then also specify HoursToDeposit

Deposits can only be paid using PayPal, so if DepositAmount is specified (and not '0.0'), then the listing must offer 'PayPal' as a payment method (in addition to the payment methods offered for the full payment). Unlike other listings, PayPal is not automatically added to a Motors listing even if the seller has a PayPal preference set in My eBay. The seller also needs to have a linked PayPal account in order to require a deposit.

The deposit amount appears in the shipping, payment details and return policy section of the View Item page.

For ReviseItem and related calls: If the listing has no bids, the seller can add or lower a deposit; and they can increase the deposit if the listing doesn't require Immediate Payment. The seller can also remove the Immediate Payment option (if any). If the listing has bids, the seller can only lower an existing deposit; but not add or increase a deposit. The seller can't remove Immediate Payment when a listing with a deposit has bids.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item
  .PaymentDetails.DepositType
DepositTypeCodeType Conditionally This field applies to eBay Motors (US and CA) vehicles listings. If the seller is requiring that the buyer make a deposit on the vehicle, the DepositType value must be included and set to 'OtherMethod'. Otherwise, specify 'None' (or don't pass in DepositType).
Default: None.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
FastDeposit
(in/out) No longer used.
None
(in/out) No deposit needed.
OtherMethod
(in/out) Pay the deposit using PayPal, and then use any of the other specified payment methods to pay the balance.

BidItemArray.Item
  .PaymentDetails.HoursToDeposit
int Conditionally This integer value indicates the number of hours that a buyer has (after he/she commits to buy) to make a deposit to the seller as a down payment on a motor vehicle. Valid values are '24', '48' (default), and '72'.

The deposit amount is specified in the DepositAmount field. If not specified, the DepositAmount value defaults to 0.0, in which case, a deposit on the vehicle is not required.
Min: 24. Max: 72. 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. For the AddItem family of calls, at least one payment method is required.

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 method for a site (see SiteDefaults.PaymentMethod). If a seller does not include at least one payment method in a Add/Revise/RelistItem API call, the default payment method is used for the listing.

Do not use GeteBayDetails to determine the payment methods for a site.

For a DE or AT seller's items that are subject to the new eBay payment process, only one PaymentMethod field will be returned, and the value will always be 'StandardPayment'.

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" for more information.

This field is not applicable to eBay Real Estate Ad format, Classified Ad format, or Half.com listings.

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.

Applicable values: See PaymentMethods.

See:
    Determining the Payment Methods Allowed for a Category
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema
    GeteBayDetails

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. With the exception of eBay Motors vehicle listings, you can add up to 12, either eBay Picture Services (EPS) hosted or self-hosted, pictures free of charge. It is required that all listings have at least one picture.

Note: All images must comply with the Picture Requirements.
Not applicable to Half.com.

See Introduction to Pictures in Listings.

BidItemArray.Item
  .PictureDetails.GalleryURL
anyURI Conditionally Supported only in Production (not in Sandbox).

The URL for a picture used as the Gallery thumbnail. The image used for the Gallery thumbnail must comply to the Picture Requirements and be in JPEG, BMP, TIF, or GIF graphic format. See Introduction to Pictures in Listings for additional validation rules.

The GalleryURL value is 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.

How eBay Manages Pictures
  • If there is a PictureURL and a GalleryURL, the PictureURL will replace the GalleryURL.
  • eBay selects a Gallery thumbnail from picture URLs in the request using either the GalleryURL or the first PictureURL, based on the selection rules that consider which URLs were specified and whether an eBay stock photo exists for the item. eBay selects a picture regardless of whether you specified GalleryType or GalleryURL.
  • A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are both set to 'true'. If this is not done and the item does not have a PictureURL, the item will not have a Gallery picture.
  • If the first PictureURL field in the request is set to the "clear picture" URL (http://pics.ebay.com/aw/pics/dot_clear.gif):
    • eBay tries to use the picture 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.
    • You can specify Item.ProductListingDetails.UseStockPhotoURLAsGallery or Item.ProductListingDetails.UseStockPhotoURL to true, and eBay will use a stock photo, if available, for the gallery thumbnail and for the picture at the top of a listing.

      A gallery picture isn't generated if UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to false (or not set) and no alternative picture is in PictureURL.

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 GalleryURL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

See:
    Introduction to Pictures in Item Listings
    Picture Selection Rules 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.

You cannot use PhotoDisplay in combination with Listing Designer layouts. Specify 'None' or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.

Some PhotoDisplay options can result in listing fees, even when the item is relisted. If you are relisting an item that was originally listed with a PhotoDisplay option, and you do not want that PhotoDisplay enhancement in your relisted item, you need to specifically remove PhotoDisplay in your RelistItem call (or RelistFixedPriceItem, as applicable) by setting PhotoDisplay to None. Use VerifyRelistItem to review your listing fees before you relist an item.

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. This is 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.
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.

SuperSizePictureShow
(in/out) This is valid for US Motors listing only. For other listings, use SuperSize.

(Not all values in PhotoDisplayCodeType apply to this field.)

See:
    Introduction to Pictures in Item Listings
    Fees Resulting from Listing an Item

BidItemArray.Item
  .PictureDetails.PictureURL
anyURI Conditionally,
repeatable: [0..*]
Contains a URL for a picture associated with an item. The picture may be hosted on eBay Picture Services (EPS) or self-hosted. However, some options require the picture to be hosted through EPS and eBay can determine where the picture is being hosted by parsing the value specified in the request.

Note: All images whether they are hosted by EPS or self-hosted must comply with the Picture Requirements. A listing can have up to 12 EPS-hosted or self-hosted pictures. But you cannot mix self-hosted and EPS-hosted pictures in one listing. To specify multiple pictures, send each URL in a separate, PictureURL element. In most cases, the first URL is also used for the picture on the View Item page.

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

If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.

Note: Embedding pictures in the description (by using IMG tags) is discouraged. The recommended process is to specify the image URLs using PictureURL. If you embed pictures in the description instead of using PictureURL, but you want a camera icon to appear in the search and listing pages, specify the following "clear picture" URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif.

If a listing uses a self-hosted picture (except in the case of a multi-variation listing), the picture will be copied to eBay Picture Services (ESP) and the PictureDetails.PictureURL value returned by GetItem will be an EPS URL.

If there is a PictureURL and a GalleryURL, the PictureURL will replace the GalleryURL.

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 pictures 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, note that if the listing also includes a gallery picture that is based on the first picture in the listing, you may need to supply an alternate picture to use as the gallery picture if you delete all PictureURL fields. Pictures cannot be added or removed from a fixed-price listing when the listing is scheduled to end within 12 hours or if the listing has already had transactions.

Note: For some large merchants, there are no limitations on when pictures can be added or removed from a fixed-price listing, even when the listing has had transactions or is set to end within 12 hours.
For information about Gallery pictures, see GalleryURL.
Max length: 500.

See:
    Picture Selection Rules for complete details on how eBay selects a Gallery thumbnail.
    Introduction to Pictures in Item Listings
    Working with Pictures in an Item Listing
    (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.

eBay derives a geographical location from the postal code to display on eBay listing pages. If you do not specify PostalCode, you must specify Item.Location.

Note: If you specify both PostalCode and Location, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. 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.

If you list with a catalog product, eBay may drop the primary category you specify and use the category that is associated with the product instead, if different.

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.

Note: For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to 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 Features Guide for additional information. International sites (such as the eBay Germany site) have similar rules for revising vehicle categories.

When you list an event ticket on the US site, you must specify the Event Tickets category as the primary category. Also, when revising a listing, you cannot change the primary category from another category to the Event Tickets category. (You need to specify the Event Tickets category when you initially list the item.)

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:
    Applying Categories
    Listing US and CA eBay Motors Items
    (RelistItem) GalleryType

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 GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is also required if a Secondary Category is used.
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 The PrivateListing boolean field can be used by the seller in the Add/Relist/Revise family of calls to obscure item title, item ID, and item price from post-order Feedback comments left by buyers. Typically, it is not advisable that sellers use the Private Listing feature, but using this feature may be appropriate for sellers listing in Adults Only categories, or for high-priced and/or celebrity items.

For GetItem, order retrieval calls, and other calls that retrieve the Item object, the PrivateListing field is only returned if 'true'.

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 Features 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 one of the other industry identifiers (e.g., UPC), 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 FindProducts in the Shopping API to determine a ProductReferenceID.

When you specify ProductListingDetails, you must specify at least one of the available identifiers (e.g., UPC). If you specify more than one (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 identifier is more likely to result in a match.)

When you specify TicketListingDetails, you must specify the Event Tickets category as the primary category. For other product identifiers: If you list in two categories and the primary and secondary categories are both catalog-enabled, this product identifier should correspond to the primary category (not the secondary category). If only one category is catalog-enabled, the product identifier should correspond to the catalog-enabled category.

Note: As a general rule, the primary category is required. However, if you have trouble finding a catalog-enabled category, you may be able to omit the primary category (except for event tickets). If you do, eBay will attempt to determine an appropriate category based on the product ID (if we find a matching product). When you specify a category that corresponds to the product, your category is used. If we don't find a match in our catalogs, we will list the item in the primary category you specified, without product details. We will not pre-fill the listing's item specifics in this case, and the identifier won't be surfaced in View Item or returned in GetItem. However, it will still be indexed for search on eBay, and it will be searchable by more third-party natural search engines. As this can help buyers find your listing more easily, we strongly recommend that you always use ProductListingDetails to pass in these values. (This product indexing behavior is only available if you use UPC, ISBN, EAN, or GTIN in ProductListingDetails. It is not available if you use ExternalProductID, and it may not be available if you exclusively use Item Specifics.)

Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. (ExternalProductID is no longer recommended.)
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 GetMyeBayBuying only: When products have been added to a buyer's Wish List, the product information is returned in ItemArray.Item.ProductListingDetails within the UserDefinedList node. Products can be added to a buyer's Wish List only. Does not apply to any other user-defined list. The ProductListingDetails node is not included for items in the Wish List.

Not applicable to Half.com.
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.
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.

For GetItem and related calls: The eBay site shows the catalog product description in the product details section of a listing. You cannot download this pre-filled description text via the API. To retrieve a URL for the catalog product details page, see DetailsURL in GetProductSearchResults, GetProductFamilyMembers, or GetProductSellingPages. Or see DetailsURL in FindProducts in the Shopping API (which may be easier to use if your application doesn't support eBay Attributes).
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.

Note: If you also include additional images with Item.PictureDetails.PictureURL, the View Item page will show only these images and the stock photo will not be shown.
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.

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

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.

Not applicable to Half.com.

See:
    Introduction to Pictures in Listings
    Including Pictures in the Search Results Gallery

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 Pre-filling Item Specifics with Product Details for information about finding this type of product ID. (For the shorter product ID (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.

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 to 'true'.
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).

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 on all sites).

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:
    Introduction to Pictures in Listings
    Including Pictures in the Search Results Gallery

BidItemArray.Item.Quantity int Always The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing.

For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations.

For RelistItem, RelistFixedPriceItem, and VerifyRelistItem: Previously in RelistItem, RelistFixedPriceItem, and VerifyRelistItem the Quantity field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the quantity that was really still available for purchase and it was often out of synch with the QuantityAvailable value that is returned with the GetMyeBaySelling call. As of March 13, 2014, this behavior has been changed in the following manner:
  • For a listing that has ended with an available quantity greater than zero, the Quantity value of the newly relisted item is set to the actual QuantityAvailable value (see the GetMyeBaySelling call) when the previous listing ended.
  • For listings that ended with an available quantity of zero, the relisted item will retain the Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had an available quantity of zero when the listing ended, we strongly recommend that you pass in the correct available quantity through the Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value.

When eBay auto-renews a GTC listing (ListingDuration=GTC) on your behalf, eBay relists with correct quantity available.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below.
For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

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 order line item 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 GetDispute: Quantity is the number of items being raised in the dispute.

For SetCart: This input is required only when 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: The number in the Quantity field represents the current quantity of items that are available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of items available through each local fulfillment method. In the case where a listing is only offering the item through a local fulfillment method, this value should default to '0', and the Item.IgnoreQuantity will also be returned as 'True'.

See:
    Seller Limits
    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 a reserve price. See Applying Categories. 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 Revising US eBay Motors Listings for validation rules when revising US Motors listings.

The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing.

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 The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See Applying Categories. 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 Revising US eBay Motors Listings for validation rules when revising US Motors listings.

The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item.ReturnPolicy ReturnPolicyType Conditionally Container that describes the seller's return policy. Most categories on most eBay sites require the seller to include a return policy through the ReturnPolicy container.

For the AddItem family of calls: Required for most categories on most sites. Use ReturnPolicyEnabled in GetCategoryFeatures to determine which categories require this field. To determine which ReturnPolicy fields can be used on each site, call GeteBayDetails with DetailName set to ReturnPolicyDetails.

eBay India (IN), Australia (AU), and US eBay Motors Parts and Accessories categories typically support but do not require a return policy. (However, we strongly recommend that you specify a clear return policy whenever possible.)

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.

eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML, and avoid character entity references (such as &pound; or &#163;). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £).

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. To determine if your site supports this field, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for a 'true' value in the ReturnPolicyDetails.EAN 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.

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

The RefundOption field is not supported by any of the European sites.

Applicable values: To get the applicable RefundOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.Refund.RefundOption fields in the response.

For Add/Revise/Relist/VerifyAdd API 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 Revise calls 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.

Note: As of version 771, listings created, revised, or relisted on the US site with deprecated RefundOption and/or ReturnsWithinOption values (using Add/Revise/Relist API calls) will be blocked.

For RefundOption, the deprecated values for the US site are MerchandiseCredit and Exchange. Instead of these deprecated values, the seller must offer a MoneyBack or a MoneyBackOrExchange refund option. Consider using the MoneyBackOrExchange option when you have the depth of inventory to support an exchange for a different size, color, or undamaged unit. Otherwise, use the MoneyBack option if you have limited inventory.


GranularityLevel: Fine, Medium.

See (GeteBayDetails) RefundOption.



Applicable values: See RefundOptionsCodeType
BidItemArray.Item.ReturnPolicy
  .RestockingFeeValue
token Conditionally Display string that indicates the restocking fee charged by the seller for returned items. This value is directly related to the RestockingFeeValueOption value, with the difference being that applications can use RestockingFeeValue to present the RestockingFeeValueOption value in a more user-friendly format when used in a GUI features such as option buttons or drop-down lists.

GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy
  .RestockingFeeValueOption
token Conditionally This enumeration value indicates the restocking fee charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.

For Add/Revise/Relist calls: To obtain the list of applicable values, call GeteBayDetails with DetailName set to ReturnPolicyDetails. Then look for the list of restocking fee value options in the ReturnPolicyDetails.RestockingFeeValue container in the response.

For Get calls: The RestockingFeeValue field is directly related to RestockingFeeValueOption, and gives a user-friendly description of the restocking fee policy.

GranularityLevel: Fine, Medium.

See GeteBayDetails.ReturnPolicyDetails for applicable values for RestockingFeeValueOption.



Applicable values: See RestockingFeeCodeType
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.)

All sites support the ability for a seller to not accept returns. If the seller doesn't accept returns, the item must specifically indicate ReturnsNotAccepted. (The return policy cannot be omitted from the item.)

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. On some European sites (such as eBay Germany (DE)), registered business sellers are required to accept returns. Your application can call GetUser to determine a user's current business seller status.

Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for the item (ReturnsAcceptedOption=ReturnsAccepted) and handling time should be set to zero days (same-day shipping) or one day. The handling time is set through an integer value in the Item.DispatchTimeMax field. Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on eBay's Top-Rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page.
Applicable values: To get the applicable ReturnsAcceptedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ReturnsAccepted.Description fields in the response. 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
    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: To get the applicable ReturnsWithinOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption fields in the response. 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_14), 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: As of version 771, listings created, revised, or relisted with deprecated RefundOption and/or ReturnsWithinOption values (using Add/Revise/Relist API calls) will be blocked.

For ReturnsWithinOption, the deprecated values are Days_3 and Days_7. Instead of these deprecated values, the seller must offer a 14-day, 30-day, or 60-day return window.

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.



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: To get the applicable ShippingCostPaidByOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ShippingCostPaidBy.ShippingCostPaidByOption fields in the response. 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: To get the applicable WarrantyDurationOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyDuration. WarrantyDurationOption fields in the response. 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.



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: To get the applicable WarrantyOfferedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyOffered.WarrantyOfferedOption fields in the response. WarrantyOfferedCodeType defines all the possible values.
Note: Only the eBay India site supports this field.
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
    (AddItem) Item.LimitedWarrantyEligible for US eBay Motors Short-Term Service Agreement
    (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: To get the applicable WarrantyTypeOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyType.WarrantyTypeOption fields in the response. WarrantyTypeOptionsCodeType defines all the possible values.
Note: Only the eBay India site supports this field.
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.

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.

If eBay has designated a category as a value category (see ValueCategory in GetCategoryFeatures), items in that category cannot be listed in two categories. For example, if your AddItem request includes a primary or secondary category that is a value category, then eBay drops SecondaryCategory and lists the item with only the PrimaryCategory you selected. Also, if the listing request includes item specifics (in ItemSpecifics or AttributeSetArray) that are associated with SecondaryCategory, eBay drops those values when we drop SecondaryCategory. (The same logic is used if you revise an existing listing to add a secondary category or to change one of the categories: If either the primary or secondary category is a value category, eBay drops the secondary category from your request.)

To remove this value when relisting an item, use DeletedField.

For ReviseItem only: When revising a listing, you can add 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.

Note: For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. 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 Applying 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 GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is also required if a Secondary Category is used.
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. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

For the order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

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.

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 either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned.

GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling.

Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned.

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 a seller, including listing settings, listing preferences, seller rankings, and seller type.

This field is replaced by the SellerBusinessType field if the user is a business seller with a site ID of 77 (Germany), ID of 3 (UK), ID of 205 (Ireland) or ID of 0 (US 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 This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.
BidItemArray.Item.Seller
  .SellerInfo
  .CIPBankAccountStored
boolean Always If true, this flag indicates that the seller has stored bank account information on file with eBay. A seller must have stored bank account information on file with eBay in order to use 'CashOnPickup' as a payment method (known as 'Pay upon Pickup' on the site). This field is applicable to all eBay sites that support 'CashOnPickup' 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 (token) 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.
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
  .SellereBayPaymentProcessConsent
SellereBayPaymentProcessConsentCodeType Conditionally This container is returned to all DE and AT sellers and consists of details of the seller's account status regarding the new eBay payment process. This information includes the seller's payout preferences and whether or not the seller has accepted the supplemental user agreement for the new eBay payment process.
BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessConsent
  .PayoutMethod
PayoutMethodType Conditionally Enumeration value that indicates the account type that the DE or AT seller has selected as their default seller payout account. Once a DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, that seller must set the default payout account in My eBay preferences. eBay will distribute seller payouts to this account. This field will not be returned if PayoutMethodSet='false'.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

EFT
(out) This value indicates that the seller wants eBay to distribute payouts to their bank account via EFT (Electronic Funds Transfer).
MONEYBOOKERS
(out) This value indicates that the seller wants eBay to distribute payouts to their Moneybookers (Skrill) account.
PAYPAL
(out) This value indicates that the seller wants eBay to distribute payouts to their PayPal account.

BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessConsent
  .PayoutMethodSet
boolean Conditionally Flag to indicate whether or not a DE or AT seller has set the payout method type on the account. This field is always returned with the SellereBayPaymentProcessConsent container.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.
BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
UserAgreementInfoType Conditionally,
repeatable: [0..*]
Container consisting of details related to the current status of a DE or AT seller signing the required supplemental user agreement for the new eBay payment process. This container will always be returned to DE and AT sellers and the child values that are returned will be dependent on the current SellereBayPaymentProcessStatus value for the seller's account.

If the seller lists items on both the DE and AT sites, a UserAgreementInfo container will be returned for each site, with the sites being distinguished by the UserAgreementInfo.Site value (either 'Germany' or 'Austria').

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.
BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .AcceptedTime
dateTime Conditionally This timestamp indicates the date on which the DE or AT seller accepted the supplemental user agreement for the new payment process. Unless the UserAgreementInfo.SellereBayPaymentProcessStatus value is 'MustAcceptUA', this value is always returned with UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.
BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .SellereBayPaymentProcessEnableTime
dateTime Conditionally This timestamp indicates the date on which the new eBay payment process was fully enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='eBayPaymentProcessEnabled') or scheduled to be enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='AcceptedUA' or 'MustAcceptUA', and the enable date is known by eBay). Unless the eBay payment process enable date is not known for the seller, this value is always returned with UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.
BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .SellereBayPaymentProcessStatus
SellereBayPaymentProcessStatusCodeType Conditionally Enumeration value that indicates whether or not a new DE or AT seller has accepted the supplement user agreement for the new payment process for that site (indicated by the UserAgreementInfo.site value). This value is always returned with the UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.

Applicable values:

AcceptedUA
(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.
CustomCode
(out) Reserved for internal or future use
eBayPaymentProcessEnabled
(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.
MustAcceptUA
(out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo.Site
SiteCodeType Conditionally String value that indicates the site to which the supplemental user agreement information pertains. This value is always returned with the UserAgreementInfo container.

Although this value is based on SiteCodeType (which contains many values), the only values that will be returned here are 'Germany' or 'Austria'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values: See Site.
BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .UserAgreementURL
anyURI Conditionally This is the URL for new eBay payment process supplemental user agreement. This URL is only returned if the UserAgreementInfo.SellereBayPaymentProcessStatus='MustAcceptUA'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.
BidItemArray.Item.Seller
  .SellerInfo
  .SellereBayPaymentProcessStatus
SellereBayPaymentProcessStatusCodeType Conditionally This enumeration value indicates the current status of a DE or AT seller's account related to the new eBay payment process.

'AcceptedUA' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, but that same seller's account is not yet ramped up in the new eBay payment process.

'eBayPaymentProcessEnabled' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, and that same seller's account is ramped up in the new eBay payment process.

'MustAcceptUA' is returned if the DE or AT seller has not accepted the supplemental user agreement for the new eBay payment process. If this is the case, the seller can find the URL to the supplemental user agreement in the SellereBayPaymentProcessConsent.UserAgreementInfo.UserAgreementURL field.

Applicable values:

AcceptedUA
(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.
CustomCode
(out) Reserved for internal or future use
eBayPaymentProcessEnabled
(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.
MustAcceptUA
(out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

BidItemArray.Item.Seller
  .SellerInfo.SellerLevel
SellerLevelCodeType Always The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list. SellerInfo.SellerLevel is no longer returned in the GetUser, GetBidderList, GetSellerList, GetItem, and GetItemTransactions responses for the US, DE/AT/CH, and UK/IE sites, for version 629 and later. If you are using a version older than 629, SellerInfo.SellerLevel will still be returned. Developers should note that SellerInfo.SellerLevel could potentially be removed from other sites as well.

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 Boolean value indicates whether or not the seller is an eBay Store owner.
BidItemArray.Item.Seller
  .SellerInfo.TopRatedSeller
boolean Conditionally This boolean field indicates if the seller is certified as a Top Rated Seller. To qualify as a Top Rated Seller, a seller must meet the following requirements:
  • 100 or more selling transactions in a one-year period
  • Shipment tracking information provided to the buyer within the specified handling time for at least 90 percent of their listings
This field is returned for the following sites only: US (EBAY-US), Motors (EBAY-MOTOR), AT (EBAY-AT), CH (EBAY-CH), DE (EBAY-DE), IE (EBAY-IE) and UK (EBAY-GB).

On the eBay US site, Top Rated Sellers are eligible to receive a Top Rated Plus seal for their listings. For a Top Rated Seller's listing to qualify as a Top Rated Plus listing, that listing must accept returns and the handling time must be set to one day (DispatchTimeMax=1). Top Rated Plus listings get increased visibility in fixed-price searches and receive a Final Value Fee discount.

See:
    Top Rated Seller Resource Center for more information about how to become a Top Rated Seller and qualify for Top Rated Plus on the eBay US site
    Seller Help Page for more information about how to qualify as a Top Rated Seller on the eBay US, AT, CH, DE, IE and UK sites

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 needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
CreditCardVerifyHalfOptIn
(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
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. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
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, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID can change for each auction.

For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

For PlaceOffer, see also SellingStatus.HighBidder.

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 Value-Added Tax (VAT).

BidItemArray.Item
  .SellerVacationNote
string Conditionally The seller is on vacation (as determined by 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 auction item.
BidItemArray.Item
  .SellingStatus.BidIncrement
AmountType (double) Always The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price listings.
BidItemArray.Item
  .SellingStatus.BidIncrement
  [ attribute currencyID ]
CurrencyCodeType Conditionally The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price listings.

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

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item
  .SellingStatus.CurrentPrice
AmountType (double) Always The current price of the item in the original listing currency.

For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price.

For fixed-price and ad format listings, this is the current listing price.

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.
BidItemArray.Item
  .SellingStatus.CurrentPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The current price of the item in the original listing currency.

For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price.

For fixed-price and ad format listings, this is the current listing price.

In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item
  .SellingStatus.FinalValueFee
AmountType (double) Conditionally A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment.

The FVF is calculated using a percentage. This percentage is based on whether the seller has a Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the Fee Center Home Page.

The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status.

If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data.

Not applicable to Half.com.
BidItemArray.Item
  .SellingStatus.FinalValueFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment.

The FVF is calculated using a percentage. This percentage is based on whether the seller has a Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the Fee Center Home Page.

The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status.

If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item
  .SellingStatus.HighBidder
UserType Conditionally For ended auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, fixed-price listings, this field is a container for the user ID of the purchaser. This field isn't returned for auctions with no bids, or for active fixed-price listings. In the case of PlaceOffer, for auction listings, this field is a container for the high bidder's user ID. In the PlaceOffer response, the following applies: For multiple-quantity, fixed-price listings, the high bidder is only returned if there is just one order line item (or only for the first order line item that is created).

DetailLevel: ReturnAll.

GranularityLevel: Medium.
BidItemArray.Item
  .SellingStatus.HighBidder
  .AboutMePage
boolean Always If true, indicates that the user has set up an About Me page.
BidItemArray.Item
  .SellingStatus.HighBidder
  .eBayGoodStanding
boolean Always If true, indicates that the user is in good standing with eBay.
BidItemArray.Item
  .SellingStatus.HighBidder
  .Email
string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

For the order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

BidItemArray.Item
  .SellingStatus.HighBidder
  .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.

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
  .SellingStatus.HighBidder
  .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
  .SellingStatus.HighBidder
  .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 either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned.

GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling.

Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned.

See Working with Anonymous User Information.

BidItemArray.Item
  .SellingStatus.HighBidder
  .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
  .SellingStatus.HighBidder
  .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
  .SellingStatus.HighBidder
  .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
  .SellingStatus.HighBidder.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
  .SellingStatus.HighBidder
  .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 needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
CreditCardVerifyHalfOptIn
(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
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. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)
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
  .SellingStatus.HighBidder
  .UserID
UserIDType (string) Conditionally Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID can change for each auction.

For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

For PlaceOffer, see also SellingStatus.HighBidder.

See Working with Anonymous User Information.

BidItemArray.Item
  .SellingStatus.HighBidder
  .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
  .SellingStatus.HighBidder
  .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
  .SellingStatus.HighBidder
  .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 Value-Added Tax (VAT).

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.
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 auction listings. Returns null for fixed-price and Ad type listings.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.
BidItemArray.Item
  .SellingStatus.MinimumToBid
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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 auction listings. Returns null for fixed-price and Ad type listings.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

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 Original price of an item whose price a seller has reduced with the Promotional Price Display feature.

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 The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available.

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 order line item.

For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item.
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 order, 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 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.

IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)

See:
    Determining Shipping Costs for a Listing
    Revising a Listing for restrictions on changing item properties with ReviseItem

BidItemArray.Item
  .ShippingDetails
  .AllowPaymentEdit
boolean Conditionally This field is no longer returned and has been replaced by the ShippingDetails.PaymentEdited field.

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

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: FR and IT
Applicable to Half.com for GetOrders.
Default: 0.00.
BidItemArray.Item
  .ShippingDetails.InsuranceFee
  [ attribute currencyID ]
CurrencyCodeType 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: FR and IT
Applicable to Half.com for GetOrders.

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 only returned if the value is other than NotOffered.

Valid only on the following sites: 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) are set to for flat and calculated shipping, depending on which subfields are used.

Valid only on the following sites: 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 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).

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.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) 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.

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

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 being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService=true field, as this indicates that the ShippingService value is an International shipping service option. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

For flat and calculated shipping.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
BidItemArray.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only.
BidItemArray.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only.

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.

If a shipping service has been specified, GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

See Shipping.

BidItemArray.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType 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.

If a shipping service has been specified, GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority
int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.
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 with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified.

See Specifying Locations to Where You Ship.



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 and US Motors (site 0) sites only, excluding vehicle listings. Flat and calculated shipping.

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

To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response.

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.

GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these.

GetMyeBayBuying: If the seller has set the ShipToLocation as 'Worldwide' for an item, but has not specified any international shipping service options, 'NotSpecified' is returned as the ShippingType value.

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. Available only for US domestic shipping. The cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code).

Currently, Freight can be specified only on input via eBay Web site, not via 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.

Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide.
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
  .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 DetailName set to ShippingLocationDetails to determine which international locations are valid for the site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.

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:
    ShipToLocations
    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, 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 or AddFixedPriceItem, 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 an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method.

If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.

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 This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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.

See:
    Seller Limits
    GeteBayDetails

BidItemArray.Item.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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.

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 and fixed-price listings listed by eBay Stores sellers.

Not applicable to Half.com.
BidItemArray.Item.Storefront
  .StoreCategory2ID
long Conditionally Unique identifier for the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories).

The system resets the value to 0 (None) in the following cases:
- The values of StoreCategoryID and StoreCategory2ID field are the same
- You specify StoreCategory2ID but not StoreCategoryID


In other words, StoreCategoryID must be set to a valid custom category and be different from StoreCategory2ID.
BidItemArray.Item.Storefront
  .StoreCategoryID
long Conditionally Unique identifier of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories.

To list an item using the categories in a seller's store, you must set this field to a root-level custom category or a custom category that has 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.
BidItemArray.Item.Storefront
  .StoreURL
anyURI Conditionally The URL of the seller's eBay Stores page.
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/Changing a Field When Relisting an Item
    (RelistItem) DeletedField
    Specifying a Subtitle for a Motors Vehicle Listing

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 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. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

For the AddItem family of calls: Not applicable to Half.com.

For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours.

Note: For some large merchants, there are no limitations on when the Item Title for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations.
Max length: 80.
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.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

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 Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

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 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally 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) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, 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.


See the Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Back to top

GetBidderList Detail Controls


DetailLevel

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


GranularityLevel

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.

YThe field is always returned.
(Y)The field is conditionally returned. See the field documentation 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.RestockingFeeValue(Y)(Y)
BidItemArray.Item.ReturnPolicy.RestockingFeeValueOption(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)
BidItemArray.Item.SellingStatus.HighBidder-(Y)



Back to top

GetBidderList Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Returns the items the caller is currently bidding on, plus the items they have recently won.

Description

Bountiful Buyer wants to review all the items she is currently bidding on, and the items that she has won in the recent past.

This call will by default return all the items that the authorized caller is currently bidding on, plus their recently won items; there is no special input needed.

Input

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetBidderListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC..123</eBayAuthToken>
  </RequesterCredentials>
</GetBidderListRequest>

Output

XML format.
<GetBidderListResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-12-01T01:39:52.565Z</Timestamp>
  <Ack>Success</Ack>
  <Version>643</Version>
  <Build>E643_CORE_BUNDLED_10272615_R1</Build>
  <Bidder>
    <AboutMePage>false</AboutMePage>
    <FeedbackScore>62</FeedbackScore>
    <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
    <FeedbackPrivate>false</FeedbackPrivate>
    <FeedbackRatingStar>Blue</FeedbackRatingStar>
    <IDVerified>true</IDVerified>
    <eBayGoodStanding>true</eBayGoodStanding>
    <NewUser>false</NewUser>
    <RegistrationDate>2001-03-23T16:36:37.000Z</RegistrationDate>
    <Site>US</Site>
    <Status>Confirmed</Status>
    <UserID>BountifulBuyer</UserID>
    <UserIDChanged>false</UserIDChanged>
    <UserIDLastChanged>2002-03-17T05:32:20.000Z</UserIDLastChanged>
    <VATStatus>NoVATTax</VATStatus>
  </Bidder>
  <BidItemArray>
    <Item>
      <AutoPay>false</AutoPay>
      <BuyerProtection>ItemEligible</BuyerProtection>
      <BuyItNowPrice currencyID="USD">150.0</BuyItNowPrice>
      <Country>US</Country>
      <Currency>USD</Currency>
      <GiftIcon>0</GiftIcon>
      <HitCounter>BasicStyle</HitCounter>
      <ItemID>122450797646</ItemID>
      <ListingDetails>
        <Adult>false</Adult>
        <BindingAuction>false</BindingAuction>
        <CheckoutEnabled>false</CheckoutEnabled>
        <ConvertedBuyItNowPrice currencyID="USD">150.0</ConvertedBuyItNowPrice>
        <ConvertedStartPrice currencyID="USD">70.0</ConvertedStartPrice>
        <HasReservePrice>false</HasReservePrice>
        <StartTime>2009-10-28T01:00:28.000Z</StartTime>
        <EndTime>2009-11-02T01:00:28.000Z</EndTime>
        <ViewItemURL>http://cgi.ebay.com/ws/eBayISAPI.dll?ViewItem&
            item=122450797646&category=115280</ViewItemURL>
        <HasUnansweredQuestions>false</HasUnansweredQuestions>
        <HasPublicMessages>false</HasPublicMessages>
        <ViewItemURLForNaturalSearch>http://cgi.ebay.com/
            Titleist-735-CM-Stainless-Steel-Iron-set-Golf-Club-5-PW_W0QQitem
            Z122450797646QQcategoryZ115280QQcmdZViewItem</ViewItemURLForNaturalSearch>
      </ListingDetails>
      <ListingDuration>Days_5</ListingDuration>
      <ListingType>Chinese</ListingType>
      <Location>Daton, Ohio</Location>
      <PaymentMethods>PayPal</PaymentMethods>
      <PrimaryCategory>
        <CategoryID>115280</CategoryID>
        <CategoryName>Sporting Goods:Golf:Clubs</CategoryName>
      </PrimaryCategory>
      <PrivateListing>false</PrivateListing>
      <Quantity>1</Quantity>
      <ReviseStatus>
        <ItemRevised>true</ItemRevised>
      </ReviseStatus>
      <Seller>
        <AboutMePage>false</AboutMePage>
        <FeedbackScore>145</FeedbackScore>
        <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
        <FeedbackPrivate>false</FeedbackPrivate>
        <FeedbackRatingStar>Turquoise</FeedbackRatingStar>
        <IDVerified>false</IDVerified>
        <eBayGoodStanding>true</eBayGoodStanding>
        <NewUser>false</NewUser>
        <RegistrationDate>2002-01-14T04:22:37.000Z</RegistrationDate>
        <Site>eBayMotors</Site>
        <Status>Confirmed</Status>
        <UserID>baligrlpro</UserID>
        <UserIDChanged>false</UserIDChanged>
        <UserIDLastChanged>2002-01-14T04:22:37.000Z</UserIDLastChanged>
        <VATStatus>NoVATTax</VATStatus>
        <SellerInfo>
          <AllowPaymentEdit>true</AllowPaymentEdit>
          <CheckoutEnabled>false</CheckoutEnabled>
          <CIPBankAccountStored>false</CIPBankAccountStored>
          <GoodStanding>true</GoodStanding>
          <LiveAuctionAuthorized>false</LiveAuctionAuthorized>
          <MerchandizingPref>OptIn</MerchandizingPref>
          <QualifiesForB2BVAT>false</QualifiesForB2BVAT>
          <StoreOwner>false</StoreOwner>
          <SafePaymentExempt>true</SafePaymentExempt>
        </SellerInfo>
        <MotorsDealer>false</MotorsDealer>
      </Seller>
      <SellingStatus>
        <BidCount>8</BidCount>
        <BidIncrement currencyID="USD">2.5</BidIncrement>
        <ConvertedCurrentPrice currencyID="USD">110.0</ConvertedCurrentPrice>
        <CurrentPrice currencyID="USD">110.0</CurrentPrice>
        <MinimumToBid currencyID="USD">112.5</MinimumToBid>
        <QuantitySold>1</QuantitySold>
        <ReserveMet>true</ReserveMet>
        <SecondChanceEligible>true</SecondChanceEligible>
        <ListingStatus>Completed</ListingStatus>
      </SellingStatus>
      <ShippingDetails>
        <PaymentInstructions>Payment within 3 days of auctions end.</PaymentInstructions>
        <SalesTax>
          <SalesTaxPercent>0.0</SalesTaxPercent>
          <ShippingIncludedInTax>false</ShippingIncludedInTax>
        </SalesTax>
        <ShippingServiceOptions/>
        <ShippingType>Flat</ShippingType>
        <ThirdPartyCheckout>false</ThirdPartyCheckout>
        <TaxTable/>
      </ShippingDetails>
      <ShipToLocations>US</ShipToLocations>
      <Site>US</Site>
      <StartPrice currencyID="USD">70.0</StartPrice>
      <TimeLeft>PT0S</TimeLeft>
      <Title>Titleist 735.CM Stainless Steel Iron set Golf Club 5-PW</Title>
      <GetItFast>false</GetItFast>
      <PostalCode>44060</PostalCode>
      <PictureDetails>
        <GalleryType>Gallery</GalleryType>
        <GalleryURL>http://i.ebayimg.com/02/!BdpEiV!Bmk~$(KGrHqEH-C8ErHG9gBmBK50P8Fk!
            Q~~_1.JPG?set_id=880000500F</GalleryURL>
        <PhotoDisplay>None</PhotoDisplay>
        <PictureURL>http://i.ebayimg.com/02/!BdpEiV!Bmk~$(KGrHqEH-C8ErG9gBmBK50P8Fk!
            Q~~_1.JPG?set_id=880000500F</PictureURL>
        <PictureURL>http://i.ebayimg.com/22/!BdpEj+QB2k~$(KGrHqEH-EMEr0stmJBK50P+wjJ
            g~~_1.JPG?set_id=880000500F</PictureURL>
        <PictureURL>http://i.ebayimg.com/17/!BdpElyw!Wk~$(KGrHqUH-EUErZ7NkhBK50QDz8r
            !~~_1.JPG?set_id=880000500F</PictureURL>
        <PictureURL>http://i.ebayimg.com/08/!BdpEnvQCGk~$(KGrHqMH-DMEry2P1DBK50QIzEk
            Q~~_1.JPG?set_id=880000500F</PictureURL>
        <PictureURL>http://i.ebayimg.com/24/!BdpEqDw!mk~$(KGrHqIH-C4ErthJVUBK50QNRnw
            g~~_1.JPG?set_id=880000500F</PictureURL>
      </PictureDetails>
      <DispatchTimeMax>1</DispatchTimeMax>
      <ProxyItem>false</ProxyItem>
      <BuyerGuaranteePrice currencyID="USD">20000.0</BuyerGuaranteePrice>
      <ReturnPolicy>
        <RefundOption>MoneyBack</RefundOption>
        <Refund>Money Back</Refund>
        <ReturnsWithinOption>Days_7</ReturnsWithinOption>
        <ReturnsWithin>7 Days</ReturnsWithin>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <ReturnsAccepted>Returns Accepted</ReturnsAccepted>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
        <ShippingCostPaidBy>Buyer</ShippingCostPaidBy>
      </ReturnPolicy>
      <PaymentAllowedSite>US</PaymentAllowedSite>
    </Item>
    <Item>
      <AutoPay>true</AutoPay>
      <BuyerProtection>ItemEligible</BuyerProtection>
      <BuyItNowPrice currencyID="USD">149.0</BuyItNowPrice>
      <Country>US</Country>
      <Currency>USD</Currency>
      <GiftIcon>0</GiftIcon>
      <HitCounter>BasicStyle</HitCounter>
      <ItemID>303372003874</ItemID>
      <ListingDetails>
        <Adult>false</Adult>
        <BindingAuction>false</BindingAuction>
        <CheckoutEnabled>true</CheckoutEnabled>
        <ConvertedBuyItNowPrice currencyID="USD">149.0</ConvertedBuyItNowPrice>
        <ConvertedStartPrice currencyID="USD">100.0</ConvertedStartPrice>
        <HasReservePrice>false</HasReservePrice>
        <StartTime>2009-11-28T18:53:58.000Z</StartTime>
        <EndTime>2009-12-05T18:53:58.000Z</EndTime>
        <ViewItemURL>http://cgi.ebay.com/ws/eBayISAPI.dll?ViewItem&item=
            303372003874&category=115280</ViewItemURL>
        <HasUnansweredQuestions>false</HasUnansweredQuestions>
        <HasPublicMessages>false</HasPublicMessages>
        <ViewItemURLForNaturalSearch>http://cgi.ebay.com/
            9-10-Titleist-755-Forged-Iron-set-5-PW-Stiff-Shafts_W0QQ
            itemZ303372003874QQcategoryZ115280QQcmdZViewItem</ViewItemURLForNaturalSearch>
      </ListingDetails>
      <ListingDuration>Days_7</ListingDuration>
      <ListingType>Chinese</ListingType>
      <Location>Vashon, WA</Location>
      <PaymentMethods>PayPal</PaymentMethods>
      <PrimaryCategory>
        <CategoryID>115280</CategoryID>
        <CategoryName>Sporting Goods:Golf:Clubs</CategoryName>
      </PrimaryCategory>
      <PrivateListing>false</PrivateListing>
      <Quantity>1</Quantity>
      <ReviseStatus>
        <ItemRevised>false</ItemRevised>
      </ReviseStatus>
      <Seller>
        <AboutMePage>false</AboutMePage>
        <FeedbackScore>481</FeedbackScore>
        <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
        <FeedbackPrivate>false</FeedbackPrivate>
        <FeedbackRatingStar>Turquoise</FeedbackRatingStar>
        <IDVerified>false</IDVerified>
        <eBayGoodStanding>true</eBayGoodStanding>
        <NewUser>false</NewUser>
        <RegistrationDate>2002-12-03T16:15:23.000Z</RegistrationDate>
        <Site>eBayMotors</Site>
        <Status>Confirmed</Status>
        <UserID>zheutlin1</UserID>
        <UserIDChanged>false</UserIDChanged>
        <UserIDLastChanged>2009-03-20T22:42:58.000Z</UserIDLastChanged>
        <VATStatus>NoVATTax</VATStatus>
        <SellerInfo>
          <AllowPaymentEdit>false</AllowPaymentEdit>
          <CheckoutEnabled>true</CheckoutEnabled>
          <CIPBankAccountStored>false</CIPBankAccountStored>
          <GoodStanding>true</GoodStanding>
          <LiveAuctionAuthorized>false</LiveAuctionAuthorized>
          <MerchandizingPref>OptIn</MerchandizingPref>
          <QualifiesForB2BVAT>false</QualifiesForB2BVAT>
          <StoreOwner>false</StoreOwner>
          <SafePaymentExempt>true</SafePaymentExempt>
          <TopRatedSeller>true</TopRatedSeller>
        </SellerInfo>
        <MotorsDealer>false</MotorsDealer>
      </Seller>
      <SellingStatus>
        <BidCount>2</BidCount>
        <BidIncrement currencyID="USD">2.5</BidIncrement>
        <ConvertedCurrentPrice currencyID="USD">100.0</ConvertedCurrentPrice>
        <CurrentPrice currencyID="USD">100.0</CurrentPrice>
        <MinimumToBid currencyID="USD">102.5</MinimumToBid>
        <QuantitySold>0</QuantitySold>
        <ReserveMet>true</ReserveMet>
        <SecondChanceEligible>false</SecondChanceEligible>
        <ListingStatus>Active</ListingStatus>
      </SellingStatus>
      <ShippingDetails>
        <SalesTax>
          <SalesTaxPercent>8.8</SalesTaxPercent>
          <SalesTaxState>WA</SalesTaxState>
          <ShippingIncludedInTax>false</ShippingIncludedInTax>
        </SalesTax>
        <ShippingServiceOptions/>
        <ShippingType>Flat</ShippingType>
        <ThirdPartyCheckout>false</ThirdPartyCheckout>
        <TaxTable/>
      </ShippingDetails>
      <ShipToLocations>US</ShipToLocations>
      <Site>US</Site>
      <StartPrice currencyID="USD">100.0</StartPrice>
      <SubTitle>Carefully used, New Lamkin Torsion control Grips.</SubTitle>
      <TimeLeft>P4DT17H14M6S</TimeLeft>
      <Title>9/10 Titleist 755 Forged Iron set 5-PW Stiff Shafts</Title>
      <GetItFast>false</GetItFast>
      <PostalCode>98070</PostalCode>
      <PictureDetails>
        <GalleryType>Gallery</GalleryType>
        <GalleryURL>http://i.ebayimg.com/05/!BgMK7CQBGk~$(KGrHqYH-GgEsNUGmk0cBLE
            (FHI9Gw~~_1.JPG?set_id=880000500F</GalleryURL>
        <PhotoDisplay>None</PhotoDisplay>
        <PictureURL>http://i.ebayimg.com/05/!BgMK7CQBGk~$(KGrHqYH-GgEsNUGmk0cBLE
            (FHI9Gw~~_1.JPG?set_id=880000500F</PictureURL>
        <PictureURL>http://i.ebayimg.com/24/!BgMLL-gBmk~$(KGrHqMH-GsEsMi7PV-rBLE
            (Fw61(g~~_1.JPG?set_id=880000500F</PictureURL>
        <PictureURL>http://i.ebayimg.com/02/!BgMLFiw!2k~$(KGrHqUH-GcEsO2FtftIBLE
            (Ff1d8g~~_1.JPG?set_id=880000500F</PictureURL>
      </PictureDetails>
      <DispatchTimeMax>2</DispatchTimeMax>
      <ProxyItem>false</ProxyItem>
      <BuyerGuaranteePrice currencyID="USD">20000.0</BuyerGuaranteePrice>
      <ReturnPolicy>
        <RefundOption>MoneyBack</RefundOption>
        <Refund>Money Back</Refund>
        <ReturnsWithinOption>Days_7</ReturnsWithinOption>
        <ReturnsWithin>7 Days</ReturnsWithin>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <ReturnsAccepted>Returns Accepted</ReturnsAccepted>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
        <ShippingCostPaidBy>Buyer</ShippingCostPaidBy>
      </ReturnPolicy>
      <PaymentAllowedSite>US</PaymentAllowedSite>
    </Item>
  </BidItemArray>
</GetBidderListResponse>



Back to top

GetBidderList Change History

Version Description
889
2014-08-26
  • ExtendedPictureDetails (added): This container returns the URLs of both the self-hosted and eBay Picture Service images in and .
883
2014-07-15
  • BuyerPaymentMethodCodeType (modified): The 'PayUponInvoice' enumeration value was added. This buyer payment method is for future use and will become available to the Germany site with the rollout of Progressive Checkout in October 2014. eBay/PayPal makes the determination (based on several factors) during checkout whether the buyer is eligible for 'Pay Upon Invoice'. If the buyer is offered the 'Pay Upon Invoice' option, that buyer is not required to pay for the order until an order invoice is sent by the seller.
861
2014-02-11
  • StorefrontType.StoreCategoryName (added): This field is used by eBay Stores sellers to list an item under one of their custom categories using the category name.
  • StorefrontType.StoreCategory2Name (added): This field is used by eBay Stores sellers to list an item under a second category using one of their custom categories names.
829
2013-06-19
  • ReturnPolicy.RefundOption (modified): A new 'MoneyBackOrReplacement' value is now supported. This value should be used by a seller opted in to eBay-managed returns who wants to give buyers the choice of receiving a refund for a returned item, or receiving a replacement item.
825
2013-05-22
  • ReturnPolicy.ReturnsWithinOption (modified): A new 'Months_1' value is now supported. This value indicates a one-month return policy.
817
2013-03-27
  • Item.DispatchTimeMax (modified): A DispatchTimeMax value of 0 indicates same day handling for an item, the timing of which depends on the order cut off time set in the seller's user preferences. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays).
807
2013-01-23
  • DispatchTimeMax (modified): A dispatch time value of '0' is not valid for use on eBay sites. If a listing with flat or calculated shipping has no handling time commitment, DispatchTimeMax is empty or is not returned.
801
2012-11-28
  • Item.PictureDetails.PictureURL, Item.PictureDetails.ExternalPictureURL (modified): The maximum length of PictureURL and ExternalPictureURL has been increased from 150 to 500 characters.
799
2012-11-07
  • ShippingDetailsType.InternationalShippingServiceOption (doc change): The description clarifies that a seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).
791
2012-09-12
  • InternationalShippingServiceOption.ShippingService (modified): New International shipping services added for UK and DE sites as part of the EU delivery estimate project. For UK, these new enumeration values are UK_ParcelForceIntlExpress, UK_ParcelForceIntlValue, and UK_ParcelForceIntlEconomy. For DE, these new enumeration values are DE_DeutschePostBriefIntlEcon and DE_DeutschePostBriefIntlPriority.
783
2012-07-18
  • ReturnPolicy.RestockingFeeValueOption (added): This enumeration value indicates the restocking fee charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.
  • ReturnPolicy.RestockingFeeValue (added): This value is directly related to the RestockingFeeValueOption value, with the difference being that applications can use RestockingFeeValue to present the RestockingFeeValueOption value in a more user-friendly format.
765
2012-03-14
  • Item.Seller.SellerInfo.SellereBayPaymentProcessConsent (added): This response container is returned to DE/AT sellers ramped up in the new eBay payment process. This container consists of information related to the seller's signing of the supplemental user agreement and payout preferences.
  • Item.Seller.SellerInfo.SellereBayPaymentProcessStatus (added): This response field contains an enumeration value that indicates the current status of a DE or AT seller's account related to the new eBay payment process.
735
2011-08-17
  • Item.ItemSpecifics (modified): Ticket listings return custom item specifics instead of ID-based attributes.
  • Item.ReturnPolicy.RefundOption (modified): MoneyBackOrExchange value is now supported.
  • BidItemArray.Item.PaymentMethods (deprecated): StandardPaymentMethod is no longer returned.
719
2011-04-27
  • ShippingServiceCodeType (modified): 15 new shipping services added for the Australia and Canada sites. The nine new Australia carrier-specific shipping services include AU_AusPostRegisteredPostInternationalPaddedBag1kg, AU_AusPostRegisteredPostInternationalPaddedBag500g, AU_AusPostRegisteredPostInternationalParcel, AU_AustralianAirExpressFlatRate1kg, AU_AustralianAirExpressFlatRate3kg, AU_AustralianAirExpressFlatRate5kg, AU_AustralianAirExpressMetro15kg, AU_eBayAusPost3kgFlatRateSatchel, and AU_eBayAusPost500gFlatRateSatchel. The nine new Australia generic service level shipping services include AU_EconomyDeliveryFromOutsideAU, AU_ExpeditedDeliveryFromOutsideAU, AU_ExpressDelivery, AU_Freight, and AU_StandardDelivery. The new Canada shipping service is CA_Freight.
  • Item.ShippingDetails.ShippingServiceOptions (modified): '4' has been added as a valid integer value to account for the additional international shipping service that may be specified by the seller.
  • Item.ShippingDetails.InternationalShippingServiceOption (modified): '4' and '5' have been added as valid integer values to account for the additional international shipping services that may be specified by the seller.
  • TransactionType.FinalValueFee (modified): For non-store, auction listings on North America sites, the FinalValueFee value may change upon checkout based on all costs associated with Shipping, including handling and shipping insurance charges.
689
2010-09-20
  • Item.ApplyShippingDiscount (deprecated): As of version 689, Item.ApplyShippingDiscount is deprecated and removed from the schema.
663
2010-03-31
  • ShippingType.ApplyShippingDiscount (deprecated): This tag is no longer being used. It will be officially deprecated later in 2010.
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 Managing 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.



Back to top

User-Contributed Notes