eBay Trading APIVersion 1349
 

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 this call:



Input

See also Samples.

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

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

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<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. This field is ignored if ActiveItemsOnly is set to 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 set to true. Note that for GTC items, whose end times automatically increment by 30 days every 30 days, an EndTimeTo value within the first 30 days of a listing will refer to the listing's initial end time.

Note: Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the Good 'Til Cancelled listings update in the Spring 2019 Seller Updates for more information about this change.
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 Standard input data section of the Making a Trading API call 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 Standard input data section of the Making a Trading API call 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 Standard input data section of the Making a Trading API call guide for a list of the output fields that are returned when this level is specified.
UserID UserIDType (string) Conditional The unique identifier of an eBay user.

This field is generally not required unless there are multiple User IDs tied to the requester credentials that are specified through the RequesterCredentials header. If there are multiple User IDs tied to the requester credentials, this field allows you to specify the User ID for which you wish to retrieves bids and purchases.
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.

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

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector string Optional,
repeatable: [0..*]
You can use the OutputSelector field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload.

For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example:

 If the following output selectors are used: 

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

...

...the response might look like the following

<Item>
<BuyItNowPrice currencyID="USD">0.0</BuyItNowPrice>
<ListingDetails>
<ViewItemURL>http://www.ebay.com/itm/Tag-Heuer-Mens-Watch/182879833261</ViewItemURL>
</ListingDetails>
</Item>

See OutputSelector.

Version string Conditional The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
  • It indicates the version of the code lists and other data that eBay should use to process your request.
  • It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    HTTP headers
    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) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Output

See also Samples.

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

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

<?xml version="1.0" encoding="utf-8"?>
<GetBidderListResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <Bidder> 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>
  </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
        <MaximumItemRequirements> MaximumItemRequirementsType
          <MaximumItemCount> int </MaximumItemCount>
          <MinimumFeedbackScore> int </MinimumFeedbackScore>
        </MaximumItemRequirements>
        <MaximumUnpaidItemStrikesInfo> MaximumUnpaidItemStrikesInfoType
          <Count> int </Count>
          <Period> PeriodCodeType </Period>
        </MaximumUnpaidItemStrikesInfo>
        <ShipToRegistrationCountry> boolean </ShipToRegistrationCountry>
        <ZeroFeedbackScore> boolean </ZeroFeedbackScore>
      </BuyerRequirementDetails>
      <BuyerResponsibleForShipping> boolean </BuyerResponsibleForShipping>
      <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
      <Charity> CharityType
        <CharityID> string </CharityID>
        <CharityName> string </CharityName>
        <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>
      <ItemID> ItemIDType (string) </ItemID>
      <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>
      <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
        <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 ... -->
        <IncludeeBayProductDetails> boolean </IncludeeBayProductDetails>
        <IncludeStockPhotoURL> boolean </IncludeStockPhotoURL>
        <StockPhotoURL> anyURI </StockPhotoURL>
        <UseStockPhotoURLAsGallery> boolean </UseStockPhotoURLAsGallery>
      </ProductListingDetails>
      <Quantity> int </Quantity>
      <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
      <ReturnPolicy> ReturnPolicyType
        <Description> string </Description>
        <InternationalRefundOption> token </InternationalRefundOption>
        <InternationalReturnsAcceptedOption> token </InternationalReturnsAcceptedOption>
        <InternationalReturnsWithinOption> token </InternationalReturnsWithinOption>
        <InternationalShippingCostPaidByOption> token </InternationalShippingCostPaidByOption>
        <Refund> string </Refund>
        <RefundOption> token </RefundOption>
        <ReturnsAccepted> string </ReturnsAccepted>
        <ReturnsAcceptedOption> token </ReturnsAcceptedOption>
        <ReturnsWithin> string </ReturnsWithin>
        <ReturnsWithinOption> token </ReturnsWithinOption>
        <ShippingCostPaidBy> string </ShippingCostPaidBy>
        <ShippingCostPaidByOption> token </ShippingCostPaidByOption>
      </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>
          <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
          <SafePaymentExempt> boolean </SafePaymentExempt>
          <SellerLevel> SellerLevelCodeType </SellerLevel>
          <StoreOwner> boolean </StoreOwner>
          <TopRatedSeller> boolean </TopRatedSeller>
        </SellerInfo>
        <Site> SiteCodeType </Site>
        <Status> UserStatusCodeType </Status>
        <UserID> UserIDType (string) </UserID>
        <UserIDChanged> boolean </UserIDChanged>
        <UserIDLastChanged> dateTime </UserIDLastChanged>
        <VATStatus> VATStatusCodeType </VATStatus>
      </Seller>
      <SellerVacationNote> string </SellerVacationNote>
      <SellingStatus> SellingStatusType
        <BidCount> int </BidCount>
        <BidIncrement currencyID="CurrencyCodeType"> AmountType (double) </BidIncrement>
        <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
        <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
        <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee>
        <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
        <GetItFast> boolean </GetItFast>
        <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 ... -->
        <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>
        <ThirdPartyCheckout> boolean </ThirdPartyCheckout>
      </ShippingDetails>
      <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
        <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
A value of true indicates that the user has set up an About Me page.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
Bidder.eBayGoodStanding boolean Always
This boolean field is returned as true if the eBay user is in good standing with eBay.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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 GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

See:
    Anonymous user information
    Member communications

Bidder.FeedbackPrivate boolean Always Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). The percentage of positive feedback can still be returned, even if other feedback details are private.

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

See Anonymous user information.

Bidder.FeedbackRatingStar FeedbackRatingStarCodeType Always
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.
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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

See Anonymous user information.

Bidder.IDVerified boolean Always
Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
Bidder.NewUser boolean Always This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less.
Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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 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.
Code so that your app gracefully handles any future changes to this list.

See Anonymous user information.

Bidder.Status UserStatusCodeType Always Indicates the user's registration/user status.

Applicable values: See Status.
Code so that your app gracefully handles any future changes to this list.
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".

Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

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

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

See Anonymous user information.

Bidder.UserIDLastChanged dateTime Always
Date and time when the user last changed their eBay user ID (in GMT).
Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

See 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

Code so that your app gracefully handles any future changes to this list.

See Vat-exempt sellers.

BidItemArray ItemArrayType Always Array of items the bidder has bid on, has won or has lost.
BidItemArray.Item ItemType Always,
repeatable: [1..*]
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request.

Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in the 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.
Note: When making a GetSellerList call, items that are on-hold due to an eBay policy violation will not be returned in the response.
BidItemArray.Item
  .ApplicationData
string Conditionally Return 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.

Max length: 32.
BidItemArray.Item.AutoPay boolean Always This field is included and set to if true in an Add/Revise/Relist call if the seller wants to require immediate payment from the buyer. If this field is set to false or not included, the seller is not requesting immediate payment.

Note that this field may be set to true, but that does not necessarily mean that the buyer will be required to pay right away. For example, immediate payment is not currently applicable to auctions items won in a competitive bidding process or to items where the buyer and seller negotiated the price through the Best Offer feature. Immediate payment is also not applicable to listings where the payment happens offline between the buyer and seller.
BidItemArray.Item
  .BestOfferDetails
BestOfferDetailsType Conditionally For Add/Revise/Relist/Verify calls: This container is used to enable the Best Offer feature on a listing. Note that the Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but a seller can only use Best Offer or Buy It Now, but not both. Once an auction listing receives a qualifying bid, the Best Offer feature will be turned off and any pending Best Offers or Counteroffers will no longer be valid.

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.

Note: Best Offer is not available for multi-variation listings.
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 field will not appear in the response. This field is not applicable to the Add/Revise/Relist calls.
BidItemArray.Item
  .BestOfferDetails
  .BestOfferEnabled
boolean Conditionally This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a listing as long as the category supports the Best Offer feature. To see if an eBay category supports the Best Offer feature, run a GetCategoryFeatures call, including BestOfferEnabled as a FeatureID value in the call request payload.

A listing enabled with the Best Offer feature allows a buyer to bargain with the seller and make a lower-priced offer than the fixed price or the starting bid price for an auction listing. The seller can then decide whether to accept the buyer's Best Offer price or propose a counter offer higher than the Best Offer price, but lower than the fixed price or starting bid price.

Note: The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing. If an auction listing is enabled with Best Offer, this feature will no longer be applicable once the listing receives its first qualifying bid. Note: Best Offer is not available for multi-variation listings.
BidItemArray.Item
  .BuyerGuaranteePrice
AmountType (double) Conditionally The eBay Best Price Guarantee price. The Best Price Guarantee program is only available on the eBay Australia marketplace.
BidItemArray.Item
  .BuyerGuaranteePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The eBay Best Price Guarantee price. The Best Price Guarantee program is only available on the eBay Australia marketplace.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item
  .BuyerProtection
BuyerProtectionCodeType Conditionally The enumeration value returned in this field indicates whether an item is eligible for the buyer protection.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

Applicable values: See BuyerProtection.
Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item
  .BuyerRequirementDetails
BuyerRequirementDetailsType Conditionally This container is returned if the seller has applied one or more buyer requirement criteria to the listing. Buyer requirement settings are managed in the Selling Preferences section of the seller's account in My eBay.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
MaximumItemRequirementsType Conditionally This container is returned if the seller has set a maximum quantity threshold buyer requirement. With this buyer requirement, a buyer is limited in regards to the quantity of a line item that may be purchased.

This buyer requirement is only applicable to fixed-price listings where multiple quantity is available for purchase.

In addition to setting a maximum quantity threshold buyer requirement, the seller can also choose to apply this threshold to only those prospective buyers who don't meet or exceed the minimum Feedback score threshold.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
  .MaximumItemCount
int Conditionally This field indicates the maximum quantity of a line item that one prospective buyer may purchase from the listing.

This buyer requirement is only applicable to fixed-price listings where multiple quantity is available for purchase.

If the MinimumFeedbackScore field is also set/returned, the maximum quantity threshold value will only apply to those prospective buyers who don't meet or exceed the minimum Feedback score threshold returned in that field. If the MinimumFeedbackScore field not set/returned, the maximum quantity threshold value will apply to all prospective buyers.

This field is always returned along with the MaximumItemRequirements container.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
  .MinimumFeedbackScore
int Conditionally If this field is returned, it indicates that the seller has set a maximum quantity threshold value, but this maximum quantity threshold value (returned in MaximumItemCount will only apply to those prospective buyers who don't meet or exceed the minimum Feedback score threshold returned in this field. If this field is not returned, the maximum quantity threshold value will apply to all prospective buyers.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
MaximumUnpaidItemStrikesInfoType Conditionally This container is returned if the seller has enabled a setting to block prospective buyers who have one or more unpaid items and/or buyer-initiated cancellations on their account during a specified time period.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .Count
int Conditionally This integer value indicates the maximum number of unpaid items and/or buyer-initiated cancellations that a prospective buyer is allowed to have during a specified time period (MaximumUnpaidItemStrikesInfo.Period) before being blocked from buying or bidding on the item.
BidItemArray.Item
  .BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .Period
PeriodCodeType Conditionally This enumerated value defines the length of time over which a prospective buyer's unpaid items and/or buyer-initiated cancellations will be counted. If the prospective buyer's number of unpaid items and/or buyer-initiated cancellations during this defined period exceeds the value set in the MaximumUnpaidItemStrikesInfo.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 items and/or buyer-initiated cancellations is blocked from buying/bidding on the item.

Applicable values:

CustomCode
(out) This value is reserved for future or internal use.
Days_180
(out) This value indicates that the evaluation period is set back 180 days (approximately 6 months) from the present date.
Days_30
(out) This value indicates that the evaluation period is set back 30 days from the present date.
Days_360
(out) This value indicates that the evaluation period is set back 360 days (approximately 12 months) from the present date.

Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item
  .BuyerRequirementDetails
  .ShipToRegistrationCountry
boolean Conditionally This field is returned as true if the seller has enabled the setting to block buyers/bidders who reside (according to their eBay primary shipping address) in countries that are on the seller's ship-to exclusion list.

Default: false.
BidItemArray.Item
  .BuyerRequirementDetails
  .ZeroFeedbackScore
boolean Conditionally This field is returned as true if the seller has enabled the setting to block buyers/bidders with a feedback score of 0 from buying items.

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. (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.
BidItemArray.Item
  .BuyItNowPrice
AmountType (double) Always This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.
BidItemArray.Item
  .BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item.Charity CharityType Conditionally This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from each sale of an item through an auction or fixed-price listing. Charity names and IDs can be found by going to eBay for Charity page and doing a search. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent.

When it comes to revising an auction or fixed-price listing, you can add a benefitting charity (as long as there is at least 12 hours left before end of listing/close of auction), but you cannot remove or change a nonprofit company once one is already established in the original listing.

For Revise calls: The non-profit organization and donation percentage can now be modified in a Revise call as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing.

This container will only be returned in Get calls for charitable listings. Charitable listings are only supported in the US and UK marketplaces.

See:
    Buying and selling on eBay to benefit nonprofit organizations
    Charitable listings

BidItemArray.Item.Charity
  .CharityID
string Conditionally The unique identifier that eBay creates and assigns to each nonprofit organization.

The field is conditionally required in an Add/Revise/Relist call if the seller will be donating a percentage of the sale proceeds to this organization for each sale generated by the listing.
BidItemArray.Item.Charity
  .CharityName
string Conditionally The full name of the nonprofit organization.


Max length: 150.
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 eBay for Charity listing. Possible values: 10.0 to 100.0. The DonationPercent field is required in an Add/Revise/Relist call if the seller will be donating a percentage of the sale proceeds for each sale generated by the listing.
BidItemArray.Item.Charity
  .LogoURL
string Conditionally The full URL to the nonprofit organization's logo image file. This logo image file is the image that is displayed in all eBay listings that benefit that charity. This field is returned as long as it is defined for the nonprofit organization.
BidItemArray.Item.Charity
  .Mission
string Conditionally The stated mission of the nonprofit charity organization. This mission statement is displayed in the eBay for Charity section of the View Item page.


Max length: 511.
BidItemArray.Item.Charity
  .Status
CharityStatusCodeType Conditionally This enumeration value indicates whether or not the nonprofit organization is a valid eBay for Charity organization, and is able to receive proceeds from eBay sales.

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 PayPal Giving Fund.
Valid
(out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the PayPal Giving Fund.

Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item.Country CountryCodeType Always This two-digit enumeration value indicates the country of the seller's registration address. CountryCodeType defines the supported values. The GeteBayDetails call can also be used (include the DetailName field and set its value to CountryDetails) to see the full list of supported country codes.

In an Add/Revise/Relist/Verify call, this field is required.

Applicable values: See Country.
Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item.Currency CurrencyCodeType Always In an Add/Revise/Relist/Verify call, this required three-digit enumeration value defines the currency associated with the listing site. The item price and all costs passed in the call request will be using this currency. Similarly, the listing fees and other cost-related data will be using this currency. Since the Trading API can only be used for a select number of eBay sites, only a subset of values are supporting when adding/revising/relisting an item. These supported values are discussed in the top section of CurrencyCodeType.

In 'Get' calls, it is possible that any of the values in CurrencyCodeType may appear, as some cost-related fields will show the buyer's currency type.

Applicable values: See Currency.
Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item
  .DisableBuyerRequirements
boolean Conditionally This field can be included and set to true in an Add or Revise call if the seller wishes to disable all buyer requirements (that are set in the seller's account) for the listing. (from Item.BuyerRequirementDetails or Buyer requirements preferences in My eBay) are ignored.

This field will only be returned in 'Get' calls if true.
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).

Note: If the seller opts into the eBay Guaranteed Delivery feature and wants to make a listing eligible for eBay Guaranteed Delivery, the DispatchTimeMax value must be set to 0 or 1 (days) and the cumulative value of DispatchTimeMax plus the transit time of the shipping service (returned in ShippingServiceDetails.ShippingTimeMax field of GeteBayDetails) must be 4 business days or less to be eligible for this feature. See the eBay Guaranteed Delivery page in Seller Center for more information on this program. The eBay Guaranteed Delivery feature is only available on the US and Australia marketplaces.
For Add/Revise/Relist calls: Required for listings in certain categories when certain shipping services (with delivery) are offered. See HandlingTimeEnabled in GetCategoryFeatures.

The seller sets this to a positive integer value corresponding to the number of 'handling' days. For a list of allowed values on each eBay site, use DispatchTimeMaxDetails in GeteBayDetails. Supported handling times for most sites in most categories range from 0 (same-day handling) to 3 business days, but this can vary by site. Some categories on some sites support longer handling times, and this generally comes into play with extremely large items where freight shipping may be required.

This field is required whenever flat-rate or calculated shipping is used, but does not apply when there is no shipping involved, which is the case for digital gift card listings, or any orders where local pickup is available and this option is selected by the buyer.

For ReviseItem only: If the listing has bids or sales and it ends within 12 hours, you can't change this value. If the listing is a GTC listing that has sales or ends within 12 hours (one or the other, but not both), you can add or change this value. If the listing has no bids or sales and more than 12 hours remain before the listing ends, you can add or change the dispatch (handling) time.

For GetItem: GetItem returns DispatchTimeMax only when shipping service options are specified for the item and the seller specified a dispatch time.

See:
    Handling time
    (GetCategoryFeatures) Category.HandlingTimeEnabled for categories that support handling times

BidItemArray.Item
  .FreeAddedCategory
CategoryType Conditionally The unique identifier for a secondary category that eBay has added as a free promotion. You cannot add this yourself. This container is only returned if the item was listed in a single category and eBay added a free secondary category.
BidItemArray.Item
  .FreeAddedCategory.CategoryID
string Conditionally This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.

In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.

Max length: 10.
BidItemArray.Item
  .FreeAddedCategory
  .CategoryName
string Conditionally This string value is the display name of the eBay primary category, as it would appear on the eBay site. In GetItem, this will be a fully-qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).
BidItemArray.Item.ItemID ItemIDType (string) Always The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

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. Your code should be prepared to handle IDs of up to 19 digits.
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.

In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values.
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.)
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item
  .ListingDetails
  .BuyItNowAvailable
boolean Conditionally 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 Indicates whether or not the seller's Checkout Enabled preference is turned on.
Note: A 'Checkout Enabled' setting is no longer available to sellers, and this field is always returned as true. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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.
Note: The ListingDetails.ConvertedBuyItNowPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.
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.
Note: The ListingDetails.ConvertedBuyItNowPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The ListingDetails.ConvertedReservePrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.
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.
Note: The ListingDetails.ConvertedReservePrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The ListingDetails.ConvertedStartPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.
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.
Note: The ListingDetails.ConvertedStartPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024.

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.
Note: The HasPublicMessages field will stop being returned in GetItemTransactions and GetSellerTransactions, on January 31, 2024.
BidItemArray.Item
  .ListingDetails
  .HasReservePrice
boolean Always If true, the seller specified a value in ReservePrice.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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 will reflect the last relist.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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).
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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 ?. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item
  .ListingDuration
token Conditionally Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time.

The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable).

The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information.

When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours.

Note: As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
  • The following eBay Motors US categories are exempt from this change: Cars & Trucks (6001), Motorcycles (6024), Other Vehicles & Trailers (6038), Boats (26429), Powersports (66466).
  • All child categories under Cars, Motorcycles & Vehicles (9800) categories on the eBay UK and eBay Italy sites are also exempt from this change.
If any other listing duration value besides GTC is specified in this field, it will be ignored, and GTC will be used instead.


Applicable values: See ListingDurationCodeType
BidItemArray.Item
  .ListingEnhancement
ListingEnhancementsCodeType Conditionally,
repeatable: [0..*]
Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade.

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

Applicable values:

BoldTitle
(in/out) This value is used if the seller wants the listing title to be in boldface type. This feature will incur a listing fee. Note that this enhancement will not put the listing subtitle in boldface type (if a subtitle is used).
CustomCode
(in/out) Reserved for internal or future use.

Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item.ListingType ListingTypeCodeType Always The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction

For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings.

This field is not applicable to Revise calls because the selling format of active listings cannot be changed.

Applicable values:

AdType
(in/out) This enumeration value represents a classified ad in a Real Estate category. This listing type is only used to solicit inquiries from interested parties. 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.

Although listing durations may vary by eBay marketplace and category, typical listing durations for real estate ads are 30 and 90 days. It is recommended that the seller uses the GetCategoryFeatures call to retrieve the actual listing durations that are supported for real estate ads on a particular marketplace and category.
Chinese
(in/out) This value indicates an auction listing. In an auction listing, prospective buyers engage in a competitive bidding process, although Buy It Now may be offered as long as no bids have been placed. Auctions occur on the eBay marketplace site, and the auction listings will also appear in the seller's eBay Store (if the seller has an eBay Store).

Although listing durations may vary by eBay marketplace and category, typical listing durations for auctions are 3, 5, 7, and 10 days. It is recommended that the seller uses the GetCategoryFeatures call to retrieve the actual listing durations that are supported for auctions on a particular marketplace and category.
CustomCode
(in/out) Reserved for internal or future use.
FixedPriceItem
(in/out) With this listing format, the selling is offering the item at a fixed price, although it is still possible for the seller to negotiate the price with prospective buyers using the Best Offer feature. A fixed-price listing can offer a single item, or if the seller has multiple quantity of the same item, multiple quantity of that same item can be made available for sale through the same listing. Additionally, the seller can set up a multiple-variation, fixed-price listing, where similar items can be sold through the same listing. An example of a multiple-variation, fixed-price listing might be a t-shirt (or another article of clothing) that is available in multiple color and size combinations.

Traditionally, listing durations for fixed-prices listings have varied by eBay marketplace and category. Typical listing durations for fixed-price listings ranged from three to 30 days, or GTC (Good 'Til Cancelled). As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
  • The following eBay Motors US categories are exempt from this change: Cars & Trucks (6001), Motorcycles (6024), Other Vehicles & Trailers (6038), Boats (26429), Powersports (66466).
  • All child categories under Cars, Motorcycles & Vehicles (9800) categories on the eBay UK and eBay Italy sites are also exempt from this change.

With the 'GTC' listing duration, the listing will remain active as long as the listing shows that inventory is available for purchase (available quantity is '1' or more). For sellers listing motor vehicles on the eBay US Motors, eBay UK, or eBay Italy sites, it is recommended that the seller uses the GetCategoryFeatures call to retrieve the supported listing durations for their particular marketplace and category.

Note: As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the Good 'Til Cancelled listings update in the Spring 2019 Seller Updates for more information about this change.
LeadGeneration
(in/out) This enumeration value represents a (non-Real Estate) classified ad listing. The AdType enumeration value represents Real Estate classified ads. This listing type is only used to solicit inquiries from interested parties. 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. Non-Real Estate classified ads are only available in a limited number of eBay categories, including Business and Industrial categories, Travel, ans Specialty Services.

Although listing durations may vary by eBay marketplace and category, typical listing durations for (non-Real Estate) classified ads are 30, 60, and 90 days. It is recommended that the seller uses the GetCategoryFeatures call to retrieve the actual listing durations that are supported for real estate ads on a particular marketplace and category.

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

Code so that your app gracefully handles any future changes to this list.

See Listing types.

BidItemArray.Item.Location string Always Indicates the geographical location of the item (along with the value in the Country field). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours.

If you do not specify Location, you must specify Item.PostalCode. If you specify a postal code, but do not specify a location, then the location is given a default value derived from the postal code.

For the Classified Ad format for motors vehicle listings, the value provided in the Location field 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.

Max length: 45.
BidItemArray.Item
  .LocationDefaulted
boolean Conditionally If true, 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.
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.

Max: 450,000.
BidItemArray.Item
  .PaymentDetails
PaymentDetailsType Conditionally This container is used in an Add/Revise/Relist/Verify call if the seller is selling a motor vehicle. It is used by the seller to specify the amount of the initial deposit, and the due dates for the deposit and the full payment for a motor vehicle listing.

Note: If you are using business policies with your listing, the details set up in this container will instead be set up via the payment business policy. Payment business policies are associated with the listing via the SellerProfiles.SellerPaymentProfile container.
This container will only be returned in 'Get' calls for motor vehicle listings where an initial deposit is required for that vehicle.

See eBay motors offline payment methods.

BidItemArray.Item
  .PaymentDetails
  .DaysToFullPayment
int Conditionally This field is used to set the due date (in days) for the buyer to pay off the full balance of the motor vehicle. The "clock starts" on the full payment due date as soon as the buyer commits to buying the vehicle by clicking the Buy It Now button, by winning the auction, or by the seller accepting that buyer's Best Offer/counteroffer. The three supported values here are 3, 7 (default), 10, and 14 days.

The seller must specify one or more of the following offline payment methods in the listing. The buyer will be expected to use one of these payment method options to pay the full balance of the motor vehicle.
  • CashOnPickup
  • MOCC (money order or cashier's check)
  • PersonalCheck

Min: 3. Max: 14. Default: 7.
BidItemArray.Item
  .PaymentDetails.DepositAmount
AmountType (double) Conditionally This dollar value indicates the amount of the initial deposit on the vehicle required from the buyer.

If the immediate payment requirement is set for the listing (see Item.AutoPay description), and the listing qualifies for immediate payment (e.g. the Buy It Now button is used), the deposit will be required immediately, and the HoursToDeposit field (if set) will not be applicable. If immediate payment is required for a motor vehicle deposit, the value input into this field cannot exceed '500.0', or an error will occur.

If there is no immediate payment requirement set for the listing the deposit will be required in 24, 48, or 72 hours after commitment to purchase (see the HoursToDeposit field). If immediate payment is not required for a motor vehicle deposit, the value input into this field cannot exceed '2000.0', or an error will occur.

If this field is not included in an Add/Revise call, its value defaults to '0.0', which would technically mean that a deposit is not required, even if the DepositType and HoursToDeposit fields were included.

Motor vehicle deposit details will be shown to prospective buyers in the listing. The available payment methods for the deposit will be shown on the checkout page once the buyer clicks the the Buy It Now button.

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.

Max: 500.0 (if immediate payment required); 2000.0 (if immediate payment not required).
BidItemArray.Item
  .PaymentDetails.DepositAmount
  [ attribute currencyID ]
CurrencyCodeType Conditionally This dollar value indicates the amount of the initial deposit on the vehicle required from the buyer.

If the immediate payment requirement is set for the listing (see Item.AutoPay description), and the listing qualifies for immediate payment (e.g. the Buy It Now button is used), the deposit will be required immediately, and the HoursToDeposit field (if set) will not be applicable. If immediate payment is required for a motor vehicle deposit, the value input into this field cannot exceed '500.0', or an error will occur.

If there is no immediate payment requirement set for the listing the deposit will be required in 24, 48, or 72 hours after commitment to purchase (see the HoursToDeposit field). If immediate payment is not required for a motor vehicle deposit, the value input into this field cannot exceed '2000.0', or an error will occur.

If this field is not included in an Add/Revise call, its value defaults to '0.0', which would technically mean that a deposit is not required, even if the DepositType and HoursToDeposit fields were included.

Motor vehicle deposit details will be shown to prospective buyers in the listing. The available payment methods for the deposit will be shown on the checkout page once the buyer clicks the the Buy It Now button.

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 In order for a seller to require a motor vehicle deposit from a buyer, this field must be included and set to OtherMethod. Otherwise, the field will default to None and a deposit will not be required.
Default: None.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
None
(in/out) This value indicates that no deposit is required.
OtherMethod
(in/out) This value indicates that a deposit is required from the buyer when purchasing a motor vehicle. Deposits for a motor vehicle are either due in 24, 48, or 72 hours after commitment to purchase. Or, in the case of a motor vehicle listing that is requiring immediate payment, the deposit it due immediately after commitment to purchase.

This value should be used in an Add/Revise call if the seller is requiring a deposit for a motor vehicle listing.

Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item
  .PaymentDetails.HoursToDeposit
int Conditionally This field is used to set the due date (in hours) for the motor vehicle deposit. The deposit amount is specified in the DepositAmount field. The "clock starts" on the deposit due date as soon as the buyer commits to buying the vehicle by clicking the Buy It Now button, by winning the auction, or by the seller accepting that buyer's Best Offer/counteroffer. The three supported values here are 24, 48 (default), and 72 hours.

Note: If the immediate payment requirement is set for the listing (see Item.AutoPay description), and the listing qualifies for immediate payment (e.g. the Buy It Now button is used), the HoursToDeposit field will not be applicable, since the buyer will be required to pay any deposit amount immediately (and not within 1, 2 or 3 days).

Min: 24 (hours). Max: 72 (hours). Default: 48 (hours).
BidItemArray.Item
  .PaymentMethods
BuyerPaymentMethodCodeType Conditionally,
repeatable: [0..*]

For Add/Revise/Relist calls: A PaymentMethods field is required for each offline payment method supported by the seller for the listing.
Note: Sellers no longer have to specify any electronic payment methods for listings, so one or more PaymentMethods fields will only be needed for listings that require/support payments off of eBay's platform. If an electronic payment is supplied in a PaymentMethods field, a warning will be triggered and the payment method will be dropped. Note: If you are already referencing a payments business policy in an Add/Revise/Relist call with the SellerProfiles.SellerPaymentProfile container, no PaymentMethods fields will be needed, as these settings will already be set in the payments business policy. Payment methods are not applicable to any classified ad listings, as any agreement and payment is handled off of the eBay platform.

For Get calls that return PaymentMethods fields : One or more PaymentMethods fields will only be returned if the seller set one or more offline payment methods for the listing.
Note: This field will stop being returned in order management calls on January 31, 2024.

Applicable values:

CashOnPickup
(in/out) This enumeration value indicates that cash on pickup is accepted for payment. This value is only applicable for offline payments.
CustomCode
(in/out) Reserved for internal or future use.
MOCC
(in/out) This enumeration value indicates that a money order or cashiers check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.
PersonalCheck
(in/out) This enumeration value indicates that a personal check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.

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

Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item
  .PayPalEmailAddress
string Conditionally This field is no longer applicable, and should not be used.
BidItemArray.Item
  .PictureDetails
PictureDetailsType Conditionally This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture.

See:
    Add pictures
    Adding photos to your listing

BidItemArray.Item
  .PictureDetails.PictureURL
anyURI Conditionally,
repeatable: [0..*]
Contains the URL for a picture of the item. The URL can be from the eBay Picture Services (images previously uploaded) or from a server outside of eBay (self-hosted). You can pass in up to 24 picture URLs for each listing, but you cannot mix self-hosted and EPS-hosted URLs in the same listing. The UploadSiteHostedPictures call can be used to upload pictures to EPS. Note that if pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. URLs using the 'http' protocol will not be allowed.

Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors).

Note: If a URL contains spaces, those spaces can be replaced with %20. For example, https://example.com/my image.jpg must be submitted as https://example.com/my%20image.jpg to replace the space in the image file name. However, a semicolon character (;) cannot be replaced with %20, so a semicolon cannot be a part of the URL, as an error will occur. The Gallery image will be the first PictureURL in the array of PictureURL fields.

Note: All images, whether they are hosted by EPS or self-hosted, must comply with eBay picture requirements, including the requirement that all images must be at least 500 pixels on its longest side. If the image does not satisfy the 500 pixels requirement, the listing may be blocked. For more information about other requirements and tips for adding pictures to listings, see the Adding pictures to your listings help page. To specify multiple pictures, send each URL in a separate, PictureDetails.PictureURL element. The first URL passed in defaults to be the 'gallery image', and will be the first picture that is shown when a user lands on the View Item page.

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

For VerifyAddItem only: You must include a picture even when using VerifyAddItem. If you don't have a image file, you can use the following fake eBay Picture Services URL (https://i2.ebayimg.com/abc/M28/dummy.jpg) with this call.

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. You cannot remove all the PictureURL fields from a listing because each listing requires at least one picture.

Remember: The 'gallery image' will be the first PictureURL in the array of PictureURL fields. So, if the first image passed in when relisting/revising is different from when the listing was created, the 'gallery image' will be changed.

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.
Max length: 500.

See Add pictures.

BidItemArray.Item.PostalCode string Conditionally Postal code of the place where the item is located. This value is used for proximity searches. To remove this value when revising or relisting an item, use DeletedField. If you do not specify PostalCode, you must specify Item.Location. If you specify PostalCode, but do not specify Item.Location, then Item.Location is given a default value derived from the postal code.

Note: As of late January 2020, the displayed postal code returned in GetItem is now masked to all users except for the seller of the item. Different countries will mask postal/zip codes in slightly different ways, but an example would be 951**.
BidItemArray.Item
  .PrimaryCategory
CategoryType Always This container is used in an Add/Revise/Relist call to set the primary listing category. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

If you do not know the appropriate eBay category for your product, you can use the GetSuggestedCategories call. Once you know your category, and want to know which listing features it supports, you can use the GetCategoryFeatures call. To discover required, recommended, and optional Item Specifics for a category, use the getItemAspectsForCategory method of the Taxonomy API.

If you do use an eBay catalog product, it is advised that you do not include this field, as any primary category ID you specify in this field may get dropped if this category is different than the primary category defined in the eBay catalog product.

For ReviseItem only: When revising a listing, you can change the primary category only if an auction listing has no bids or a multiple-quantity, fixed-price listing has no sales, and the listing does not end within 12 hours. If you change the listing category, any Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the new category.

When you list an event ticket on the US site, you must specify one of the leaf categories under the Tickets & Experiences meta category.

See:
    Applying Categories
    Maintaining Category Data

BidItemArray.Item
  .PrimaryCategory.CategoryID
string Always This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.

In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.

Max length: 10.
BidItemArray.Item
  .PrimaryCategory.CategoryName
string Always This string value is the display name of the eBay primary category, as it would appear on the eBay site. In GetItem, this will be a fully-qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).
BidItemArray.Item
  .PrivateListing
boolean Always A true value in this field indicates that the listing is private. Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.

For ReviseItem/ReviseFixedPriceItem: The seller will not be able change this setting if the listing has any pending bids, any pending best offers, previous sales (for multiple-quantity, fixed-price listing), or if the listing will end within 12 hours.
BidItemArray.Item
  .ProductListingDetails
ProductListingDetailsType Conditionally This container is used to provide one or more product identifiers for a product, and if desired by the seller, eBay will use the identifier(s) of the product to try to match it to a defined product in the eBay catalog. If a seller's product is matched to an eBay catalog product, the product details associated with that catalog product will be prefilled for the listing. Product details defined for a catalog product include the product title, product description, product aspects, and stock image(s) of the product (if available).

In some eBay categories, one or more product identifier types (e.g. UPC or ISBN) may be required, but the category may not have any eBay catalog products defined, or the category does not allow listings to be created using a catalog product. Note that the GetCategoryFeatures call can be used to retrieve supported/required product identifier types.

Note: If a product identifier type is required, the corresponding field must be used, even if the seller is not interested in finding an eBay catalog product match. A large percentage of eBay US categories require one or more product identifier types when listing an item. See the Structured Data - Product Identifiers help page for more information on which eBay US categories require which product identifier types. If known, an ePID (specified through the ProductReferenceID field) is always the best bet to find an eBay catalog product match, although an EAN, ISBN, UPC, or Brand/MPN pair can also be used in an attempt to find a catalog product match. If a Brand/MPN pair is required for the product, these values must be input through the BrandMPN container.
When you use ProductListingDetails, in an Add/Revise/Relist call, you must specify at least one GTIN, a ProductReferenceID (also known as an ePID), or a Brand/MPN pair. If you specify more than one GTIN value, eBay uses the first one that matches a product in eBay's catalog.

For ReviseItem and RelistItem only: When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product identifier and you cannot remove existing product listing details 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.
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 if the seller used an eBay catalog product to list the item.
BidItemArray.Item
  .ProductListingDetails
  .IncludeeBayProductDetails
boolean Conditionally This boolean field controls whether or not an eBay catalog product is used to create or revise a listing. If an ePID or GTIN value is provided through the ProductListingDetails container when adding, revising, or relisting an item, the default behavior is for eBay to try and find a match for the product in the eBay catalog, and then automatically create/revise the listing using the product title, product description, item specifics, and stock photo defined for the catalog product.

If the seller wants to use an eBay catalog product to create/revise a listing, the seller can include this field and set its value to true, or just omit this field, as its default value is true. If a seller doesn't want use an eBay catalog product to create/revise their listing, this field should be included and set to false. If the seller declines to use an eBay catalog product, they will be required to pass in their own listing title, listing description, item specifics, a listing category, and at least one picture.
BidItemArray.Item
  .ProductListingDetails
  .IncludeStockPhotoURL
boolean Conditionally If this value is true, the listing will use the eBay catalog product's stock photo. In an Add/Revise/Relist call, this field is set to true by default. If you will be using an eBay catalog product to list your item, it is always advised to include the stock photo. Sellers can also add their own pictures using one or more Item.PictureDetails.PictureURL fields. Seller photos are particularly recommended for used and modified products to give prospective buyers a clear sense of exactly what they are purchasing. In GetItem and other 'Get' calls, the URL of the stock photo will be returned in the StockPhotoURL field.

See Using eBay stock photos.

BidItemArray.Item
  .ProductListingDetails
  .StockPhotoURL
anyURI Conditionally The full URL for the eBay catalog product's stock photo. This field is only returned if the seller used an eBay catalog product to list the item, and the IncludeStockPhotoURL field was set to true.
BidItemArray.Item
  .ProductListingDetails
  .UseStockPhotoURLAsGallery
boolean Conditionally If this value is true, the listing will use the eBay catalog product's stock photo as the Gallery thumbnail photo. In an Add/Revise/Relist call, this field is set to true by default. If this field is set to true, the IncludeStockPhotoURL field must also be set to true or this field will have no effect. Sellers can also add their own pictures using one or more Item.PictureDetails.PictureURL fields, but none of these photos will be the Gallery thumbnail photo.

See Stock photo as gallery image.

BidItemArray.Item.Quantity int Always For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1.

For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and three items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.

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

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.

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

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.
BidItemArray.Item.ReservePrice AmountType (double) Conditionally This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder.

As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit.

In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item.

See:
    Revise a US eBay motors listing
    Setting a reserve price (eBay help topic)
    Fees for optional listing upgrades (eBay help topic)

BidItemArray.Item.ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder.

As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit.

In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item.ReturnPolicy ReturnPolicyType Conditionally Describes the seller's return policy. Most categories on most eBay sites require the seller to clearly specify whether or not returns are accepted (see ReturnsAcceptedOption).
Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container.
Note: If you are using a return business policy set up through My eBay or via the Account API, then you should not populate the fields in this ReturnPolicy container. Instead, indicate your return policy using the SellerProfiles.SellerReturnProfile container.

However, if you do not configure a return policy, all the fields in this ReturnPolicy container that are marked conditional must be populated in your request.

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

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.

Note: The GeteBayDetails call can be used to retrieve site-wide return policy metadata, but it is recommended that sellers use the GetCategoryFeatures call instead, as this call was recently updated to retrieve category-level metadata for both domestic and international return policies.
Note: In May 2018, eBay added the ability to create a separate international return policy for items that are shipped to international customers. If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead for international returns. For more information on setting separate domestic and international return policies, see the International returns policy help topic. For the international equivalent of this field, see the InternationalRefundMethodValues field.

GranularityLevel: Fine, Medium.

See Specify a return policy.

BidItemArray.Item.ReturnPolicy
  .Description
string Conditionally This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored):
  • Germany (DE)
  • Austria (AT)
  • France (FR)
  • Italy (IT)
  • Spain (ES)
Where valid, sellers can use this field to add details about their return policies. eBay uses this text string as-is in the additional details 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: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Max length: 8000 (for DE, AT); 5000 (for FR, IT, ES).

GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy
  .InternationalRefundOption
token Conditionally This field indicates how the seller compensates international buyers for returns. MoneyBack is the only supported value for all marketplaces except for the US. On the US marketplace, you can set this value to either MoneyBack or MoneyBackOrReplacement. MoneyBackOrReplacement can be used by sellers that have the depth of inventory to support an exchange for an identical item. However, ultimately, it is up to the buyer on whether they want money back or a replacement item.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the refund option(s) for international returns will default to the value specified in the RefundOption field.

GranularityLevel: Fine, Medium.

See International Refund Methods (in GetCategoryFeatures) for supported international refund value for each site and category.



Applicable values: See RefundOptionsCodeType
BidItemArray.Item.ReturnPolicy
  .InternationalReturnsAcceptedOption
token Conditionally This field is conditionally required if a seller wants to use a separate return policy for international returns. The value in this field indicates whether or not the seller accepts returns from international buyers.

Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows international buyers to return items. Specify ReturnsNotAccepted for a listing if returns are not accepted from international buyers.

On the eBay DE, IE, and UK, registered 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. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the return accepted value for international returns will default to the value specified in the ReturnsAcceptedOption field.

GranularityLevel: Fine, Medium.

See International Returns Accepted Values (in GetCategoryFeatures) for supported international returns accepted values for each site and category.



Applicable values: See ReturnsAcceptedOptionsCodeType
BidItemArray.Item.ReturnPolicy
  .InternationalReturnsWithinOption
token Conditionally This field is conditionally required if a seller is using a separate return policy for international returns, and is accepting international returns. The value in this field indicates the number of days that an international buyer has to return an item. The time period begins on the day that the buyer receives the item. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing.

Applicable values: Retrieve the values supported by a marketplace and category by calling GetCategoryFeatures with FeatureID set to InternationalReturnsDurationValues, then see the values returned under the Category.InternationalReturnsDurationValues container in the response.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts international returns (InternationalReturnsAcceptedOption is set to ReturnsAccepted) but does not specify this field for a listing, eBay sets a default value (often Days_30) and the seller is obligated to honor this setting.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the return period for international returns will default to the value specified in the ReturnsWithinOption field.

GranularityLevel: Fine, Medium.

See International Return Durations (in GetCategoryFeatures) for supported international return durations for each site and category.



Applicable values: See ReturnsWithinOptionsCodeType
BidItemArray.Item.ReturnPolicy
  .InternationalShippingCostPaidByOption
token Conditionally This field is conditionally required if a seller is using a separate return policy for international returns, and is accepting international returns. The value in this field specifies whether the buyer or the seller pays for international return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field, and sellers are obligated to honor the values that are set for a listing.

Depending on the seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues or for late shipments.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, return shipping cost payee for international returns will default to the value specified in the ShippingCostPaidByOption field.

GranularityLevel: Fine, Medium.

See Return Shipping Cost Payee Values (in GetCategoryFeatures) for supported international return shipping cost payee values for each site and category.



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

This field is applicable to only the US marketplace and is not applicable as input to the Add/Revise/Relist family of calls. (Use RefundOption instead.)

GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy
  .RefundOption
token Conditionally This field indicates how the seller compensates buyers for returns. MoneyBack is the only supported value for all marketplaces except for the US. On the US marketplace, you can set this value to either MoneyBack or MoneyBackOrReplacement. MoneyBackOrReplacement can be used by sellers that have the depth of inventory to support an exchange for an identical item. However, ultimately, it is up to the buyer on whether they want money back or a replacement item.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalRefundOption field.

GranularityLevel: Fine, Medium.

See Domestic Refund Methods (in GetCategoryFeatures) for supported domestic refund value for each site and category.



Applicable values: See RefundOptionsCodeType
BidItemArray.Item.ReturnPolicy
  .ReturnsAccepted
string Conditionally Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces.

If necessary, you can predict the choice of values based on the ReturnsAccepted.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.)

GranularityLevel: Fine, Medium.
BidItemArray.Item.ReturnPolicy
  .ReturnsAcceptedOption
token Conditionally This required field indicates whether or not the seller accepts returns.

Applicable values are ReturnsAccepted or ReturnsNotAccepted. When set to ReturnsAccepted, this option indicates the seller allows items to be returned. Specify ReturnsNotAccepted for a listing if returns are not accepted.

On the eBay DE, IE, and UK marketplaces, registered 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. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response.

Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (ReturnsAcceptedOption = ReturnsAccepted) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the Item.DispatchTimeMax field.
For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalReturnsAcceptedOption field.

GranularityLevel: Fine, Medium.

See Domestic Returns Accepted Values (in GetCategoryFeatures) for supported domestic returns accepted values for each site and category.



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 Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

Applicable values: Retrieve the values supported by a marketplace and category by calling GetCategoryFeatures with FeatureID set to DomesticReturnsDurationValues, then see the values returned under the Category.DomesticReturnsDurationValues container in the response.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalReturnsWithinOption field.

GranularityLevel: Fine, Medium.

See Domestic Return Durations (in GetCategoryFeatures) for supported domestic return durations for each site and category.



Applicable values: See ReturnsWithinOptionsCodeType
BidItemArray.Item.ReturnPolicy
  .ShippingCostPaidBy
string Conditionally This is a 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 This option specifies whether the buyer or the seller pays for return shipping charges. Accepted values are Buyer or Seller. eBay sites often set Seller as the default value for this field, and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted.

Depending on the seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues or for late shipments.

For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description.

Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalShippingCostPaidByOption field.

GranularityLevel: Fine, Medium.

See Return Shipping Cost Payee Values (in GetCategoryFeatures) for supported domestic return shipping cost payee values for each site and category.



Applicable values: See ShippingCostPaidByOptionsCodeType
BidItemArray.Item.ReviseStatus ReviseStatusType Always This container is returned if a listing has been revised in any way since it first became active. One or more boolean fields will be returned under this container based on the type of revision(s) that occured, including a general revision, a price change, or a feature added or removed.
BidItemArray.Item.ReviseStatus
  .BuyItNowAdded
boolean Conditionally This field is returned as true if a Buy It Now price has been added to the auction listing. This field is only returned if the original auction listing did not have a Buy It Now price, but a revision to that original listing included adding a Buy It Now price.
BidItemArray.Item.ReviseStatus
  .BuyItNowLowered
boolean Conditionally This field is returned as true if the Buy It Now price on the original auction listing was lowered as part of a revision to the original auction listing. This field is only returned if the Buy It Now price on the original auction listing was lowered as part of a revision to the original auction listing.
BidItemArray.Item.ReviseStatus
  .ItemRevised
boolean Always This field is returned as true if the original listing has been revised. This field is always returned with the ReviseStatus container.
BidItemArray.Item.ReviseStatus
  .ReserveLowered
boolean Conditionally This field is returned as true if the Reserve price on the original auction listing was lowered as part of a revision to the original auction listing. This field is only returned if the Reserve price on the original auction listing was lowered as part of a revision to the original auction listing.
BidItemArray.Item.ReviseStatus
  .ReserveRemoved
boolean Conditionally This field is returned as true if the Reserve price on the original auction listing was removed as part of a revision to the original auction listing. This field is only returned if the Reserve price on the original auction listing was removed as part of a revision to the original auction listing.
BidItemArray.Item
  .SecondaryCategory
CategoryType Conditionally The unique identifier for a secondary category. This field is only applicable if the seller decides to list the item under two categories.

You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. The final value fee is based on the primary category in which the item is listed. Furthermore, you can list the same item in an eBay Motors Parts & Accessories category and in an eligible eBay category, as long as the primary category is associated with the site on which you are listing. That is, the two categories can be a mix of Motors Parts & Accessories and eBay site categories. (Real Estate, Mature Audience (adult), and Business & Industrial categories are not eligible for listing in two categories in this manner.) For example, if you list on Motors, the primary category could be 6750 (eBay Motors > Parts & Accessories > Apparel & Merchandise > Motorcycle > Jackets & Leathers), and the secondary category could be 57988 (eBay > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). If you list on the main eBay site, the primary category could be 57988 and the secondary category could be 6750.

If eBay has designated a listing category as a value category (see ValueCategory in GetCategoryFeatures), and that listing category will be the seller's primary category, the seller will not be able to list their item in a secondary category. If a seller's request payload includes a primary or a secondary category that is designated as a value category, then eBay drops the SecondaryCategory ID and only lists the item in the category specified with the PrimaryCategory ID. Also, if the listing request includes Item Specifics (in ItemSpecifics) that are associated with the SecondaryCategory, eBay drops those values as well when the SecondaryCategory is dropped. 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 within 12 hours of the listing's scheduled end time, you can only add or change the secondary category when an auction listing has no active bids or a multiple-quantity, fixed-price listing has no items sold. If you change the secondary category, any corresponding Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the category.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.
BidItemArray.Item
  .SecondaryCategory.CategoryID
string Conditionally This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.

In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing.

In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee.

For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.

Max length: 10.
BidItemArray.Item
  .SecondaryCategory
  .CategoryName
string Conditionally This string value is the display name of the eBay primary category, as it would appear on the eBay site. In GetItem, this will be a fully-qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).
BidItemArray.Item.Seller UserType Always Container for information about this listing's seller.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.
BidItemArray.Item.Seller
  .AboutMePage
boolean Always
A value of true indicates that the user has set up an About Me page.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item.Seller
  .eBayGoodStanding
boolean Always
This boolean field is returned as true if the eBay user is in good standing with eBay.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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 GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

See:
    Anonymous user information
    Member communications

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). 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 Anonymous user information.

BidItemArray.Item.Seller
  .FeedbackRatingStar
FeedbackRatingStarCodeType Always
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.
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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

See 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: Protecting your account
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item.Seller
  .NewUser
boolean Always This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less.
Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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 Anonymous user information.

BidItemArray.Item.Seller
  .SellerInfo
SellerType Always
Contains information about a seller, including listing settings, listing preferences, seller rankings, and seller type.
Note: This container will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item.Seller
  .SellerInfo.AllowPaymentEdit
boolean Always
Indicates whether the seller allows buyers to edit the total cost of an item during checkout.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item.Seller
  .SellerInfo.CheckoutEnabled
boolean Always
This flag indicates whether or not the seller's Checkout Enabled preference is turned on.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item.Seller
  .SellerInfo
  .CIPBankAccountStored
boolean Always
This boolean field indicates whether or not the seller has stored bank account information on file with eBay.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item.Seller
  .SellerInfo.GoodStanding
boolean Always
This boolean field indicates whether or not the seller is in good standing with eBay.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item.Seller
  .SellerInfo.SafePaymentExempt
boolean Always
If this field is true, the user is exempt from the requirement to offer at least one safe payment method when listing items.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
Default: false.

DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
BidItemArray.Item.Seller
  .SellerInfo.SellerLevel
SellerLevelCodeType Always
This enumeration value indicates the user's eBay PowerSeller tier.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

Applicable values: See SellerLevel.
Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item.Seller
  .SellerInfo.StoreOwner
boolean Always
Boolean value indicates whether or not the seller is an eBay Store owner.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item.Seller
  .SellerInfo.TopRatedSeller
boolean Conditionally This boolean field indicates if the seller is certified as a Top Rated Seller. Only Top Rated Sellers can qualify for Top Rated Plus listings, which receive the Top Rated Plus seal and other benefits.
This field is only returned for the following sites: US, Germany, Austria, Switzerland, UK, Ireland, and Australia. The Top Rated Seller and Top Rated Plus listing requirements will differ by site. Below are some links to Help pages that discuss these requirements: Top Rated Sellers, registered in the US, can qualify for Top Rated Seller programs in other countries as long as they meet the selling requirements in those countries. However, even if US sellers qualify for programs in other countries, they will not receive the Final Value Fee discount on sales in those countries.
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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.
Code so that your app gracefully handles any future changes to this list.

See Anonymous user information.

BidItemArray.Item.Seller
  .Status
UserStatusCodeType Always Indicates the user's registration/user status.

Applicable values: See Status.
Code so that your app gracefully handles any future changes to this list.
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".

Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

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

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

See Anonymous user information.

BidItemArray.Item.Seller
  .UserIDLastChanged
dateTime Always
Date and time when the user last changed their eBay user ID (in GMT).
Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

See 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

Code so that your app gracefully handles any future changes to this list.

See Vat-exempt sellers.

BidItemArray.Item
  .SellerVacationNote
string Conditionally This field is returned if the seller of the item is currently on vacation and has configured a custom message to display to potentioal buyers through Time Away settings.

Note: There are two Time Away modes - Pause Sales and Allow Sales. If seller is in the Pause Sales mode, all fixed-price listings for that seller will be hidden from search results during the span of the seller's vacation.
BidItemArray.Item
  .SellingStatus
SellingStatusType Always Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.
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, and GetOrders, 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.

See the Selling fees help page for more information about how Final Value Fees are calculated.
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, and GetOrders, 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.

See the Selling fees help page for more information about how Final Value Fees are calculated.

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
A value of true indicates that the user has set up an About Me page.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item
  .SellingStatus.HighBidder
  .eBayGoodStanding
boolean Always
This boolean field is returned as true if the eBay user is in good standing with eBay.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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 GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

See:
    Anonymous user information
    Member communications

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). 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 Anonymous user information.

BidItemArray.Item
  .SellingStatus.HighBidder
  .FeedbackRatingStar
FeedbackRatingStarCodeType Always
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values.
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.
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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.

See 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: Protecting your account
Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
BidItemArray.Item
  .SellingStatus.HighBidder
  .NewUser
boolean Always This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less.
Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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 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.
Code so that your app gracefully handles any future changes to this list.

See Anonymous user information.

BidItemArray.Item
  .SellingStatus.HighBidder
  .Status
UserStatusCodeType Always Indicates the user's registration/user status.

Applicable values: See Status.
Code so that your app gracefully handles any future changes to this list.
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".

Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

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

For PlaceOffer, see also SellingStatus.HighBidder.

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

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

See Anonymous user information.

BidItemArray.Item
  .SellingStatus.HighBidder
  .UserIDLastChanged
dateTime Always
Date and time when the user last changed their eBay user ID (in GMT).
Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.

See 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

Code so that your app gracefully handles any future changes to this list.

See Vat-exempt sellers.

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 transaction fees. This processing can take several minutes.
  • If you retrieve a sold item and no details about the buyer/high bidder are returned or no transaction fees are 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. 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 should be considered accurate and complete. In this state, all transaction fees should be calculated.
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 should be considered accurate and complete. However, the transaction fees are not yet available.

Code so that your app gracefully handles any future changes to this list.
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.

Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container.

If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request.

New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.

For multi-quantity, fixed-price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes—the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.

Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
  • Either omit the entire ShippingDetails container, or pass in an empty ShippingDetails container - <ShippingDetails/>
  • Pass in one ShipToLocations field, with its value set to None - <ShipToLocations>None</ShipToLocations>

For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned.

See:
    Shipping costs
    Revising Items for restrictions on changing item properties with ReviseItem

BidItemArray.Item
  .ShippingDetails.GetItFast
boolean Conditionally
Note: This field is deprecated and will stop being returned in order management calls on January 31, 2024.
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 or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping or eBay International 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 or eBay International Shipping) 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.

See Repeating (unbounded) fields 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 if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
BidItemArray.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

See https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-types-rates.html.

BidItemArray.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

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

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

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. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified.

If this field is omitted from international shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.
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.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, ShipToLocation fields are only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

See Shipping information.



Applicable values: See CountryCodeType, ShippingRegionCodeType
BidItemArray.Item
  .ShippingDetails.SalesTax
SalesTaxType Conditionally This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.

This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions.

This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).

See Multi-jurisdiction sales tax.

BidItemArray.Item
  .ShippingDetails.SalesTax
  .SalesTaxPercent
float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call.

Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
BidItemArray.Item
  .ShippingDetails.SalesTax
  .SalesTaxState
string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. Please note that both GetTaxTable and GeteBayDetails calls use a JurisdictionID field to express these tax jurisdiction identifiers instead of SalesTaxState, but the values used in these fields are the same.

The SalesTaxState field is conditionally required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing for a particular jurisdiction, and is returned with each SalesTax container to identify the tax jurisdiction.
BidItemArray.Item
  .ShippingDetails.SalesTax
  .ShippingIncludedInTax
boolean Conditionally This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with the SalesTax container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
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 to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.
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
BidItemArray.Item
  .ShippingDetails.TaxTable
  .TaxJurisdiction
TaxJurisdictionType Conditionally,
repeatable: [0..*]
In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table.

If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll, all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions.

This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
BidItemArray.Item
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID
string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction.

The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction.
BidItemArray.Item
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .SalesTaxPercent
float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
BidItemArray.Item
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .ShippingIncludedInTax
boolean Conditionally This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with each TaxJurisdiction container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
BidItemArray.Item
  .ShippingDetails
  .ThirdPartyCheckout
boolean Conditionally
Note: This field is deprecated and will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
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.

Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, the ShipToLocations field should not be used in the request. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container.
Use GeteBayDetails with a DetailName of ShippingLocationDetails to determine which international locations are valid for the site. Omit ShipToLocations if you want to ship only within the country of the listing site. To state that you do not wish to ship at all, set ShipToLocations to None. ReviseItem can add a ShipToLocations. On output, ShipToLocations is the collection of all input item-level ShipToLocations plus international shipping service-level ShipToLocation values.

Note: The ShipToLocations and ShippingDetails.ExcludeShipToLocation containers are not applicable for motor vehicle listings on the US, CA, or UK marketplaces. If these containers are sent in the request, they are ignored and a warning is returned.
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).

Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
  • Either omit the entire ShippingDetails container, or pass in an empty ShippingDetails container - <ShippingDetails/>
  • Pass in one ShipToLocations field, with its value set to None - <ShipToLocations>None</ShipToLocations>

See:
    Shipping information
    GeteBayDetails



Applicable values: See CountryCodeType, ShippingRegionCodeType
BidItemArray.Item.Site SiteCodeType Always The name of the eBay listing site. 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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.
BidItemArray.Item.SKU SKUType (string) Conditionally A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

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

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

BidItemArray.Item.StartPrice AmountType (double) Always The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

GetMyeBaySelling does not return Item.StartPrice for fixed price items—it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

See Listing Policies.

BidItemArray.Item.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

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

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

GetMyeBaySelling does not return Item.StartPrice for fixed price items—it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. 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. These fields will only be returned if the seller is subject to seller limits.

For a list of possible enumeration values, see CurrencyCodeType.
BidItemArray.Item.Storefront StorefrontType Conditionally This container provides details about the seller's eBay store.

In an Add/Revise/Relist call, the seller can include this container to set/change which customized eBay store category that the item will be placed in.

For 'Get' calls, this container is returned if the seller of the item has an eBay store.
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).

When you revise a item, you can add, change, or remove the subtitle.

Max length: 55.

See:
    Remove a field
    (RelistItem) DeletedField
    Create an eBay Motors 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 in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds).
BidItemArray.Item.Title string Always This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing.

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

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.
Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold.
Max length: 80.
BidItemArray.Item.UUID UUIDType (string) Conditionally Use an UUID value to ensure that you only list (or relist) a particular item once. This field can be particularly useful if you are listing many items on a daily basis and/or many items at once with an AddItems call. If your call request does not generate a response, or if you get one or more (blocking) errors, be sure to use the same UUID value when you attempt to list or relist the same item with another call request.

If you pass in a UUID value that has already been used to successfully create or relist an item, you will receive an error message that includes the Item ID for that listing and a boolean value indicating whether the duplicate UUID was sent by the same application.

We recommend that you use the Item.UUID field for add and relist calls (for example, AddItem and RelistItem), but use the Item.InvocationID field instead when using a revise call.

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 of the seller's eBay across all eBay marketplaces.

Max length: 32.
BidItemArray.Item.VATDetails VATDetailsType Conditionally This container is used in an Add/Revise/Relist call to set the VAT (Value-added Tax) percentage rate that will be charged to buyers when an item is purchased from the listing, and to enable Business Seller-related features.

This container is returned in 'Get' calls only if VAT is applicable to the listing, and unless the person making the 'Get' call owns the listing, only the VATPercent field is returned (if applicable). However, Business Seller-related information will be returned to all users in 'Get' calls under the SellerInfo and BusinessSellerDetails containers.

Note: VAT is not applicable to all countries, including the US. Allowed VAT percentage rates can vary by region/country, so sellers should be aware of the rates they are legally required/allowed to charge. Sellers must be registered as Business Sellers on the site they are selling on in order to use the Business Seller-related fields.

See:
    Value-added tax (VAT)
    German business features

BidItemArray.Item.VATDetails
  .VATPercent
float Conditionally This container is used in an Add/Revise/Relist call to set the VAT (Value-added Tax) percentage rate that will be charged to buyers when an item is purchased from the listing.

VAT is not applicable to all countries, including the US. Allowed VAT percentage rates can vary by region/country, so sellers should be aware of the rates they are legally required/allowed to charge, and they are responsible for charging the correct VAT rate.

If VAT is charged on a listing, the seller can choose to print an invoice for the buyer that shows the item's net price, the VAT percentage rate, the VAT amount, and the total price.

This field is returned in 'Get' calls only if the listing is subject to VAT.

Note: Previously, up to three digits beyond the decimal point were allowed for this float value, but now a seller can include only one digit beyond the decimal point (e.g. 12.3) when using an Add/Revise/Relist call to set this value. An error will occur if more digits beyond the decimal point are specified.
Min: 0.0. Max: 27.0.
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) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

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

Code so that your app gracefully handles any future changes to this list.
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

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

Applicable values:

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.

Code so that your app gracefully handles any future changes to this list.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

See Errors By Number.

Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

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 Error handling section of the Making a Trading API call 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.

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

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



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.InternationalRefundOption(Y)(Y)
BidItemArray.Item.ReturnPolicy.InternationalReturnsAcceptedOption(Y)(Y)
BidItemArray.Item.ReturnPolicy.InternationalReturnsWithinOption(Y)(Y)
BidItemArray.Item.ReturnPolicy
  .InternationalShippingCostPaidByOption
(Y)(Y)
BidItemArray.Item.ReturnPolicy.Refund(Y)(Y)
BidItemArray.Item.ReturnPolicy.RefundOption(Y)(Y)
BidItemArray.Item.ReturnPolicy.ReturnsAccepted(Y)(Y)
BidItemArray.Item.ReturnPolicy.ReturnsAcceptedOption(Y)(Y)
BidItemArray.Item.ReturnPolicy.ReturnsWithin(Y)(Y)
BidItemArray.Item.ReturnPolicy.ReturnsWithinOption(Y)(Y)
BidItemArray.Item.ReturnPolicy.ShippingCostPaidBy(Y)(Y)
BidItemArray.Item.ReturnPolicy.ShippingCostPaidByOption(Y)(Y)
BidItemArray.Item.SellingStatus.HighBidder-(Y)



Samples

New to making API calls? Please see Making a Call.

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

Sample: Basic Call

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

Description

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

<?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>2019-11-04T18:05:58.720Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1125</Version>
  <Build>E1125_CORE_API_19070409_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>B********r</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>
      <ItemID>1**********6</ItemID>
      <ListingDetails>
        <Adult>false</Adult>
        <BindingAuction>false</BindingAuction>
        <CheckoutEnabled>false</CheckoutEnabled>
        <HasReservePrice>false</HasReservePrice>
        <StartTime>2019-11-06T13:03:28.000Z</StartTime>
        <EndTime>2019-11-17T21:16:49.000Z</EndTime>
        <ViewItemURL>http://cgi.ebay.com/ws/eBayISAPI.dll?ViewItem&
            item=1**********6&category=1****0</ViewItemURL>
        <HasUnansweredQuestions>false</HasUnansweredQuestions>
        <HasPublicMessages>false</HasPublicMessages>
        <ViewItemURLForNaturalSearch>http://cgi.ebay.com/
            Titleist-735-CM-Stainless-Steel-Iron-set-Golf-Club-5-PW_W0QQitem
            Z1**********6QQcategoryZ1****0QQcmdZViewItem</ViewItemURLForNaturalSearch>
      </ListingDetails>
      <ListingDuration>Days_10</ListingDuration>
      <ListingType>Chinese</ListingType>
      <Location>Dayton, 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>b********o</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>
      </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>
        <SalesTax>
          <SalesTaxPercent>0.0</SalesTaxPercent>
          <ShippingIncludedInTax>false</ShippingIncludedInTax>
        </SalesTax>
        <ShippingServiceOptions/>
        <ShippingType>Flat</ShippingType>
        <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>
      <PostalCode>44060</PostalCode>
      <PictureDetails>
        <GalleryType>Gallery</GalleryType>
        <PictureURL>https://i.ebayimg.com/02/!BdpEiV!Bmk~$(KGrHqEH-C8ErHG9gBmBK50P8Fk!
            Q~~_1.JPG?set_id=880000500F</PictureURL>
        <PhotoDisplay>None</PhotoDisplay>
        <PictureURL>https://i*********.com/02/!****.jpg</PictureURL>
        <PictureURL>https://i*********.com/22/!****.jpg</PictureURL>
        <PictureURL>https://i*********.com/17/J****.jpg</PictureURL>
        <PictureURL>https://i*********.com/08/r****.jpg</PictureURL>
        <PictureURL>https://i*********.com/24/k****.jpg</PictureURL>
      </PictureDetails>
      <DispatchTimeMax>1</DispatchTimeMax>
      <ProxyItem>false</ProxyItem>
      <ReturnPolicy>
        <RefundOption>MoneyBack</RefundOption>
        <Refund>Money Back</Refund>
        <ReturnsWithinOption>Days_30</ReturnsWithinOption>
        <ReturnsWithin>30 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>
      <ItemID>3**********4</ItemID>
      <ListingDetails>
        <Adult>false</Adult>
        <BindingAuction>false</BindingAuction>
        <CheckoutEnabled>true</CheckoutEnabled>
        <HasReservePrice>false</HasReservePrice>
        <StartTime>2019-10-18T18:53:58.000Z</StartTime>
        <EndTime>2019-10-20T18:53:58.000Z</EndTime>
        <ViewItemURL>http://cgi.ebay.com/ws/eBayISAPI.dll?ViewItem&item=
            3**********4&category=1****0</ViewItemURL>
        <HasUnansweredQuestions>false</HasUnansweredQuestions>
        <HasPublicMessages>false</HasPublicMessages>
        <ViewItemURLForNaturalSearch>http://cgi.ebay.com/
            9-10-Titleist-755-Forged-Iron-set-5-PW-Stiff-Shafts_W0QQ
            itemZ3**********4QQcategoryZ1****0QQcmdZViewItem</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>z********1</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>
      </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>
        <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>
      <PostalCode>98070</PostalCode>
      <PictureDetails>
        <GalleryType>Gallery</GalleryType>
        <PictureURL>https://i.ebayimg.com/05/!BgMK7CQBGk~$(KGrHqYH-GgEsNUGmk0cBLE
            (FHI9Gw~~_1.JPG?set_id=880000500F</PictureURL>
        <PhotoDisplay>None</PhotoDisplay>
        <PictureURL>https://i.ebayimg.com/05/!BgMK7CQBGk~$(KGrHqYH-GgEsNUGmk0cBLE
            (FHI9Gw~~_1.JPG?set_id=880000500F</PictureURL>
        <PictureURL>https://i.ebayimg.com/24/!BgMLL-gBmk~$(KGrHqMH-GsEsMi7PV-rBLE
            (Fw61(g~~_1.JPG?set_id=880000500F</PictureURL>
        <PictureURL>https://i.ebayimg.com/02/!BgMLFiw!2k~$(KGrHqUH-GcEsO2FtftIBLE
            (Ff1d8g~~_1.JPG?set_id=880000500F</PictureURL>
      </PictureDetails>
      <DispatchTimeMax>2</DispatchTimeMax>
      <ReturnPolicy>
        <RefundOption>MoneyBack</RefundOption>
        <Refund>Money Back</Refund>
        <ReturnsWithinOption>Days_30</ReturnsWithinOption>
        <ReturnsWithin>30 Days</ReturnsWithin>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <ReturnsAccepted>Returns Accepted</ReturnsAccepted>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
        <ShippingCostPaidBy>Buyer</ShippingCostPaidBy>
      </ReturnPolicy>
      <PaymentAllowedSite>US</PaymentAllowedSite>
    </Item>
  </BidItemArray>
</GetBidderListResponse>



Change History

Change Date Description
1323
2023-08-25
  • SiteCodeType (modified): Czechia and Cyprus have been added to SiteCodeType as enumeration values. These sites cannot be set in the X-EBAY-API-SITEID header, nor in the Site field of a request payload.
1285
2022-11-18
  • Item.PictureDetails.PictureURL (modified): This release of the Trading API updates the picture limit. With the exception of motor vehicle listings on the US and Canada marketplaces, sellers can now include up to 24 pictures in a listing free of charge in all categories on all marketplaces. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors).
1247
2022-02-25
  • Item.HitCount (deprecated): Hit counters are no longer shown in View Item pages, so this field is no longer applicable.
  • Item.HitCounter (deprecated): Hit counters are no longer shown in View Item pages, so this field is no longer applicable.
1207
2021-05-21
  • VATDetails.VATPercent (modified): This value may only have one digit beyond the decimal point (e.g. 12.3). Previously, three digits after the decimal point were allowed.
  • VATDetails.VATPercent (modified): The maximum percentage value allowed for this field has decreased from 30 to 27 percent.
1161
2020-07-06
  • SellingStatus.FinalValueFee (modified): The calculation of the Final Value Fee is changing for managed payments sellers, so the value returned in this field should only be considered as an estimated value.
  • Item.ListingDesigner (deprecated): This container removed from WSDL, although it is possible that this container may still get returned in a response for an existing listing that was already using a Listing Designer template before this feature was retired.
1157
2020-06-05
  • Item.ListingDesigner (deprecated): Sellers are no longer able to use Listing Designer templates when they create or revise listings. Existing listings that are already using a Listing Designer template will remain unchanged.
  • Item.ReturnPolicy (doc change): Updated return policy-related documentation to make it more clear that if a seller does not add a separate international return policy for an item, the settings in the domestic return policy will be used instead.
1145
2020-03-13
  • Charity.CharityID, Charity.CharityNumber (doc change): Clarified the difference between CharityID (eBay identifier) and CharityNumber (PayPal Giving Fund identifier), and also added a note about CharityNumber field being scheduled for deprecation.
1107
2019-05-10
  • EndTimeTo (modified): Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year').
1091
2019-01-18
  • BestOfferDetails.BestOfferEnabled (modified): Best Offers in Auction listings are now supported on the following eBay marketplaces: US, Canada, UK, Germany, Australia, France, Italy, and Spain.
  • Item.MotorsGermanySearchable (deprecated): This field was deprecated since placing eBay Germany motor vehicle listings on the mobile.de site is no longer supported.
  • Item.ShippingTermsInDescription (deprecated): This field is no longer applicable, so was deprecated.
1085
2018-10-26
  • Item.PaymentMethods (modified): For sellers enrolled in the new eBay Managed Payments program, a specified payment method is not necessary. If a payment method is specified, such as PayPal, it will be dropped from the listing and the seller will get a warning message when the call is run.
  • Item.AutoPay (modified): The immediate payment feature is also available for sellers enrolled in the new eBay Managed Payments program. In the past, this feature was only available to sellers who were offering PayPal as the only available payment method.
  • ShippingDetails.SalesTax (doc change): Added a note to state that the Sales Tax rate for a US tax jurisdiction that is subject to the 'eBay Collect and Remit Tax' program will be ignored during the checkout process, since eBay will be collecting and remitting this tax to the tax authorities without the seller's involvement.
  • ProductListingDetails.EAN, ProductListingDetails.UPC (doc change): Highlighted the fact that a seller selling a product with a UPC value on a European eBay site is expected to pass this UPC value into the EAN field, and a seller selling a product with an EAN value on the US eBay site is expected to pass this EAN value into the UPC field. EAN values are 13 characters long, and UPC values are 12 characters long.
  • VATDetailsType (doc change): Cleaned up type documentation. Made it more clear which fields are used, and how they are used when a listing is created/revised/relisted.
1081
2018-09-28
  • Item.ListingDuration (modified): A 30-day listing duration (Days_30) can now be set for eBay Motors listings. The 21-day listing duration (Days_21) will soon be wired off for eBay Motors listings.
  • ShippingDetails.PaymentInstructions (doc change): The maximum length for this field was inaccurately documented as 1000, when the maximum length is actually 500 characters.
1065
2018-06-08
  • BuyerRequirementDetailsType.MinimumFeedbackScore (deprecated): This field is no longer applicable and has been removed from the WSDL as of Version 1065. It is scheduled to be deprecated.
  • BuyerRequirementDetailsType.LinkedPayPalAccount (deprecated): This field is no longer applicable and has been removed from the WSDL as of Version 1065. It is scheduled to be deprecated.
  • BuyerRequirementDetailsType.VerifiedUserRequirements (deprecated): This field is no longer applicable and has been removed from the WSDL as of Version 1065. It is scheduled to be deprecated.
  • BuyerRequirementDetailsType.MaximumBuyerPolicyViolations (deprecated): This field is no longer applicable and has been removed from the WSDL as of Version 1065. It is scheduled to be deprecated.
  • MaximumBuyerPolicyViolationsType (deprecated): This type is no longer applicable and has been removed from the WSDL as of Version 1065. This type was only used by the MaximumBuyerPolicyViolations field, which was also removed.
  • VerifiedUserRequirementsType (deprecated): This type is no longer applicable and has been removed from the WSDL as of Version 1065. This type was only used by the VerifiedUserRequirements field, which was also removed.
1061
2018-05-11
  • ReturnPolicy.InternationRefundOption (added): This release adds the option to specify return policies for international returns (which are items returned using an international shipping service). If you sell internationally, your international return policy is by default inherited from your domestic return policy (in this case ReturnPolicy.RefundOption). Set this option so st set up an international return policy if you want to differentiate your international return policy from your domestic return policy. For details, see the Release Notes.
  • ReturnPolicy.InternationReturnsAcceptedOption (added): This release adds the option to specify return policies for international returns.
  • ReturnPolicy.InternationReturnsWithinOption (added): This release adds the option to specify return policies for international returns.
  • ReturnPolicy.InternationShippingCostPaidByOption (added): This release adds the option to specify return policies for international returns.
  • ReturnPolicy.ExtendedHolidayReturns (deprecated): This release deprecates ExtendedHolidayReturns. Values passed to this field are ignored.
  • ReturnPolicy.RestockingFeeValueOption (deprecated): This release deprecates RestockingFeeValueOption. As of this release, sellers are no longer allowed to specify a special restocking fee for returned items. Values passed to this field are ignored.
  • ReturnPolicy.WarrantyDurationOption (deprecated): This release deprecates WarrantyDurationOption. As of this release, eBay no longer supports item warranties. Values passed to this field are ignored.
  • ReturnPolicy.WarrantyOfferedOption (deprecated): This release deprecates WarrantyOfferedOption. As of this release, eBay no longer supports item warranties. Values passed to this field are ignored.
  • ReturnPolicy.WarrantyTypeOption (deprecated): This release deprecates WarrantyTypeOption. As of this release, eBay no longer supports item warranties. Values passed to this field are ignored.
  • ReturnPolicy.Description (modified): This field is now valid for only the following marketplaces: EBAY_DE EBAY_ES EBAY_FR EBAY_IT. Values passed to this field in other marketplaces are ignored.
  • ReturnPolicy.RefundOption (modified): This field is now valid only on the US marketplace.
  • ReturnPolicy.ReturnsWithin (modified): The Days_14 option is being deprecated in many eBay categories. You might receive an error if you attempt to list an item with a 14-day return period. For details, see the Release Notes.
1039
2017-10-17
  • ReturnPolicy.RestockingFeeValueOption (modified): The Percent_20 value indicates that the seller reserves the right to charge a restocking fee percentage for returned items of up to 20 percent (of sale price), but at the seller's discretion, they can also charge less than 20 percent.
  • ReturnPolicy.RestockingFeeValue (modified): The 20% value indicates that the seller reserves the right to charge a restocking fee percentage for returned items of up to 20 percent (of sale price), but at the seller's discretion, they can also charge less than 20 percent.
1031
2017-09-01
  • ShippingDetails.InsuranceDetails, ShippingDetails.InternationalInsuranceDetails (deprecated): These two containers and InsuranceDetailsType have been deprecated, as it is no longer possible/applicable for sellers to offer shipping insurance to buyers on any eBay site.
1029
2017-08-18
  • Item.GiftIcon (deprecated): This field is no longer applicable and is in the process of being deprecated. Gift Services and the Gift Icon are no longer supported on any eBay Marketplace sites.
  • Item.GiftServices (deprecated): This field is no longer applicable and is in the process of being deprecated. Gift Services and the Gift Icon are no longer supported on any eBay Marketplace sites.
  • GiftServicesCodeType (deprecated): This type is no longer applicable and is in the process of being deprecated. Gift Services and the Gift Icon are no longer supported on any eBay Marketplace sites.
  • ListingEnhancementsCodeType (modified): The following enumeration values are no longer applicable, as the listing enhancements associated with these enumeration values are no longer supported on any eBay Marketplace site: BasicUpgradePackBundle, Border, Featured, Highlight, ProPackBundle, and ProPackPlusBundle.
1027
2017-08-04
  • ListingTypeCodeType (modified): The Half enumeration value is being deprecated, as API support for Half.com listings is being deprecated.
  • UserStatusCodeType (modified): The CreditCardVerifyHalfOptIn and UnconfirmedHalfOptIn enumeration values are being deprecated, as API support for Half.com listings is being deprecated.
0997
2017-01-20
  • Item.ThirdPartyCheckoutIntegration (deprecated): This field is being deprecated. Third-party checkout has been deprecated.
  • PictureDetails.GalleryURL (deprecated): This field is being deprecated from public WSDL. It is only used internally.
  • ReturnPolicy.EAN (deprecated): This field is being deprecated. The EAN value will no longer be a part of the seller's return policy.
  • ShippingDetails.InsuranceFee (deprecated): This field is being deprecated. If applicable, the shipping insurance fee will be returned in the ShippingDetails.InsuranceDetails or ShippingDetails.InternationalInsuranceDetails containers instead.
  • ShippingDetails.InsuranceOption (deprecated): This field is being deprecated. If applicable, the shipping insurance option will be returned in the ShippingDetails.InsuranceDetails or ShippingDetails.InternationalInsuranceDetails containers instead.
0955
2016-02-12
  • BuyerPaymentMethodCodeType (modified): The Moneybookers, ProPay, and Paymate enumeration values have been deprecated, and will no longer be returned in any calls.
0945
2015-10-15
  • BuyerPaymentMethodCodeType (modified): Moneybookers, ProPay, or Paymate will no longer be accepted as valid PaymentMethods for new listings. However, these payment methods will still be allowed for existing listings, so these values may still get returned until these payment methods are completely removed from all listings.
0939
2015-09-04
  • ProductListingDetails.IncludeeBayProductDetails (added): This boolean field controls whether or not an eBay catalog product is used to help create or revise an item listing. For this field to have an effect, the user must specify a product ID value through the ProductListingDetails container, and eBay must be able to match the product in the listing to a product in the eBay catalog.
0899
2014-11-04
  • BuyerPaymentMethodCodeType (modified): 'QIWI' added as enumeration value. This payment method can only be specified on the US site and is only applicable to Russian buyers.
0897
2014-10-21
  • SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
0889
2014-08-26
  • ExtendedPictureDetails (added): This container returns the URLs of both the self-hosted and eBay Picture Service images in and .
0883
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.
0861
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.
0829
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.
0825
2013-05-22
  • ReturnPolicy.ReturnsWithinOption (modified): A new 'Months_1' value is now supported. This value indicates a one-month return policy.
0817
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).
0807
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.
0801
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.
0799
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).
0791
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.
0783
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.
0765
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.
0735
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.
0719
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.
0689
2010-09-20
  • Item.ApplyShippingDiscount (deprecated): As of version 689, Item.ApplyShippingDiscount is deprecated and removed from the schema.
0663
2010-03-31
  • ShippingType.ApplyShippingDiscount (deprecated): This tag is no longer being used. It will be officially deprecated later in 2010.
0635
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.
0629
2009-08-05
  • TopRatedSeller (added): Returned when seller is a Top-Rated Seller.
0605
2009-02-18
  • NowAndNew (deprecated): Now & New (Sofort & Neu) has been retired as of this release.
0599
2009-1-07
  • NowAndNew (doc change): eBay will retire Now & New (Sofort & Neu) by March 2009.
0581
2008-09-03
  • ItemArray.Item.ReturnPolicy (added): Specifies the seller's return policy.
0573
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.
0563
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.
0561
2008-04-16
  • Item.ListingType.Express (deprecated): Due to the shutdown of UK and Germany eBay Express sites Item.ListingType.Express has been deprecated.
0559
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.
0555
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.
0537
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.
0521
2007-07-11
  • Item.FinanceOfferID (deprecated): Finance-offer functionality has been deprecated with this version.
0503
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.
0499
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.
0497
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.
0491
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
0483
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.
0477
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.
0465
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.
0455
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).
0453
2006-03-22
  • MaximumItemRequirements (added): Indicates whether blocking is enabled to prevent bidding by unpaying or low-feedback bidders.
  • 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.
0439
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.
0427
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.