eBay Shopping API895

GetMultipleItems

This call retrieves publicly available data for one or more listings.

Usage Details

Use this call to retrieve much of the information that is visible on a listing's View Item page on the eBay site, such as title and prices. Provide ItemID for every item for which you want information. This call returns the same minimal information that is returned by GetSingleItem for each item with no IncludeSelector specified. (Use GetShippingCosts to retrieve detailed shipping cost information for a given item.)

For information about specifying affiliate parameters, see Affiliate URL Parameters and HTTP Header Values.

Note: For listings that return Item.DiscountPriceInfo.PricingTreatment set to MAP (Minimum Advertised Price), you are legally required to follow the rules for displaying the price of the item to potential buyers. You are bound by the terms of the API License Agreement to follow these rules. Refer to the API License Agreement for consequences of non-compliance.

Related Information

See also the reference documentation for this call:



Back to top

GetMultipleItems Input

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

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<GetMultipleItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <IncludeSelector> string </IncludeSelector>
  <ItemID> string </ItemID>
  <!-- ... more ItemID values allowed here ... -->
  <!-- Standard Input Fields -->
  <MessageID> string </MessageID>
</GetMultipleItemsRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
IncludeSelector string Optional Defines standard subsets of fields to return within the response.

If you don't specify this field, the call returns a default set of fields (see the "Detail Controls" link below). If you specify this field, the additional fields you retrieve can affect the call's response time (performance).

Applicable values:

•   Details

Include most available fields in the response (except fields that significantly affect the call's performance).

•   Description

Include the Description field in the response. (This can affect the call's performance.)

•   TextDescription

Include the text Description (no html tag) field in the response. (This can affect the call's performance.)

•   ItemSpecifics

Include ItemSpecifics in the response.

•   Variations

Include Variations in the response.



Use a comma to specify multiple values. (In this case, the results are cumulative.) See "GetSingleItem Samples" for an example of how to use this field.

See "Detail Controls" for a complete list of fields that can be returned for each selector.

See:
    Detail Controls
    GetMultipleItems Samples

ItemID string Required,
repeatable: [1..*]
The item ID that uniquely identifies the item listing for which to retrieve the data. You can provide a maximum of 20 item IDs. When making a URL request, repeating ItemID parameters must be specified as an indexed array (e.g., ...&ItemID(0)=130310421484&ItemID(1)= 300321408208& ItemID(2)=370214653822...).

Alternatively, as a shortcut for URL requests, you can specify the item IDs as a comma-separated list in a single ItemID parameter (e.g., ...< code>&ItemID=130310421484,300321408208,370214653822... ) for convenience.

You can determine an item's ID by calling findItemsAdvanced (Finding API) or from the eBay Web site. Provide ItemID for every item for which you want information.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

See (findItemsAdvanced) item.itemId.

Standard Input Fields  
MessageID string Optional If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response. If you're making a lot of calls, you can use this for tracking that a response is returned for every request and to match particular responses to particular requests. (In this case, specify a different value for each request.) You can specify any value that is useful to you.



Back to top

GetMultipleItems Output

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

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<GetMultipleItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <Item> SimpleItemType
    <AutoPay> boolean </AutoPay>
    <AvailableForPickupDropOff> boolean </AvailableForPickupDropOff>
    <BestOfferEnabled> boolean </BestOfferEnabled>
    <BidCount> int </BidCount>
    <BusinessSellerDetails> BusinessSellerDetailsType
      <AdditionalContactInformation> string </AdditionalContactInformation>
      <Address> AddressType
        <CityName> string </CityName>
        <CompanyName> string </CompanyName>
        <FirstName> string </FirstName>
        <LastName> string </LastName>
        <Name> string </Name>
        <Phone> string </Phone>
        <PostalCode> string </PostalCode>
        <StateOrProvince> string </StateOrProvince>
        <Street1> string </Street1>
        <Street2> string </Street2>
      </Address>
      <Email> string </Email>
      <Fax> string </Fax>
      <LegalInvoice> boolean </LegalInvoice>
      <TermsAndConditions> string </TermsAndConditions>
      <TradeRegistrationNumber> string </TradeRegistrationNumber>
      <VATDetails> VATDetailsType
        <VATID> string </VATID>
        <VATPercent> float </VATPercent>
        <VATSite> string </VATSite>
      </VATDetails>
    </BusinessSellerDetails>
    <Charity> CharityType
      <CharityID> string </CharityID>
      <CharityName> string </CharityName>
      <CharityNumber> int </CharityNumber>
      <DonationPercent> float </DonationPercent>
      <LogoURL> string </LogoURL>
      <Mission> string </Mission>
      <Status> CharityStatusCodeType </Status>
    </Charity>
    <ConditionDescription> string </ConditionDescription>
    <ConditionDisplayName> string </ConditionDisplayName>
    <ConditionID> int </ConditionID>
    <ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
    <Country> CountryCodeType </Country>
    <CurrentPrice> AmountType (double) </CurrentPrice>
    <Description> string </Description>
    <DiscountPriceInfo> DiscountPriceInfoType
      <MinimumAdvertisedPrice> AmountType (double) </MinimumAdvertisedPrice>
      <MinimumAdvertisedPriceExposure> MinimumAdvertisedPriceExposureCodeType </MinimumAdvertisedPriceExposure>
      <OriginalRetailPrice> AmountType (double) </OriginalRetailPrice>
      <PricingTreatment> PricingTreatmentCodeType </PricingTreatment>
      <SoldOffeBay> boolean </SoldOffeBay>
      <SoldOneBay> boolean </SoldOneBay>
    </DiscountPriceInfo>
    <eBayNowAvailable> boolean </eBayNowAvailable>
    <eBayNowEligible> boolean </eBayNowEligible>
    <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff>
    <EndTime> dateTime </EndTime>
    <ExcludeShipToLocation> string </ExcludeShipToLocation>
    <!-- ... more ExcludeShipToLocation values allowed here ... -->
    <GalleryURL> anyURI </GalleryURL>
    <GlobalShipping> boolean </GlobalShipping>
    <HandlingTime> int </HandlingTime>
    <HighBidder> SimpleUserType
      <FeedbackPrivate> boolean </FeedbackPrivate>
      <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
      <FeedbackScore> int </FeedbackScore>
      <UserAnonymized> boolean </UserAnonymized>
      <UserID> string </UserID>
    </HighBidder>
    <HitCount> long </HitCount>
    <IgnoreQuantity> boolean </IgnoreQuantity>
    <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
    <ItemID> string </ItemID>
    <ItemSpecifics> NameValueListArrayType
      <NameValueList> NameValueListType
        <Name> string </Name>
        <Value> string </Value>
        <!-- ... more Value values allowed here ... -->
      </NameValueList>
      <!-- ... more NameValueList nodes allowed here ... -->
    </ItemSpecifics>
    <ListingStatus> ListingStatusCodeType </ListingStatus>
    <ListingType> ListingTypeCodeType </ListingType>
    <Location> string </Location>
    <LotSize> int </LotSize>
    <MinimumToBid> AmountType (double) </MinimumToBid>
    <NewBestOffer> boolean </NewBestOffer>
    <PaymentAllowedSite> SiteCodeType </PaymentAllowedSite>
    <!-- ... more PaymentAllowedSite values allowed here ... -->
    <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
    <!-- ... more PaymentMethods values allowed here ... -->
    <PictureURL> anyURI </PictureURL>
    <!-- ... more PictureURL values allowed here ... -->
    <PostalCode> string </PostalCode>
    <PrimaryCategoryID> string </PrimaryCategoryID>
    <PrimaryCategoryIDPath> string </PrimaryCategoryIDPath>
    <PrimaryCategoryName> string </PrimaryCategoryName>
    <ProductID> ProductIDType (string) </ProductID>
    <Quantity> int </Quantity>
    <QuantityAvailableHint> QuantityAvailableHintCodeType </QuantityAvailableHint>
    <QuantityInfo> QuantityInfo
      <MinimumRemnantSet> int </MinimumRemnantSet>
    </QuantityInfo>
    <QuantitySold> int </QuantitySold>
    <QuantitySoldByPickupInStore> int </QuantitySoldByPickupInStore>
    <QuantityThreshold> int </QuantityThreshold>
    <ReserveMet> boolean </ReserveMet>
    <ReturnPolicy> ReturnPolicyType
      <Description> string </Description>
      <EAN> string </EAN>
      <Refund> string </Refund>
      <RestockingFeeValue> token </RestockingFeeValue>
      <RestockingFeeValueOption> token </RestockingFeeValueOption>
      <ReturnsAccepted> string </ReturnsAccepted>
      <ReturnsWithin> string </ReturnsWithin>
      <ShippingCostPaidBy> string </ShippingCostPaidBy>
      <WarrantyDuration> string </WarrantyDuration>
      <WarrantyOffered> string </WarrantyOffered>
      <WarrantyType> string </WarrantyType>
    </ReturnPolicy>
    <SecondaryCategoryID> string </SecondaryCategoryID>
    <SecondaryCategoryIDPath> string </SecondaryCategoryIDPath>
    <SecondaryCategoryName> string </SecondaryCategoryName>
    <Seller> SimpleUserType
      <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
      <FeedbackScore> int </FeedbackScore>
      <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
      <TopRatedSeller> boolean </TopRatedSeller>
      <UserID> string </UserID>
    </Seller>
    <ShippingCostSummary> ShippingCostSummaryType
      <InsuranceCost> AmountType (double) </InsuranceCost>
      <ListedShippingServiceCost> AmountType (double) </ListedShippingServiceCost>
      <LocalPickup> boolean </LocalPickup>
      <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
      <ShippingType> ShippingTypeCodeType </ShippingType>
    </ShippingCostSummary>
    <ShipToLocations> string </ShipToLocations>
    <!-- ... more ShipToLocations values allowed here ... -->
    <Site> SiteCodeType </Site>
    <SKU> string </SKU>
    <StartTime> dateTime </StartTime>
    <Storefront> StorefrontType
      <StoreName> string </StoreName>
      <StoreURL> anyURI </StoreURL>
    </Storefront>
    <Subtitle> string </Subtitle>
    <TimeLeft> duration </TimeLeft>
    <Title> string </Title>
    <TopRatedListing> boolean </TopRatedListing>
    <UnitInfo> UnitInfoType
      <UnitQuantity> double </UnitQuantity>
      <UnitType> string </UnitType>
    </UnitInfo>
    <Variations> VariationsType
      <Pictures> PicturesType
        <VariationSpecificName> string </VariationSpecificName>
        <VariationSpecificPictureSet> VariationSpecificPictureSetType
          <PictureURL> anyURI </PictureURL>
          <!-- ... more PictureURL values allowed here ... -->
          <VariationSpecificValue> string </VariationSpecificValue>
        </VariationSpecificPictureSet>
        <!-- ... more VariationSpecificPictureSet nodes allowed here ... -->
      </Pictures>
      <Variation> VariationType
        <DiscountPriceInfo> DiscountPriceInfoType
          <MinimumAdvertisedPrice> AmountType (double) </MinimumAdvertisedPrice>
          <MinimumAdvertisedPriceExposure> MinimumAdvertisedPriceExposureCodeType </MinimumAdvertisedPriceExposure>
          <OriginalRetailPrice> AmountType (double) </OriginalRetailPrice>
          <PricingTreatment> PricingTreatmentCodeType </PricingTreatment>
          <SoldOffeBay> boolean </SoldOffeBay>
          <SoldOneBay> boolean </SoldOneBay>
        </DiscountPriceInfo>
        <Quantity> int </Quantity>
        <SellingStatus> SellingStatusType
          <QuantitySold> int </QuantitySold>
          <QuantitySoldByPickupInStore> int </QuantitySoldByPickupInStore>
        </SellingStatus>
        <SKU> string </SKU>
        <StartPrice> AmountType (double) </StartPrice>
        <VariationSpecifics> NameValueListArrayType
          <NameValueList> NameValueListType
            <Name> string </Name>
            <Value> string </Value>
            <!-- ... more Value values allowed here ... -->
          </NameValueList>
          <!-- ... more NameValueList nodes allowed here ... -->
        </VariationSpecifics>
        <!-- ... more VariationSpecifics nodes allowed here ... -->
      </Variation>
      <!-- ... more Variation nodes allowed here ... -->
      <VariationSpecificsSet> NameValueListArrayType
        <NameValueList> NameValueListType
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value values allowed here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes allowed here ... -->
      </VariationSpecificsSet>
    </Variations>
    <VhrAvailable> boolean </VhrAvailable>
    <VhrUrl> anyURI </VhrUrl>
    <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
  </Item>
  <!-- ... more Item nodes allowed here ... -->
  <!-- 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 ... -->
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetMultipleItemsResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
Item SimpleItemType Always,
repeatable: [1..*]
Contains details for a listing (or multiple) listings that correspond to the item ID(s) specified in the request.

IncludeSelector: none (not controlled by IncludeSelector)
Item.AutoPay boolean Always If true, the seller requires immediate payment for the item. If false (or not specified), immediate payment is not requested. Buyers must have a PayPal account to purchase items that require immediate payment.

A seller can choose to require immediate payment for Fixed Price and Buy It Now listings. If a Buy It Now item ends as an auction (that is, if the Buy It Now option is removed due to bids being placed on the listing), the immediate payment requirement does not apply.

Note: The value of the AutoPay flag indicates the seller's stated preference only. It does not indicate whether the listing is still a candidate for purchase via immediate payment. For example, if a listing receives bids and no longer qualifies for immediate payment, the value of the AutoPay flag does not change.
Only applicable to items listed on PayPal-enabled sites and in categories that support immediate payment. Not applicable to Half.com.

IncludeSelector: none (not controlled by IncludeSelector)
Item.AvailableForPickupDropOff boolean Conditionally This boolean field will be returned as 'true' if the seller has made the item available for the "Click and Collect" program. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The "Click and Collect" feature is only available to UK sellers. UK buyers should realize that they must be in an area where "Click and Collect" is available. This field is not returned if 'false'.
Item.BestOfferEnabled boolean Always Whether the seller will accept a best offer for this item. This feature enables a buyer to make a lower-priced binding offer on a fixed price item. Buyers can't see how many offers have been made (only the seller can see this information). To make a best offer on a listing, use the eBay Web site.

IncludeSelector: Details

See:
    (eBay Help) Making a Best Offer (for Buyers)
    (eBay DE Hilfe) Preis vorschlagen

Item.BidCount int Always The number of bids that have been placed on the item.

On most sites, the Buy It Now Option becomes unavailable once an auction has a valid bid. Note that the bid must be above any reserve price.

FindPopularItems: For fixed-price listings, the BidCount value is the total number of items purchased so far (in the listing's lifetime).

IncludeSelector: none (not controlled by IncludeSelector)
Item.BusinessSellerDetails BusinessSellerDetailsType Conditionally Returns the seller's business information. Set the SellerBusinessCodeType to 'Commercial' in the request to return the related information. This is only applicable for sites where Business Seller options are supported.

IncludeSelector: Details
Item.BusinessSellerDetails
  .AdditionalContactInformation
string Conditionally Displays the AdditionalContactInformation of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address
AddressType Conditionally Displays the Address of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.CityName
string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: 64.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.CompanyName
string Conditionally User's company name. Only returned if available. Not applicable to Half.com.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.FirstName
string Conditionally Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.LastName
string Conditionally Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.Name
string Conditionally User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: 64.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.Phone
string Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number. Also applicable to Half.com (for GetOrders).

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.PostalCode
string Conditionally User's postal code.

If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.

Also applicable to Half.com (for GetOrders).
Max length: 12.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.StateOrProvince
string Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders).
Max length: 64.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.Street1
string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: 100.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Address.Street2
string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: 100.

IncludeSelector: Details
Item.BusinessSellerDetails
  .Email
string Conditionally Displays the email address of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails.Fax string Conditionally Displays the fax number of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .LegalInvoice
boolean Conditionally Displays the LegalInvoice of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .TermsAndConditions
string Conditionally Displays the TermsAndConditions of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .TradeRegistrationNumber
string Conditionally Displays the TradeRegistrationNumber of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .VATDetails
VATDetailsType Conditionally Displays the VATDetails of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .VATDetails.VATID
string Conditionally Displays the VatSite Id of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.BusinessSellerDetails
  .VATDetails.VATPercent
float Conditionally VAT rate for the item, if any. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346.) Note: The View Item page may display the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored.
Min: 0. Max: 30.

DetailLevel: none (not controlled by DetailLevel)
Item.BusinessSellerDetails
  .VATDetails.VATSite
string Conditionally Displays the VatSite Id of the seller (in a business card format) as part of the data returned in GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

IncludeSelector: Details
Item.Charity CharityType Conditionally Identifier for a Giving Works listing and the benefiting nonprofit charity organization.

IncludeSelector: Details
Item.Charity.CharityID string Conditionally A unique identification number assigned by eBay to registered nonprofit charity organizations.

IncludeSelector: Details
Item.Charity.CharityName string Conditionally The name of the benefiting nonprofit charity organization selected by the charity seller.

IncludeSelector: Details
Item.Charity.CharityNumber int Conditionally A unique identification number assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. Being superseded by CharityID. Max 10 digits.

IncludeSelector: Details
Item.Charity.DonationPercent float Conditionally The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items.

IncludeSelector: Details
Item.Charity.LogoURL string Conditionally The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing.

IncludeSelector: Details
Item.Charity.Mission string Conditionally The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing.

IncludeSelector: Details
Item.Charity.Status CharityStatusCodeType Conditionally The status of the nonprofit charity organization.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
NoLongerValid
(out) The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider.
Valid
(out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider.



IncludeSelector: Details
Item.ConditionDescription string Conditionally This string field is used by the seller to more clearly describe the condition of items that are not brand new.

The ConditionDescription field is available for all categories, including categories where the condition type is not applicable (e.g., Antiques). This field is applicable for all item conditions except "New", "Brand New", "New with tags", and "New in box". If ConditionDescription is used with these conditions (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user.

This field should only be used to further clarify the condition of the used item. For example, "The right leg of the chair has a small scratch, and on the seat back there is a light blue stain about the shape and size of a coin." It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition type (Item.ConditionID), condition description, item description (Item.Description), and the listing's pictures do not contradict one another.

The ConditionDescription field is only returned if a condition description is specified in the listing.

IncludeSelector: none (not controlled by IncludeSelector)
Item.ConditionDisplayName string Conditionally The human-readable label for the item condition. Display names are localized for the site on which they're listed (not necessarily the site on which they're viewed).

Most categories use the same display name for the same condition ID. Some categories may override the display name based on buyer expectations for items in the category. For example, condition ID 1000 could be called "New" in one category and "New with tags" in another.

Behind the scenes, eBay's search engine uses the ID (not the display name) to determine whether items are new, used, or refurbished.

Only returned when ConditionID is returned. Also see ItemSpecifics in case the seller used that field for the condition instead.

IncludeSelector: none (not controlled by IncludeSelector)
Item.ConditionID int Conditionally The numeric ID (e.g., 1000) for the item condition. Only returned when the seller specified ConditionID in their listing. Also see ItemSpecifics in case the seller used that field for the condition instead.

IncludeSelector: none (not controlled by IncludeSelector)
Item.ConvertedCurrentPrice AmountType (double) Always The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent this request.

Price fields are returned as doubles, not necessarily in the traditional monetary format of the site's country. For example, a US Dollar value might be returned as 3.880001 instead of 3.88.

Some eBay sites also support multi-item Buy It Now auctions, where you can buy multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.

For fixed-price (FixedPriceItem) listings, see CurrentPrice or ConvertedCurrentPrice instead.

Returned only if an item was listed with a Buy It Now option.

For active items, refresh this value every 24 hours to pick up the current conversion rates (if this value has been converted).

IncludeSelector: none (not controlled by IncludeSelector)

See:
    (GetSingleItem) Item.ListingType
    Item.BuyItNowAvailable
    Item.BuyItNowPrice
    Item.ConvertedCurrentPrice
    (eBay Help) Buying with Buy It Now
    (eBay DE Hilfe) Kaufen mit Sofort-Kaufen

Item.Country CountryCodeType Always Two-letter ISO 3166 country code to indicate the country where the item is located.

Applicable values: See Country.

IncludeSelector: none (not controlled by IncludeSelector)
Item.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.

IncludeSelector: Details
Item.Description string Always The seller's description of the item, if any. This can include HTML markup and JavaScript. See string in Simple Schema Types.

Some sellers don't specify their own listing description. Instead, they use a stock description from a catalog available through eBay. (GetSingleItem doesn't return this stock information.)
Max length: 500000 (some sites may allow more, but the exact number may vary).

IncludeSelector: Description, TextDescription
Item.DiscountPriceInfo DiscountPriceInfoType Conditionally This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP applies to only fixed price, BIN items. STP is available on the US, UK, and German (DE) sites, while MAP is available only on the US site.

Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a "special account flag" (SAF) that allows them to apply Discount Pricing to both MSKU and Non-MSKU items.

See Displaying Discount Pricing Information to Buyers.

Item.DiscountPriceInfo
  .MinimumAdvertisedPrice
AmountType (double) Conditionally A value equal to the agreed upon minimum advertised price.

The minimum advertised price is an agreed upon price that is set by the suppliers/OEMs and the retailers/sellers. The minimum advertised price is the lowest price for which an item can be advertised. Large volume sellers can negotiate with the suppliers/OEMs to offer certain items below the set minimum advertised price. eBay does not maintain or validate the agreed upon minimum advertised price; the seller is responsible for setting this value in accordance with their agreement with the supplier/OEMs. MAP pricing treatments apply to only fixed price, BIN items listed on the eBay US site.
Item.DiscountPriceInfo
  .MinimumAdvertisedPriceExposure
MinimumAdvertisedPriceExposureCodeType Conditionally If an item listing qualifies it to be listed as a MAP item (PricingTreatment returns MAP), the item price cannot be directly displayed on the page containing the item. When listing a MAP item, the seller stipulates how they want the buyer to view the price of the item by setting this field to either PreCheckout or DuringCheckout. If this field is not set for a MAP item, the treatment defaults to PreCheckout.

If this field is set to PreCheckout, the buyer must click a link (or button) to view the item price on a different page (such as in a pop-up window). If this field is set to DuringCheckout, the StartPrice must be shown only when the buyer in the eBay checkout flow.

MAP items are supported only on the eBay US site.

Applicable values:

CustomCode
(out) Reserved for future use.
DuringCheckout
(out) DuringCheckout specifies that the discounted price must be shown on the eBay checkout flow page.
None
(out) None means the discount price is not shown via either PreCheckout nor DuringCheckout.
PreCheckout
(out) PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate page (or window) that displays the discount price.

Item.DiscountPriceInfo
  .OriginalRetailPrice
AmountType (double) Conditionally This field specifies the price to which the discounted-price display treatment will be applied (for example, a strikethrough price). The discounted price of an item (specified in the CurrentPrice field) is the BIN price and is less than the OriginalRetailPrice of the item.

See Displaying Discount Pricing Information to Buyers for guidelines on displaying STP and MAP items.

Item.DiscountPriceInfo
  .PricingTreatment
PricingTreatmentCodeType Conditionally This field denotes whether or not an item qualifies for a discount pricing treatment display. If a seller lists an item with DiscountPriceInfo values, the item response container will include a DiscountPriceInfo container with this field set to either STP, MAP, or None. If this field is set to MAP, you must abide by the rules for displaying MAP items, as described in MinimumAdvertisedPriceExposure.

Important: For listings that return PricingTreatment set to MAP, you are legally required to follow the rules for displaying the price of the item to potential buyers. You are bound by the terms of the API License Agreement to follow these rules. Refer to the API License Agreement for consequences of non-compliance.

Applicable values:

CustomCode
(out) Reserved for future use.
MAP
(out) MAP stands for Minimum Advertised Price.
None
(out) None means the item does not qualify for either STP or MAP pricing.
STP
(out) STP stands for Strikethrough Pricing.

Item.DiscountPriceInfo
  .SoldOffeBay
boolean Conditionally Used by the eBay UK and eBay Germany (DE) sites, this field indicates that the discount price (specified as currentPrice) is the price for which the seller offered the same item for sale on a web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the seller's own price for the item.

In the event both soldOffeBay and soldOneBay fields are set, soldOneBay takes precedence.
Item.DiscountPriceInfo
  .SoldOneBay
boolean Conditionally Used by the eBay UK and eBay Germany (DE) sites, this field indicates that the discount price (specified as CurrentPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days. The discount price is always in reference to the seller's own price for the item.

In the event both soldOffeBay and soldOneBay fields are set, soldOneBay takes precedence.
Item.eBayNowAvailable boolean Conditionally This boolean field will be returned as 'true' if the item is available for eBay Now delivery. However, buyers should realize that they must be in an area where eBay Now delivery is available. eBay Now is currently available on the San Francisco Peninsula (from San Francisco to San Jose), in Chigago, in Dallas, and in the New York City boroughs of Manhattan, Brooklyn, and Queens.
Item.eBayNowEligible boolean Conditionally This boolean field indicates that the listing is eligible for eBay Now delivery, but it doesn't necessarily mean that items are available for purchase through the eBay Now method of delivery. The eBayNowAvailable field actually indicates whether or not items are available for purchase through eBay Now.

IncludeSelector: Details
Item.EligibleForPickupDropOff boolean Conditionally This field will be returned as 'true' in GetItem if the item is eligible for the "Click and Collect" feature. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The "Click and Collect" feature is only available to UK sellers. UK buyers should realize that they must be in an area where "Click and Collect" is available. This field is not returned if 'false'.
Item.EndTime dateTime Always Time stamp (in GMT) of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended).

IncludeSelector: none (not controlled by IncludeSelector)

See (GetSingleItem) Item.Variations.

Item.ExcludeShipToLocation string Conditionally,
repeatable: [0..*]
Use this field to specify an international country or region, or a special domestic location (for sites supporting this feature, currently US, UK, DE) to where you will not ship the associated item. On input, repeat this element for each location that you want to exclude as a shipping destination for your item.

Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation settings applied to your listing. The locations you have excluded display in the Shipping and Handling section of your item listing.

If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on your item.

The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails. Repeat GeteBayDetails for each site on which you list.

This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide, you can use this field to specify both regions and countries that you want to exclude from your shipping destinations.

You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.)

Specify NONE in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing.

Note: To enable your default Exclude Ship-To List, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation.

DetailLevel: Details
Item.GalleryURL anyURI Conditionally URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image.

IncludeSelector: none (not controlled by IncludeSelector)
Item.GlobalShipping boolean Conditionally Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is true, the Global Shipping Program is the default international shipping option for the listing, and eBay designates an appropriate international shipping service. If the value of GlobalShipping is false, the seller is responsible for specifying an international shipping service for the listing if desired.

IncludeSelector: none (not controlled by IncludeSelector)
Item.HandlingTime 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. When listing the item, the seller sets this to an integer value (0, 1, 2, 3, 4, 5, 10, 15 or 20) corresponding to the number of days. This time does not include the shipping time (the carrier's transit time).

GetSingleItem or GetMultipleItems returns HandlingTime only when shipping service options are specified for the item and the seller specified a handling time.

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

Note: If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. Valid for flat and calculated shipping. Does not apply when there is no shipping, or when using local pickup only or freight shipping.

IncludeSelector: Details

See Handling Time and Estimated Delivery Time for details about same day handling and default cutoff times.

Item.HighBidder SimpleUserType Conditionally The high bidder for competitive-bidding auctions that have ended and have a winning bidder. This indicates the user who purchased the item.

Not returned for auctions that have received no bids, or for fixed price listings that are still active.

IncludeSelector: Details

See Item.Quantity.

Item.HighBidder
  .FeedbackPrivate
boolean Conditionally Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. If a bidder's user information is made anonymous, the value -99 is returned.

IncludeSelector: Details
Item.HighBidder
  .FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score.

Applicable values:

Blue
(out) Blue Star, feedback score 50-99.
CustomCode
(out) Placeholder value. See token.
Green
(out) Green Star, feedback score 5,000-9,999.
GreenShooting
(out) Green Shooting Star, feedback score 500,000-900,000.
None
(out) No graphic displayed, feedback score 0-9.
Purple
(out) Purple Star, feedback score 500-999.
PurpleShooting
(out) Purple Shooting Star, feedback score 50,000-99,999.
Red
(out) Red Star, feedback score 1,000-4,999
RedShooting
(out) Red Shooting Star, feedback score 100,000-499,999.
SilverShooting
(out) Silver Shooting Star, feedback score 1,000,000 and above.
Turquoise
(out) Turquoise Star, feedback score 100-499.
TurquoiseShooting
(out) Turquoise Shooting Star, feedback score 25,000-49,999.
Yellow
(out) Yellow Star, feedback score 10-49.
YellowShooting
(out) Yellow Shooting Star, feedback score 10,000-24,999.



IncludeSelector: Details
Item.HighBidder.FeedbackScore int Conditionally The aggregate feedback score of a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user.

Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user. (The buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.) That one feedback can be positive, negative, or neutral. The aggregate feedback score of a user represents 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, then FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

If a bidder's user information is made anonymous, the value -99 is returned.

IncludeSelector: Details
Item.HighBidder.UserAnonymized boolean Conditionally Indicates whether eBay has made this user's information anonymous. This occurs when the listing prices (reserve, current, or Buy It Now) reach or exceed a certain amount (such as $200 USD at the time of this writing).

If true, certain other fields about this user are not returned, or their values include no identifying characteristics. (The rules are explained in the description of each field.) If false, all user-specific fields contain the user's actual data.

IncludeSelector: Details
Item.HighBidder.UserID string Conditionally The user's unique eBay user ID.

When reporting UserIDs in bidding situations (such was when listing the high bidder in an auction), eBay replaces the UserID value with an anonymous bidder name value, such as "a***o".

IncludeSelector: Details
Item.HitCount long Conditionally The number of times the listing's View Item page has been viewed (as determined by eBay). Only returned if the seller has chosen to include a hit counter in the listing, and if the seller has also chosen to make the listing's hit count publicly visible. This field is retrieved asynchronously. If you believe the item has a publicly visible hit count, but this field is not returned, retry the call.

Not applicable to Half.com

IncludeSelector: Details
Item.IgnoreQuantity boolean Conditionally This field will only be returned (as 'True') in the case where items in a listing are only available to buyers through a local fulfillment method such as In-Store Pickup, eBay Now, or Click and Collect. And if a listing is truly a "local fulfillment" listing only, the value in the Item.Quantity field (for single-variation listings) or the Variation.Quantity field (for multi-variation listings) will default to '0' even though the quantity available is technically not zero, since items in the listing are still available through one or more local fulfillment methods.
Item
  .IntegratedMerchantCreditCardEnabled
boolean Always Indicates whether the item can be paid for through a payment gateway account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account.

IncludeSelector: Details
Item.ItemID string Always The ID that uniquely identifies the item listing. eBay generates this ID when an item is listed. This ID is unique across all eBay sites.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

IncludeSelector: none (not controlled by IncludeSelector)

See (GetSingleItem) Item.Variations.

Item.ItemSpecifics NameValueListArrayType Conditionally Category-specific fields that the seller added to describe the listing. The names of these fields are different for items in different categories, so they're returned in a generic Name/Value structure. The field names are usually very well known within the category.

For example, a book's item specifics might include a field like Publication Year=2007 (where Publication Year is returned in Name, and 2007 is returned in Value), and a field like Format=Hardcover. But a car's item specifics would be different from a book's, with fields like Make= Toyota and Model=Prius. And a ticket's item specifics would be different from those of books and cars, with fields like EventType=Concerts and Venue=The Fillmore.

One of the most common uses for item specifics is the item condition.

Only returned if the seller included Item Specifics in the listing.

IncludeSelector: ItemSpecifics
Item.ItemSpecifics
  .NameValueList
NameValueListType Conditionally,
repeatable: [0..*]
This list is an array of Item Specifics, which are category-specific fields that the seller added to describe the listing. The names of these fields are different for items in different categories, so they're returned in a generic name/value structure.

For example, Item Specifics for a car might include a field like Make=Toyota (where Make is returned in Name, and Toyota is returned in Value) and Model=Prius (where Model is returned in Name, and Prius is returned in Value).

In multi-variation listings, the same name cannot appear in both the VariationSpecifics node and in the ItemSpecifics node.

For FindProducts, this can also be an Item Specific that is defined for a product. That is, Item Specifics can be returned both for items and products in FindProducts.

IncludeSelector: ItemSpecifics
Item.ItemSpecifics
  .NameValueList.Name
string Conditionally The name of the item specific.

This field is returned only in responses if the seller included an item specific Name in the listing. However, if the seller didn't also include a corresponding value for the item specific, it is best to not display the name to name to avoid confusing users.

For the item condition, this usually includes the word "Condition" for eBay US, UK, Australia, and India listings; and "Artikelzustand" for eBay Germany, Austria, and Switzerland listings.

Note: Ignore item specifics with SIFFTAS in the name. These are for internal use by eBay and aren't meaningful to users.

IncludeSelector: ItemSpecifics
Item.ItemSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
A value for the item specific.

This field is only returned in responses if the seller included a value for an item specific. In the GetSingleItem response, this field is always returned for each item specific that is returned (if any). However, if the seller didn't select a value for the item specific, this field may return empty, or it may return a value like "-", "Not Selected", or "Unspecified" (or the equivalent in the language of the site).

For the item condition, this usually includes the word "New" or "Used" for eBay US, UK, Australia, and India listings; and "Neu" or "Gebraucht" for eBay Germany, Austria, and Switzerland listings.

IncludeSelector: ItemSpecifics
Item.ListingStatus ListingStatusCodeType Always Specifies a listing's status in eBay's processing workflow. If an item's EndTime is in the past, but no details about the buyer or high bidder are shown (and the user is not anonymous), use this listing status information to determine whether eBay has finished processing the listing.

Applicable values:

Active
(out) The listing is still live, or it has recently ended but eBay has not completed processing the listing (e.g., we're still determining the high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing's end time has passed. (That is, if the listing has a Quantity of 10, the sale of 1 of those items doesn't end the listing.) If the listing has ended but this Active status is returned, please allow several minutes for eBay to finish processing the listing.
Completed
(out) The listing has ended and eBay has completed processing of the sale (if any), such as determining the high bidder. You can think of Completed and Ended as essentially equivalent. (The difference is only meaningful to the seller of the item, as Completed indicates whether eBay has finished calculating certain selling fees.)
CustomCode
(out) Placeholder value. See token.
Ended
(out) The listing has ended and eBay has completed processing of the sale (if any), such as determining the high bidder.



IncludeSelector: none (not controlled by IncludeSelector)
Item.ListingType ListingTypeCodeType Always The format of the listing, such as online auction, fixed price, or advertisement format.

Applicable values:

AdType
(out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.
Chinese
(out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.
CustomCode
(out) Placeholder value. See token.
FixedPriceItem
(out) A basic fixed-price listing with a Quantity of 1. Allows no auction-style bidding. Also known as Buy It Now Only on some sites, this should not to be confused with the BuyItNow option that is available for competitive-bid auctions. Fixed-price listings appear on eBay.com. They are also listed in a seller's eBay Store if the seller is a Store owner.
LeadGeneration
(out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).
PersonalOffer
(out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. Second- chance offer items are on eBay, but they do not appear when browsing or searching listings. You need to already know the item ID in order to retrieve a second-chance offer.
Unknown
(out) Unknown auction type. (This is not normally used.)

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


IncludeSelector: none (not controlled by IncludeSelector)
Item.Location string Always Physical location of the item, as specified by the seller. (This gives a general indication of where the item will be shipped or delivered from.)

IncludeSelector: none (not controlled by IncludeSelector)
Item.LotSize int Conditionally A lot is a set of two or more similar items that must be purchased together in a single transaction. A listing can have multiple lots (instead of multiple items). When LotSize is specified, the listing price reflects the price of each lot (not each item within the lot). In this case, Quantity indicates the number of lots being listed, and LotSize indicates the number of items in each lot. (If a listing has no lots, Quantity indicates the number of separate items being listed.) Important: Lot items can be listed only in lot-enabled categories. GetCategories returns lot size disabled with a value of true for categories that do not support lots.

Not applicable to Half.com.
Max: 100000.

IncludeSelector: Details
Item.MinimumToBid AmountType (double) 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 competitive-bid auction listings. Returns null for basic Fixed Price (FixedPriceItem) and Ad type listings.

IncludeSelector: Details
Item.NewBestOffer boolean Always This boolean field will be returned as 'true' if a fixed-price listing is requiring immediate payment, and the item's category supports Immediate Payment for Best Offers. Initially, Immediate Payment for Best Offers will be supported by the Computers & Tablets, Jewelry & Watches, and Art categories, but this feature will get enabled in more categories going forward.

If the Immediate Payment for Best Offers feature is enabled for a fixed-price listing, and a buyer's Best Offer for the item is accepted by the seller, that buyer will be expected to pay immediately for the item, or that buyer will run the risk of losing the item to another buyer since that item will remain on sale until payment is made.

IncludeSelector: Details
Item.PaymentAllowedSite SiteCodeType Always,
repeatable: [1..*]
Enables you to view the sites on which an item can be purchased, based on the payment methods offered for the item.

Applicable values: See PaymentAllowedSite.

IncludeSelector: Details
Item.PaymentMethods BuyerPaymentMethodCodeType Conditionally,
repeatable: [0..*]
Identifies the payment method (such as PayPal) the seller will accept when the buyer pays for the item.

Note: If the seller only accepts PayPal, the buyer can still pay with a credit card. PayPal supports major credit cards.
Payment methods are not applicable to eBay Real Estate advertisement listings, or other Classified Ad format listings.

Applicable values: See PaymentMethods.

IncludeSelector: Details
Item.PictureURL anyURI Conditionally,
repeatable: [0..24]
Contains the URL for an image associated with the item, if any. Returned only if the seller included at least one picture in their listing. Note that this element does not return the URLs of pictures that the seller included in the Description via HTML IMG tags.

Items listed the main eBay site can have a maximum of 12 picture URLs hosted by eBay Picture Services or a maximum of 12 picture URLs hosted externally (outside of eBay). Note that a listing can have up to 24 picture URLs on the US eBay Motors site (for all vehicle listings), and on the eBay Canada Motors site.

eBay uses the seller's first picture at the top of the listing's View Item page.
Max length: 150.

IncludeSelector: none (not controlled by IncludeSelector)
Item.PostalCode string Always Postal code indicating the physical location of the item, as specified by the seller. (This gives a general indication of where the item will be shipped or delivered from.)

IncludeSelector: Details
Item.PrimaryCategoryID string Always Numeric ID of the first (or only) category in which the item is listed. (Listings can appear in more than one category.)

IncludeSelector: none (not controlled by IncludeSelector)
Item.PrimaryCategoryIDPath string Always The fully qualified ID breadcrumb (path) of the first category. For example, if the primary category ID is 45678, and its parent category's ID is 123, the breadcrumb (path) would be 123:45678.

IncludeSelector: Details
Item.PrimaryCategoryName string Always Display name of the first (or only) category in which the item is listed. This is a fully qualified category breadcrumb (e.g., Computers & Networking:Laptops, Notebooks).

IncludeSelector: none (not controlled by IncludeSelector)
Item.ProductID ProductIDType (string) Conditionally A prototype description of a well-known type of item, such as a popular book.

When returned for GetSingleItem, is always of type Reference, and serves as a global reference ID for an eBay catalog product.

When used as input, retrieves product details for one specific product. Specify the ID as a string, and use the type attribute to indicate the nature of the ID you are specifying.

The request requires either QueryKeywords or ProductID, but these fields cannot be used together.
Max length: 4000.

IncludeSelector: Details
Item.Quantity int Always The number of items the seller is offering in the listing. (Subtract Item.QuantitySold from this value to calculate the number of items currently available for sale.)

An auction listing always has a Quantity of 1. Basic fixed-price listings can have a Quantity of 1 or more.

The listing's current or Buy It Now price is the price of the item in the listing.

Note: A seller can also offer multiple items for sale with a single price for all the items. For example, instead of listing 10 light bulbs for US 2.00 each, they might list 10 light bulbs for USD 20.00 (where you have to buy all 10). This is called a "lot."

If the listing includes a lot, Quantity does not specify the lot size; it reflects how many lots are being sold. For example, if the original listing included 5 lots of 10 light bulbs each, Quantity would be 5.



IncludeSelector: Details

See Item.ListingType.

Item.QuantityAvailableHint QuantityAvailableHintCodeType Conditionally Indicates the type of message that will be returned describing the quantity available for the item.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Limited
(out) The message "Limited quantity available" is shown in the web flow (e.g., for a flash sale or a Daily Deal).
MoreThan
(out) The message "More than 10 available" is shown in the web flow. 10 is the value of QuantityThreshold tag based on the seller's preference.



IncludeSelector: Details
Item.QuantityInfo QuantityInfo Conditionally This container consists of the MinimumRemnantSet field, which sets the minimum amount of event tickets that can remain in the fixed-price listing's inventory after a buyer purchases one or more tickets (but not all) from the listing.

This field is currently only applicable for event ticket listings in US and CA, but may apply to other categories in the future. It is only returned if set by the seller in the listing.

IncludeSelector: none (not controlled by IncludeSelector)
Item.QuantityInfo
  .MinimumRemnantSet
int Conditionally This field enables the seller to avoid being left with 1 item in a multi-quantity, fixed- priced event ticket listing. A typical use case is event tickets in reserved, adjacent seats, or items that typically only sell if more than 1 can be purchased at once.

At listing time, sellers specify the minimum number of items that should remain if a buyer doesn't purchase all the items. Based on the value of MinimumRemnantSet and the listing's available quantity (Quantity-QuantitySold), eBay calculates the quantity of tickets a buyer can purchase. For example, suppose a seller lists 5 tickets, and wants at least 2 tickets remaining for the final buyer to purchase. In this case, the seller would set MinimumRemnantSet to '2'. This means a buyer can purchase 1, 2, 3, or 5 tickets, but not 4 (because 4 would leave the seller with 1 ticket).

To remove this restriction when revising or relisting item, the seller would set the MinimumRemnantSet value to '1'.

This field is currently only applicable for event ticket listings in US and CA, but may apply to other categories in the future. It is only returned if set by the seller in the listing.
Item.QuantitySold int Always Number of items purchased so far from this listing. (Subtract this value from Item.Quantity to calculate the number of items currently available for sale.)

IncludeSelector: Details
Item
  .QuantitySoldByPickupInStore
int Always This field indicates the total quantity of items sold and picked up by buyers using the In-Store Pickup option. This value is the total number of items purchased by one or more buyers using the In-Store Pickup option, and is not the total number of In-Store Pickup orders. So, if two buyers selected the In-Store Pickup option, but each of these buyers bought a quantity of five of these items (in same purchase), the Item.SellingStatus.QuantitySoldByPickupInStore value would be '10' and not '2'.

In the case of multi-variation, fixed-price listings, each Item.Variations.Variation.SellingStatus.QuantitySoldByPickupInStore value indicates the total quantity of that corresponding item variation (for example, large blue shirts) sold and picked up by buyers using the In-Store Pickup option, and the Item.SellingStatus.QuantitySoldByPickupInStore value would be the total quantity of all item variations sold for the listing.

This field will only be returned if the listing is eligible for In-Store Pickup.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Sellers who are eligible for the In-Store Pickup feature can start listing items in Production with the In-Store Pickup option beginning in late September 2013.

IncludeSelector: Details
Item.QuantityThreshold int Conditionally The quantity threshold above which the seller prefers not to show the actual quantity available. Returned when the quantity available is greater than the value of quantity threshold. Currently, 10 is the only available value for this threshold.

IncludeSelector: Details
Item.ReserveMet boolean Always Indicates whether any bids on this item are greater than the seller's reserve price for the listing (if any).

A reserve is the lowest price at which the seller is willing to sell the item. The reserve price is higher than the listing's opening bid (minimum bid) and lower than the Buy It Now price, if any. (The reserve price is only known to the seller.) Some sellers don't set a reserve at all. If a listing does have a reserve price, the highest bidder will only win the item if their bid is also above that price.

Only returned for online auctions that have a reserve price. (Fixed price, Store Inventory, and classified ad listings don't have reserve prices.)

IncludeSelector: Details
Item.ReturnPolicy ReturnPolicyType Conditionally If a seller specified return policy details, then this container has fields with those details. The fields that can be returned in this container vary by site.

IncludeSelector: Details
Item.ReturnPolicy.Description string Conditionally A description of the return policy for the item.

IncludeSelector: Details
Item.ReturnPolicy.EAN string Conditionally Contains the EAN.

IncludeSelector: Details
Item.ReturnPolicy.Refund string Conditionally Specifies how a refund will be made, e.g. as an exchange.

IncludeSelector: Details
Item.ReturnPolicy
  .RestockingFeeValue
token Conditionally Display string that indicates the restocking fee charged by the seller for returned items. This value is directly related to the RestockingFeeValueOption value, with the difference being that applications can use RestockingFeeValue to present the RestockingFeeValueOption value buttons or drop-down lists.
Item.ReturnPolicy
  .RestockingFeeValueOption
token Conditionally This enumeration value indicates the restocking fee charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.
Item.ReturnPolicy
  .ReturnsAccepted
string Conditionally Information about returns accepted.

IncludeSelector: Details
Item.ReturnPolicy
  .ReturnsWithin
string Conditionally Specifies the length of time in which the item must be returned under the return policy.

IncludeSelector: Details
Item.ReturnPolicy
  .ShippingCostPaidBy
string Conditionally The party who pays the cost of shipping for a returned item.

IncludeSelector: Details
Item.ReturnPolicy
  .WarrantyDuration
string Conditionally The length of the warranty offered.

IncludeSelector: Details
Item.ReturnPolicy
  .WarrantyOffered
string Conditionally Information about the warranty offered.

IncludeSelector: Details
Item.ReturnPolicy.WarrantyType string Conditionally The type of warranty offered.

IncludeSelector: Details
Item.SecondaryCategoryID string Conditionally ID of the second category in which the item is listed. Returned only if the seller listed a second category.

IncludeSelector: Details
Item.SecondaryCategoryIDPath string Conditionally The fully qualified ID breadcrumb (path) of the second category. For example, if the secondary category ID is 45678, and its parent category's ID is 123, the breadcrumb (path) would be 123:45678. Returned only if the seller listed a second category.

IncludeSelector: Details
Item.SecondaryCategoryName string Conditionally Name of the second category in which the item is listed. Returned only if the seller listed a second category.

IncludeSelector: Details
Item.Seller SimpleUserType Always Container for information about this listing's seller.

IncludeSelector: Details
Item.Seller.FeedbackRatingStar FeedbackRatingStarCodeType Always Visual indicator of user's feedback score.

Applicable values:

Blue
(out) Blue Star, feedback score 50-99.
CustomCode
(out) Placeholder value. See token.
Green
(out) Green Star, feedback score 5,000-9,999.
GreenShooting
(out) Green Shooting Star, feedback score 500,000-900,000.
None
(out) No graphic displayed, feedback score 0-9.
Purple
(out) Purple Star, feedback score 500-999.
PurpleShooting
(out) Purple Shooting Star, feedback score 50,000-99,999.
Red
(out) Red Star, feedback score 1,000-4,999
RedShooting
(out) Red Shooting Star, feedback score 100,000-499,999.
SilverShooting
(out) Silver Shooting Star, feedback score 1,000,000 and above.
Turquoise
(out) Turquoise Star, feedback score 100-499.
TurquoiseShooting
(out) Turquoise Shooting Star, feedback score 25,000-49,999.
Yellow
(out) Yellow Star, feedback score 10-49.
YellowShooting
(out) Yellow Shooting Star, feedback score 10,000-24,999.



IncludeSelector: Details
Item.Seller.FeedbackScore int Always The aggregate feedback score of a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user.

Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user. (The buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.) That one feedback can be positive, negative, or neutral. The aggregate feedback score of a user represents 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, then FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

If a bidder's user information is made anonymous, the value -99 is returned.

IncludeSelector: Details
Item.Seller
  .PositiveFeedbackPercent
float Always A seller's positive feedback score. The percentage value of a seller's positive feedback is calculated by dividing the seller's positive feedback score by their negative feedback score. The last 12 months of feedback scores are taken into consideration for this calculation.

IncludeSelector: Details
Item.Seller.TopRatedSeller boolean Conditionally Returned when seller is certified as a top-rated seller, and is qualified for benefits such as final value fee discount and increased visibility in fixed-price searches.

IncludeSelector: Details
Item.Seller.UserID string Always The user's unique eBay user ID.

When reporting UserIDs in bidding situations (such was when listing the high bidder in an auction), eBay replaces the UserID value with an anonymous bidder name value, such as "a***o".

IncludeSelector: Details
Item.ShippingCostSummary ShippingCostSummaryType Always Important: This container and its children do not provide reliable shipping cost information when returned by the FindPopularItems, FindProducts, GetMultipleItems and GetSingleItem calls. If a listing has shipping costs, use the GetShippingCosts call to get more details about the services and costs that the seller is offering.

IncludeSelector: ShippingCosts

See GetShippingCosts.

Item.ShippingCostSummary
  .InsuranceCost
AmountType (double) Conditionally The cost of insurance. For flat rate shipping, this is the value set by the seller, if any. For calculated shipping, this is the value calculated by eBay with the shipping carrier for the particular item and can only be determined once the final item price is known when the listing ends. To determine whether a listing has ended, see EndTime or ListingStatus in GetSingleItem.

Note: This field provides reliable shipping cost information only when returned by the GetShippingCosts call.

IncludeSelector: ShippingCosts
Item.ShippingCostSummary
  .ListedShippingServiceCost
AmountType (double) Conditionally The listed shipping cost of the item. If multiple items were purchased, this includes the listed ShippingServiceAdditionalCost.



Note: This field provides reliable shipping cost information only when returned by the GetShippingCosts call.

IncludeSelector: ShippingCosts
Item.ShippingCostSummary
  .LocalPickup
boolean Conditionally If ShippingCosts is specified for the IncludeSelector, and if the seller has specified local pickup for this item; the LocalPickup boolean is returned as true. This indicates that the seller does not ship this item. If local pickup was not specified for this item by the seller, the LocalPickup boolean is not returned.

Note: This field provides reliable shipping cost information only when returned by the GetShippingCosts call.

IncludeSelector: ShippingCosts
Item.ShippingCostSummary
  .ShippingServiceCost
AmountType (double) Conditionally The basic shipping cost of the item. This reflects the domestic shipping cost or the international shipping costs, depending on which applies (that is, whether the bidder/buyer is in the same country as the listing site of the item).

Note: This field provides reliable shipping cost information only when returned by the GetShippingCosts call. Flat shipping: single-item listing: this matches (in)ShippingServiceCost; multi-quantity listing: with a request version of 665 or greater, this is the total of (in)ShippingServiceCost plus ((in)ShippingServiceAdditionalCost times the number of items beyond the first item), and with a request version lower than 665, this is (in)ShippingServiceCost.

Promotional shipping: For a request version lower than 665, promotional shipping has no effect on shipping costs. Otherwise: 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).

Shipping surcharge: With a request version of 665 or greater, shipping cost includes any surcharge, and surcharge is not returned as an individual tag. With a request version lower than 665, surcharge is not part of the total cost and is returned as its own tag.

IncludeSelector: ShippingCosts
Item.ShippingCostSummary
  .ShippingType
ShippingTypeCodeType Always How the seller stated that cost of shipping is to be determined, such as flat rate or calculated.

Note: This field provides reliable shipping cost information only when returned by the GetShippingCosts call.

Applicable values:

Calculated
(out) The calculated shipping model: the posted cost of shipping is based on the seller-offered and buyer-selected shipping service, where the shipping costs are calculated by eBay and the shipping carrier based on the buyer's address, and any packaging/handling costs established by the seller are automatically rolled into the total.
CalculatedDomesticFlatInternational
(out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.
CustomCode
(out) Placeholder value. See token.
Flat
(out) The flat rate shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.
FlatDomesticCalculatedInternational
(out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.
Free
(out) Free is used when the seller is declaring that shipping is free for the buyer. Since Free cannot be selected via API, the seller has two options for signifying that shipping is free when listing an item:
- omit shipping details, mention in the item description that shipping is free, and set ShippingTermsInDescription to true
- select an arbitrary shipping service and set its shipping cost to 0, mention in the item description that shipping is free, and set ShippingTermsInDescription to true
The latter is a better way to communicate "free shipping" because eBay picks up the "0" cost and can more accurately identify shipping costs in search results.
Freight
(out) The freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code). Currently, Freight can only be specified on input via eBay Web site, not via API.
NotSpecified
(out) The seller did not specify the shipping type.



IncludeSelector: ShippingCosts
Item.ShipToLocations string Always,
repeatable: [1..*]
An international location or region to which the seller is willing to ship this item. Returned only for items that have ShipToLocations specified.

Applicable values:

•   Americas

(North, South, or Latin America)

•   Asia

•   Caribbean

•   Europe

•   EuropeanUnion

•   LatinAmerica

•   MiddleEast

•   NorthAmerica

•   Oceania

(Pacific region other than Asia)

•   SouthAmerica

•   WillNotShip

(No shipping, buyer must pick up the item)

•   Worldwide

(Seller will ship worldwide)

•   2-letter country identifier

(See CountryCodeType for values)



IncludeSelector: Details

See CountryCodeType.

Item.Site SiteCodeType Always The name of the eBay site on which the item was originally listed. For example, if the item is listed on the eBay US site, the value would be US. If it's listed on the eBay Germany site, the value would be Germany.

The listing's original site can affect the values of converted (localized) prices (when your request specifies a site that is different from the listing's site).

Applicable values: See Site.

IncludeSelector: Details
Item.SKU string Conditionally A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier.

Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetMyeBaySelling, this is only returned if set.
Not applicable to Half.com.
Max length: 50.

IncludeSelector: Details
Item.StartTime dateTime Always Time stamp (in GMT) that eBay recorded as the moment that the listing was made available. The start time returned by a search call may vary from the value returned by GetSingleItem.

IncludeSelector: Details
Item.Storefront StorefrontType Always Returns the seller's store information if the seller has an eBay store. Returns a blank store if the seller does not have an eBay storefront.

IncludeSelector: Details
Item.Storefront.StoreName string Always The name of the seller's eBay Store. Not returned if the seller does not have an eBay store.

FindProducts returns an empty value for all items at the time of this writing. FindHalfProducts returns the name of seller's Half.com Shop, which is the SellerID.
Max length: 200.

IncludeSelector: Details
Item.Storefront.StoreURL anyURI Always The URL of the seller's eBay Store page. Not returned if the seller does not have an eBay store.

FindProducts only returned a default URL at the time of this writing. FindHalfProducts returns the URL of the seller's Half.com Shop page.

IncludeSelector: Details
Item.Subtitle string Conditionally Subtitle of the item. Only returned if the seller included a subtitle for the listing.

For US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or listings in CA eBay Motors passenger vehicle and motorcycle categories, the seller's subtitle is only available in the Item.ItemSpecifics node. Call GetSingleItem with IncludeSelector=ItemSpecifics to retrieve a listing's Item Specifics.

IncludeSelector: Details
Item.TimeLeft duration Always Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). For ended listings, the time left is PT0S (zero seconds).

IncludeSelector: none (not controlled by IncludeSelector)

See (GetSingleItem) Item.Variations.

Item.Title string Always Name of the item as it appears in the listing or in search and browse results.

For US eBay Motors vehicles only: In item-retrieval calls (like GetSingleItem and GetMultipleItems), this value shows the vehicle Make and Model (e.g., "Buick : Skylark").

Note: GetSingleItem does not return the same Item.Title value for US eBay Motors listings. Here's why:

In general, GetSingleItem maps to eBay's View Item page. The eBay Motors Web site's View Item page shows two vehicle titles in the title bar: One title is a label based on the Year, Make, Model, and Submodel (e.g., "1996 Buick Skylark Limited"). The model is included unless it's "Other" or unspecified. The submodel is included if the seller specified a submodel. The other title is a path based on the Make and Model (e.g., "Buick : Skylark"). The Item.Title value in GetSingleItem maps to this path.



IncludeSelector: none (not controlled by IncludeSelector)
Item.TopRatedListing boolean Conditionally This field is only applicable to the US, UK, and Germany sites, and will only be returned if the seller qualifies as a Top-Rated Seller. The current requirements for US sellers to qualify as Top-Rated Sellers are summarized below. The requirements on the UK and Germany sites are different. To see those requirements, see the UK or Germany customer support/help pages.
  • 100 or more selling transactions over the last 12-month period
  • One thousand dollars or more in sales to US buyers over the last 12-month period
  • Shipment tracking information provided to buyer within handling time for at least 90 percent of their listings
  • Two percent or less of transactions with one or more defects over the current evaluation period
  • Less than one percent of eBay Buyer Protection and/or PayPal Purchase Protection cases can end without seller resolution


If this flag is returned for a listing, it indicates that the listing meets the new requirements for a Top-Rated Listing. The following must be offered by a US seller for the listing to become a Top-Rated Listing on the US site:
  • 14-day (or longer) return policy with Money Back option
  • Same-day or 1 business day handling time


The Top-Rated Plus seal appears on the View Item page for all Top-Rated Listings. US Top-Rated Sellers get a 20 percent discount on their FVF for all listings that qualify as Top-Rated Listings.

IncludeSelector: none (not controlled by IncludeSelector)
Item.UnitInfo UnitInfoType Conditionally Contains information about the weight, volume or other quantity measurement of a listed item so buyers can compare per-unit prices. The European Union requires listings for certain types of products to include the price per unit. eBay uses this information and the item's listed price to calculate and display the unit price on eBay EU sites.

Note: This information is currently required only for business sellers, and only for listings with a Buy It Now option.

IncludeSelector: none (not controlled by IncludeSelector)
Item.UnitInfo.UnitQuantity double Conditionally Number of units of size, weight, volume or count of the item in the specified unit type. eBay will divide the item price by this number to get the price per unit that will be displayed in the item listing for comparison purposes.
Item.UnitInfo.UnitType string Conditionally Designation of size, weight, volume or count to be used to specify the unit quantity of the item. The value can be one of the following:

Kg 100g 10g L 100ml 10ml M M2 M3 Unit
Item.Variations VariationsType Conditionally Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a single listing could contain multiple items of the same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and price. Only returned if the listing contains multiple variations.

IncludeSelector: Variations
Item.Variations.Pictures PicturesType Conditionally Contains a set of pictures that correspond to one of the variation specifics, such as Color. For example, if a listing has blue and black color variations, a listing could specify the name Color as an organizing mechanism for all the pictures, and then include a set of pictures for the blue variations and another set of pictures for the black variations.

Note: Only one Pictures node is currently returned for a listing. However, the node has been defined as unbounded (repeatable) in the schema to allow for different use cases for some calls or sites in the future.

IncludeSelector: Variations
Item.Variations.Pictures
  .VariationSpecificName
string Conditionally One aspect of the variations that will be illustrated in the pictures for all variations. For example, if each variation is visually distinguished by color and the pictures show the different colors available, then specify "Color" as the name. The name must match one of the names specified in the variation specifics.

IncludeSelector: Variations
Item.Variations.Pictures
  .VariationSpecificPictureSet
VariationSpecificPictureSetType Conditionally,
repeatable: [0..*]
One or more pictures that help buyers distinguish the Variations. Multiple picture sets can be specified. For example, suppose a listing contains blue and black color variations, and VariationSpecificName=Color. In this case, one picture set could contain pictures of the blue shirts (e.g., front view, back view, and close-up of a trim detail), and another picture set could contain pictures of the black shirts.

Sellers do not necessarily provide pictures for all values that correspond to the variation specific name. For example, a listing could have pictures depicting the blue and black color variations, but not the pink variations.

IncludeSelector: Variations
Item.Variations.Pictures
  .VariationSpecificPictureSet
  .PictureURL
anyURI Conditionally,
repeatable: [0..*]
The URL of a picture that is associated with VariationSpecificValue. The first PictureURL is also used as the gallery picture for applicable variations. For example, if the picture set contains pictures of red shirts (i.e., VariationSpecificName=Color and VariationSpecificValue=Red), the first picture is used as the gallery picture for all the red shirt variations.

IncludeSelector: Variations
Item.Variations.Pictures
  .VariationSpecificPictureSet
  .VariationSpecificValue
string Conditionally A value that is associated with VariationSpecificName. For example, suppose this set of pictures is showing blue shirts, and some of the variations include Color=Blue in their variation specifics. If VariationSpecificName is "Color", then VariationSpecificValue would be "Blue".

IncludeSelector: Variations
Item.Variations.Variation VariationType Conditionally,
repeatable: [0..*]
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes.

IncludeSelector: Variations
Item.Variations.Variation
  .DiscountPriceInfo
DiscountPriceInfoType Conditionally This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP applies to only fixed price, BIN items. STP is available on the US, UK, and German (DE) sites, while MAP is available only on the US site.

Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a "special account flag" (SAF) that allows them to apply Discount Pricing to both MSKU and Non-MSKU items.

See Displaying Discount Pricing Information to Buyers.

Item.Variations.Variation
  .DiscountPriceInfo
  .MinimumAdvertisedPrice
AmountType (double) Conditionally A value equal to the agreed upon minimum advertised price.

The minimum advertised price is an agreed upon price that is set by the suppliers/OEMs and the retailers/sellers. The minimum advertised price is the lowest price for which an item can be advertised. Large volume sellers can negotiate with the suppliers/OEMs to offer certain items below the set minimum advertised price. eBay does not maintain or validate the agreed upon minimum advertised price; the seller is responsible for setting this value in accordance with their agreement with the supplier/OEMs. MAP pricing treatments apply to only fixed price, BIN items listed on the eBay US site.
Item.Variations.Variation
  .DiscountPriceInfo
  .MinimumAdvertisedPriceExposure
MinimumAdvertisedPriceExposureCodeType Conditionally If an item listing qualifies it to be listed as a MAP item (PricingTreatment returns MAP), the item price cannot be directly displayed on the page containing the item. When listing a MAP item, the seller stipulates how they want the buyer to view the price of the item by setting this field to either PreCheckout or DuringCheckout. If this field is not set for a MAP item, the treatment defaults to PreCheckout.

If this field is set to PreCheckout, the buyer must click a link (or button) to view the item price on a different page (such as in a pop-up window). If this field is set to DuringCheckout, the StartPrice must be shown only when the buyer in the eBay checkout flow.

MAP items are supported only on the eBay US site.

Applicable values:

CustomCode
(out) Reserved for future use.
DuringCheckout
(out) DuringCheckout specifies that the discounted price must be shown on the eBay checkout flow page.
None
(out) None means the discount price is not shown via either PreCheckout nor DuringCheckout.
PreCheckout
(out) PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate page (or window) that displays the discount price.

Item.Variations.Variation
  .DiscountPriceInfo
  .OriginalRetailPrice
AmountType (double) Conditionally This field specifies the price to which the discounted-price display treatment will be applied (for example, a strikethrough price). The discounted price of an item (specified in the CurrentPrice field) is the BIN price and is less than the OriginalRetailPrice of the item.

See Displaying Discount Pricing Information to Buyers for guidelines on displaying STP and MAP items.

Item.Variations.Variation
  .DiscountPriceInfo
  .PricingTreatment
PricingTreatmentCodeType Conditionally This field denotes whether or not an item qualifies for a discount pricing treatment display. If a seller lists an item with DiscountPriceInfo values, the item response container will include a DiscountPriceInfo container with this field set to either STP, MAP, or None. If this field is set to MAP, you must abide by the rules for displaying MAP items, as described in MinimumAdvertisedPriceExposure.

Important: For listings that return PricingTreatment set to MAP, you are legally required to follow the rules for displaying the price of the item to potential buyers. You are bound by the terms of the API License Agreement to follow these rules. Refer to the API License Agreement for consequences of non-compliance.

Applicable values:

CustomCode
(out) Reserved for future use.
MAP
(out) MAP stands for Minimum Advertised Price.
None
(out) None means the item does not qualify for either STP or MAP pricing.
STP
(out) STP stands for Strikethrough Pricing.

Item.Variations.Variation
  .DiscountPriceInfo.SoldOffeBay
boolean Conditionally Used by the eBay UK and eBay Germany (DE) sites, this field indicates that the discount price (specified as currentPrice) is the price for which the seller offered the same item for sale on a web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the seller's own price for the item.

In the event both soldOffeBay and soldOneBay fields are set, soldOneBay takes precedence.
Item.Variations.Variation
  .DiscountPriceInfo.SoldOneBay
boolean Conditionally Used by the eBay UK and eBay Germany (DE) sites, this field indicates that the discount price (specified as CurrentPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days. The discount price is always in reference to the seller's own price for the item.

In the event both soldOffeBay and soldOneBay fields are set, soldOneBay takes precedence.
Item.Variations.Variation
  .Quantity
int Conditionally The number of items available for sale that are associated with this variation.
Min: 1.

IncludeSelector: Variations
Item.Variations.Variation
  .SellingStatus
SellingStatusType Conditionally Contains the variation's current price and quantity sold. Always returned when variations are present.

IncludeSelector: Variations
Item.Variations.Variation
  .SellingStatus.QuantitySold
int Conditionally The number of items sold from this variation. Subtract from Quantity to determine the number of items available.

IncludeSelector: Variations
Item.Variations.Variation
  .SellingStatus
  .QuantitySoldByPickupInStore
int Conditionally This field indicates the total quantity of that corresponding item variation (for example, large blue shirts) sold and picked up by buyers using the In-Store Pickup option. This value is the total quantity of this item variation purchased by one or more buyers using the In-Store Pickup option, and is not the total number of In-Store Pickup orders for that item variation. So, if two buyers selected the In-Store Pickup option, but each of these buyers bought a quantity of five of these item variations (in same purchase), the Item.Variations.Variation.SellingStatus.QuantitySoldByPickupInStore value would be '10' and not '2'.

This field will only be returned if the listing is eligible for In-Store Pickup.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

IncludeSelector: Variations
Item.Variations.Variation.SKU string Conditionally An SKU (stock keeping unit) is an identifier defined by a seller. If you need to contact the seller to ask a question about a particular variation, you can mention the SKU (if present) to help the seller identify the variation you're interested in. Only returned if the seller chose to specify a SKU for the variation.
Max length: 70.

IncludeSelector: Variations
Item.Variations.Variation
  .StartPrice
AmountType (double) Conditionally The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

Each variation has its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Always returned) for multi-variation listings.

IncludeSelector: Variations
Item.Variations.Variation
  .VariationSpecifics
NameValueListArrayType Conditionally,
repeatable: [2..5]
A list of name/value pairs that uniquely identify the variation within the listing. All variations specify the same set of names, and each variation provides a unique combination of values for those names. For example, if the items vary by color and size, then every variation specifies Color and Size as names, and no two variations can specify the same combination of color and size values. Use this information to identify a variation of interest when you communicate with the seller.

If your application supports PlaceOffer (in the Trading API), you use this information to uniquely identify the variation that you want to purchase.

IncludeSelector: Variations
Item.Variations.Variation
  .VariationSpecifics
  .NameValueList
NameValueListType Conditionally,
repeatable: [0..*]
This list is an array of Item Specifics, which are category-specific fields that the seller added to describe the listing. The names of these fields are different for items in different categories, so they're returned in a generic name/value structure.

For example, Item Specifics for a car might include a field like Make=Toyota (where Make is returned in Name, and Toyota is returned in Value) and Model=Prius (where Model is returned in Name, and Prius is returned in Value).

In multi-variation listings, the same name cannot appear in both the VariationSpecifics node and in the ItemSpecifics node.

For FindProducts, this can also be an Item Specific that is defined for a product. That is, Item Specifics can be returned both for items and products in FindProducts.

IncludeSelector: Variations
Item.Variations.Variation
  .VariationSpecifics
  .NameValueList.Name
string Conditionally The name of the item specific.

This field is returned only in responses if the seller included an item specific Name in the listing. However, if the seller didn't also include a corresponding value for the item specific, it is best to not display the name to name to avoid confusing users.

For the item condition, this usually includes the word "Condition" for eBay US, UK, Australia, and India listings; and "Artikelzustand" for eBay Germany, Austria, and Switzerland listings.

Note: Ignore item specifics with SIFFTAS in the name. These are for internal use by eBay and aren't meaningful to users.

IncludeSelector: Variations
Item.Variations.Variation
  .VariationSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
A value for the item specific.

This field is only returned in responses if the seller included a value for an item specific. In the GetSingleItem response, this field is always returned for each item specific that is returned (if any). However, if the seller didn't select a value for the item specific, this field may return empty, or it may return a value like "-", "Not Selected", or "Unspecified" (or the equivalent in the language of the site).

For the item condition, this usually includes the word "New" or "Used" for eBay US, UK, Australia, and India listings; and "Neu" or "Gebraucht" for eBay Germany, Austria, and Switzerland listings.

IncludeSelector: Variations
Item.Variations
  .VariationSpecificsSet
NameValueListArrayType Conditionally A list of all variation names and values that are defined on the item. This could include values that were previously defined (but no longer for sale).

eBay uses this list to configure variation selection widgets that appear on eBay's View Item page. For example, if Color and Size are names in the list, then eBay's View Item page displays Color and Size drop-down lists to help a buyer choose a variation of interest.

The order in which the names and values are returned matches the order in which the selection widgets appear on the View Item page. For example, if the names "Color", then "Size", and then "Sleeve Style" are returned, the View Item page shows drop-down lists with those labels in that order. For "Size", if the values returned are "S", "M", and then "L", the View Item page shows the values in that order in the Size drop-down list.

IncludeSelector: Variations
Item.Variations
  .VariationSpecificsSet
  .NameValueList
NameValueListType Conditionally,
repeatable: [0..*]
This list is an array of Item Specifics, which are category-specific fields that the seller added to describe the listing. The names of these fields are different for items in different categories, so they're returned in a generic name/value structure.

For example, Item Specifics for a car might include a field like Make=Toyota (where Make is returned in Name, and Toyota is returned in Value) and Model=Prius (where Model is returned in Name, and Prius is returned in Value).

In multi-variation listings, the same name cannot appear in both the VariationSpecifics node and in the ItemSpecifics node.

For FindProducts, this can also be an Item Specific that is defined for a product. That is, Item Specifics can be returned both for items and products in FindProducts.

IncludeSelector: Variations
Item.Variations
  .VariationSpecificsSet
  .NameValueList.Name
string Conditionally The name of the item specific.

This field is returned only in responses if the seller included an item specific Name in the listing. However, if the seller didn't also include a corresponding value for the item specific, it is best to not display the name to name to avoid confusing users.

For the item condition, this usually includes the word "Condition" for eBay US, UK, Australia, and India listings; and "Artikelzustand" for eBay Germany, Austria, and Switzerland listings.

Note: Ignore item specifics with SIFFTAS in the name. These are for internal use by eBay and aren't meaningful to users.

IncludeSelector: Variations
Item.Variations
  .VariationSpecificsSet
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
A value for the item specific.

This field is only returned in responses if the seller included a value for an item specific. In the GetSingleItem response, this field is always returned for each item specific that is returned (if any). However, if the seller didn't select a value for the item specific, this field may return empty, or it may return a value like "-", "Not Selected", or "Unspecified" (or the equivalent in the language of the site).

For the item condition, this usually includes the word "New" or "Used" for eBay US, UK, Australia, and India listings; and "Neu" or "Gebraucht" for eBay Germany, Austria, and Switzerland listings.

IncludeSelector: Variations
Item.VhrAvailable boolean Conditionally If true, the eBay Motors item has a Vehicle History Report associated with it.

IncludeSelector: none (not controlled by IncludeSelector)
Item.VhrUrl anyURI Conditionally The URL to the eBay Motors item's full Vehicle History Report. Only returned when the item has a Vehicle History Report.

IncludeSelector: none (not controlled by IncludeSelector)
Item
  .ViewItemURLForNaturalSearch
anyURI Always The URL to view this listing on eBay. 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. For example, this URL specifies the item title, and it is optimized for natural search: "_W0QQ" is like "?" (question mark), "QQ" is like "&" (ampersand), and "Z" is like "=" (equals sign). You shouldn't modify the query syntax in your application. For example, eBay won't recognize the URL if you change QQ to ?.

IncludeSelector: none (not controlled by IncludeSelector)

See (GetSingleItem) Item.Variations.

Standard Output Fields  
Ack AckCodeType Always Indicates whether the call was successfully processed by eBay.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) Request processing failed
Success
(out) Request processing succeeded
Warning
(out) Request processing completed with warning information being included in the response message

(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the particular 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 If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. Only returned if MessageID was used.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors or warnings (if any) that were raised when eBay processed the request.

Application-level errors occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request.

Only returned if there were warnings or errors.
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.

See Errors by Number.

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..*]
Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page.

See Errors by Number.

Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page.
Errors.ErrorParameters.Value string Conditionally The value of the variable.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.

See Errors by Number.

Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error caused the request to fail.

If the request fails and the source of the problem is within the application (such as a missing required element), please 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, you 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.

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.

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

See:
    Errors by Number
    Checklist for Going Live for more information see the eBay Features Guide.

Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.

See Errors by Number.

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 "dateTime" type for information about this time format and converting to and from the GMT time zone.
Version string Always The release version that eBay used to process the request.

Note: This is usually the latest release version, as specified in the release notes. (eBay releases the API to international sites about a week after we release it to the US site.)

If a field in the response returns the token "CustomCode", it usually means that the field is a code type (a token or enumeration), and that in your request URL (or HTTP header) you specified a version that is older than the version in which the token was added to the call.

See Schema Versioning Strategy.



Back to top

GetMultipleItems Detail Controls


IncludeSelector

The IncludeSelector input field gives you control over which call-specific output fields may be returned from your queries. IncludeSelector accepts a set of preset values, each of which permits the return of a different set of fields. (All standard output fields are returned regardless of IncludeSelector.)

The table below details the fields that each IncludeSelector value controls. In addition, the table includes a none column that shows the fields that are not controlled by IncludeSelector settings. Note that some fields are returned only when certain conditions are met; see the associated field documentation for a clarification of these conditions.

YThe field is always returned.
(Y)The field is conditionally returned. See the field documentation for clarification of conditions.

Output Field none Description Details ItemSpecifics ShippingCosts TextDescription Variations
ItemY------
Item.AutoPayY------
Item.BestOfferEnabled--Y----
Item.BidCountY------
Item.BusinessSellerDetails--(Y)----
Item.BusinessSellerDetails.AdditionalContactInformation--(Y)----
Item.BusinessSellerDetails.Address--(Y)----
Item.BusinessSellerDetails.Address.CityName--(Y)----
Item.BusinessSellerDetails.Address.CompanyName--(Y)----
Item.BusinessSellerDetails.Address.FirstName--(Y)----
Item.BusinessSellerDetails.Address.LastName--(Y)----
Item.BusinessSellerDetails.Address.Name--(Y)----
Item.BusinessSellerDetails.Address.Phone--(Y)----
Item.BusinessSellerDetails.Address.PostalCode--(Y)----
Item.BusinessSellerDetails.Address.StateOrProvince--(Y)----
Item.BusinessSellerDetails.Address.Street1--(Y)----
Item.BusinessSellerDetails.Address.Street2--(Y)----
Item.BusinessSellerDetails.Email--(Y)----
Item.BusinessSellerDetails.Fax--(Y)----
Item.BusinessSellerDetails.LegalInvoice--(Y)----
Item.BusinessSellerDetails.TermsAndConditions--(Y)----
Item.BusinessSellerDetails.TradeRegistrationNumber--(Y)----
Item.BusinessSellerDetails.VATDetails--(Y)----
Item.BusinessSellerDetails.VATDetails.VATID--(Y)----
Item.BusinessSellerDetails.VATDetails.VATSite--(Y)----
Item.Charity--(Y)----
Item.Charity.CharityID--(Y)----
Item.Charity.CharityName--(Y)----
Item.Charity.CharityNumber--(Y)----
Item.Charity.DonationPercent--(Y)----
Item.Charity.LogoURL--(Y)----
Item.Charity.Mission--(Y)----
Item.Charity.Status--(Y)----
Item.ConditionDescription(Y)------
Item.ConditionDisplayName(Y)-(Y)----
Item.ConditionID(Y)-(Y)----
Item.ConvertedCurrentPriceY------
Item.CountryY------
Item.CurrentPrice--Y----
Item.Description-Y---Y-
Item.eBayNowEligible--(Y)----
Item.EndTimeY------
Item.GalleryURL(Y)------
Item.GlobalShipping(Y)------
Item.HandlingTime--(Y)----
Item.HighBidder--(Y)----
Item.HighBidder.FeedbackPrivate--(Y)----
Item.HighBidder.FeedbackRatingStar--(Y)----
Item.HighBidder.FeedbackScore--(Y)----
Item.HighBidder.UserAnonymized--(Y)----
Item.HighBidder.UserID--(Y)----
Item.HitCount--(Y)----
Item.IntegratedMerchantCreditCardEnabled--Y----
Item.ItemIDY------
Item.ItemSpecifics---(Y)---
Item.ItemSpecifics.NameValueList---(Y)---
Item.ItemSpecifics.NameValueList.Name---(Y)---
Item.ItemSpecifics.NameValueList.Value---(Y)---
Item.ListingStatusY------
Item.ListingTypeY------
Item.LocationY------
Item.LotSize--(Y)----
Item.MinimumToBid--(Y)----
Item.NewBestOffer--Y----
Item.PaymentAllowedSite--Y----
Item.PaymentMethods--(Y)----
Item.PictureURL(Y)------
Item.PostalCode--Y----
Item.PrimaryCategoryIDY------
Item.PrimaryCategoryIDPath--Y----
Item.PrimaryCategoryNameY------
Item.ProductID--(Y)----
Item.Quantity--Y----
Item.QuantityAvailableHint--(Y)----
Item.QuantityInfo(Y)------
Item.QuantitySold--Y----
Item.QuantitySoldByPickupInStore--Y----
Item.QuantityThreshold--(Y)----
Item.ReserveMet--Y----
Item.ReturnPolicy--(Y)----
Item.ReturnPolicy.Description--(Y)----
Item.ReturnPolicy.EAN--(Y)----
Item.ReturnPolicy.Refund--(Y)----
Item.ReturnPolicy.ReturnsAccepted--(Y)----
Item.ReturnPolicy.ReturnsWithin--(Y)----
Item.ReturnPolicy.ShippingCostPaidBy--(Y)----
Item.ReturnPolicy.WarrantyDuration--(Y)----
Item.ReturnPolicy.WarrantyOffered--(Y)----
Item.ReturnPolicy.WarrantyType--(Y)----
Item.SecondaryCategoryID--(Y)----
Item.SecondaryCategoryIDPath--(Y)----
Item.SecondaryCategoryName--(Y)----
Item.Seller--Y----
Item.Seller.FeedbackRatingStar--Y----
Item.Seller.FeedbackScore--Y----
Item.Seller.PositiveFeedbackPercent--Y----
Item.Seller.TopRatedSeller--(Y)----
Item.Seller.UserID--Y----
Item.ShippingCostSummary----Y--
Item.ShippingCostSummary.InsuranceCost----(Y)--
Item.ShippingCostSummary.ListedShippingServiceCost----(Y)--
Item.ShippingCostSummary.LocalPickup----(Y)--
Item.ShippingCostSummary.ShippingServiceCost----(Y)--
Item.ShippingCostSummary.ShippingType----Y--
Item.ShipToLocations--Y----
Item.Site--Y----
Item.SKU--(Y)----
Item.StartTime--Y----
Item.Storefront--Y----
Item.Storefront.StoreName--Y----
Item.Storefront.StoreURL--Y----
Item.Subtitle--(Y)----
Item.TimeLeftY------
Item.TitleY------
Item.TopRatedListing(Y)------
Item.UnitInfo(Y)------
Item.Variations------(Y)
Item.Variations.Pictures------(Y)
Item.Variations.Pictures.VariationSpecificName------(Y)
Item.Variations.Pictures.VariationSpecificPictureSet------(Y)
Item.Variations.Pictures.VariationSpecificPictureSet.PictureURL------(Y)
Item.Variations.Pictures.VariationSpecificPictureSet
  .VariationSpecificValue
------(Y)
Item.Variations.Variation------(Y)
Item.Variations.Variation.Quantity------(Y)
Item.Variations.Variation.SellingStatus------(Y)
Item.Variations.Variation.SellingStatus.QuantitySold------(Y)
Item.Variations.Variation.SellingStatus
  .QuantitySoldByPickupInStore
------(Y)
Item.Variations.Variation.SKU------(Y)
Item.Variations.Variation.StartPrice------(Y)
Item.Variations.Variation.VariationSpecifics------(Y)
Item.Variations.Variation.VariationSpecifics.NameValueList------(Y)
Item.Variations.Variation.VariationSpecifics.NameValueList.Name------(Y)
Item.Variations.Variation.VariationSpecifics.NameValueList.Value------(Y)
Item.Variations.VariationSpecificsSet------(Y)
Item.Variations.VariationSpecificsSet.NameValueList------(Y)
Item.Variations.VariationSpecificsSet.NameValueList.Name------(Y)
Item.Variations.VariationSpecificsSet.NameValueList.Value------(Y)
Item.VhrAvailable(Y)------
Item.VhrUrl(Y)------
Item.ViewItemURLForNaturalSearchY------


DetailLevel

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



Back to top

GetMultipleItems Samples

New to making API calls? Please see Making an API 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

Retrieves the basic, default set of information pertaining to multiple items (itemIDs).

Input

You wish to see the basic details about several items whose ItemID values were obtained from another call (for example, you might have conducted a search with findItemsAdvanced from the Finding API). To accomplish this, call GetMultipleItems with an itemID value for each item you want to inspect.

URL format (HTTP GET). See also the non-wrapped version of this URL. For results in a format other than XML, 
specify a different value for responseencoding.
http://open.api.ebay.com/shopping?
   callname=GetMultipleItems&
   responseencoding=XML&
   appid=YourAppIDHere&
   siteid=0&
   version=525&
   ItemID=190000456297,280000052600,9600579283

   Here is the same input in XML format (HTTP POST). Note that this does not include standard values.

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

<?xml version="1.0" encoding="utf-8"?>
<GetMultipleItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>190000456297</ItemID>
  <ItemID>280000052600</ItemID>
  <ItemID>9600579283</ItemID>
</GetMultipleItemsRequest>

Output

XML format. Also available is the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="UTF-8"?>
<GetMultipleItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2007-07-06T21:36:26.968Z</Timestamp>
  <Ack>Success</Ack>
  <Build>e527_core_APILW_4863605_R1</Build>
  <Item>
    <ItemID>190000456297</ItemID>
    <BuyItNowAvailable>false</BuyItNowAvailable>
    <EndTime>2009-07-25T09:27:34.000Z</EndTime>
    <ViewItemURLForNaturalSearch>http://cgi.ebay.com/harry-potter-gwq-minimium_W0QQitemZ190000456297QQcategoryZ617QQcmdZViewItem</ViewItemURLForNaturalSearch>
    <Location>qwg</Location>
    <PrimaryCategoryID>617</PrimaryCategoryID>
    <PrimaryCategoryName>DVDs & Movies:DVD, HD DVD & Blu-ray</PrimaryCategoryName>
    <BidCount>0</BidCount>
    <ConvertedCurrentPrice currencyID="USD">1.0</ConvertedCurrentPrice>
    <ListingStatus>Active</ListingStatus>
    <TimeLeft>P729DT11H49M7S</TimeLeft>
    <Title>harry potter gwq minimium</Title>
  </Item>
  <Item>
    <ItemID>280000052600</ItemID>
    <EndTime>2009-07-25T10:01:59.000Z</EndTime>
    <ViewItemURLForNaturalSearch>http://cgi.ebay.com/faridakp-blacck-harry-potter_W0QQitemZ280000052600QQcategoryZ63889QQcmdZViewItem</ViewItemURLForNaturalSearch>
    <Location>San Jose, California</Location>
    <GalleryURL>http://thumbs.ebaystatic.com/pict/280000052600.jpg</GalleryURL>
    <PictureURL>http://i3.ebayimg.com/05/i/07/62/4f/9b_1_b.JPG</PictureURL>
    <PrimaryCategoryID>63889</PrimaryCategoryID>
    <PrimaryCategoryName>Clothing, Shoes & Accessories:Women's Shoes</PrimaryCategoryName>
    <BidCount>0</BidCount>
    <ConvertedCurrentPrice currencyID="USD">15.0</ConvertedCurrentPrice>
    <ListingStatus>Active</ListingStatus>
    <TimeLeft>P729DT12H23M32S</TimeLeft>
    <Title>faridakp blacck harry potter</Title>
  </Item>
  <Item>
    <ItemID>9600579283</ItemID>
    <EndTime>2009-07-25T10:03:56.000Z</EndTime>
    <ViewItemURLForNaturalSearch>http://cgi.ebay.com/Harry-Potter-Literature-Guide-2000_W0QQitemZ9600579283QQcategoryZ279QQcmdZViewItem</ViewItemURLForNaturalSearch>
    <Location>San Jose</Location>
    <PrimaryCategoryID>279</PrimaryCategoryID>
    <PrimaryCategoryName>Books:Children's Books</PrimaryCategoryName>
    <BidCount>0</BidCount>
    <ConvertedCurrentPrice currencyID="USD">21.85</ConvertedCurrentPrice>
    <ListingStatus>Active</ListingStatus>
    <TimeLeft>P729DT12H25M29S</TimeLeft>
    <Title>Harry Potter Literature Guide (2000)</Title>
  </Item>
</GetMultipleItemsResponse>



Back to top

GetMultipleItems Change History

Version Description
893
2014-09-23
  • Item.PictureURL (doc change): Field description was modified to mention that up to 12 externally-hosted pictures may now be added to a listing.
885
2014-07-29
  • Item.IgnoreQuantity (doc change): Although originally added to the Shopping WSDL in Version 871, this field was omitted from the API Call Reference docs until this release. If this boolean flag is returned (and it is only returned if 'True'), it indicates that items in a multi-quantity listing are currently only available through local fulfillment methods such as eBay Now, In-Store Pickup, or Click and Collect, and that the value in the Quantity field under the Item node or under any Variation node should be ignored since this value is only used to indicate how many items are available through the "Ship to home" method.
883
2014-07-15
  • Item.TopRatedListing (doc change): This field's description was updated to include the latest Top-Rated Seller and Top-Rated Listing requirements.
873
2014-05-06
  • Item.ShippingCostSummary (doc change): This container and its children do not provide reliable shipping cost information when returned by the GetMultipleItems call. If a listing has shipping costs, use the GetShippingCosts call to get more details about the services and costs that the seller is offering.
871
2014-04-22
  • Item.AvailableForPickupDropOff (added): This boolean field will be returned as 'true' if the item is available for the "Pick Up, Drop Off" feature, a feature that will only be supported in the UK, initially.
  • Item.EligibleForPickupDropOff (added): This boolean field will be returned as 'true' if the item is eligible for the "Pick Up, Drop Off" feature, a feature that will only be supported in the UK, initially.
869
2014-04-08
  • Item.HandlingTime (doc change): The description clarifies that HandlingTime can return a value of 0, which indicates that the seller commits to same day handling. 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).
867
2014-03-25
  • Item.eBayNowAvailable (added): This boolean field will be returned as 'true' if the item is available for eBay Now delivery.
857
2014-01-14
  • SimpleItemType.eBayNowEligible (added): This flag is returned if the eBay Item is available for eBay Now delivery.
849
2013-11-05
  • Item.PaymentMethods (modified): 'CreditCard' and 'DirectDebit' added as acceptable buyer payment methods. These two values will only be returned for eBay Now-enabled listings.
837
2013-08-29
  • Item.QuantitySoldByPickupInStore (added): This field indicates the total quantity of items sold and picked up by buyers using the In-Store Pickup option. The QuantitySoldByPickupInStore field is returned at the item level and at the variation level (for multi-variation listings). At the item level, this value is the total quantity of items (for single and multi-variation listings) sold and picked up by buyers using the In-Store Pickup option. At the variation level, this value is the total quantity of item variations sold and picked up by buyers using the In-Store Pickup option.
  • SellingStatus.QuantitySoldByPickupInStore (added): This field indicates the total quantity of item variations sold and picked up by buyers using the In-Store Pickup option. The QuantitySoldByPickupInStore field is returned at the item level and at the variation level (for multi-variation listings). At the item level, this value is the total quantity of items (for single and multi-variation listings) sold and picked up by buyers using the In-Store Pickup option. At the variation level, this value is the total quantity of item variations sold and picked up by buyers using the In-Store Pickup option.
  • SKU (added): The seller-defined SKU (stock keeping unit) for an item is now returned in GetMultipleItems if it is set for the listing.
  • NewBestOffer (added): This boolean field will be returned as 'true' if a fixed-price listing is requiring immediate payment, and the item's category supports Immediate Payment for Best Offers.
801
2012-11-28
  • Item.PictureURL (modified): The maximum length of picture URLs has increased from 150 to 500 characters.
799
2012-11-07
  • Item.ReturnPolicy.RestockingFeeValue, Item.ReturnPolicy.RestockingFeeValueOption (added): This string field is used by the seller to indicate the restocking fee that will be charged by the seller for returned items.
789
2012-08-29
  • Item.ConditionDescription (added): This string field is used by the seller to more clearly describe the condition of items that are not brand new. It is only returned if set for the listing.
785
2012-08-01
  • Item.GlobalShipping (added): Indicates whether eBay's Global Shipping Program is offered for a listing. If the value of GlobalShipping is True, the Global Shipping Program is the default international shipping option for the listing. If the value of GlobalShipping is False, the seller might have specified an alternative international shipping service for the listing, or no international shipping option at all.
  • Item.UnitInfo (added): This container includes the UnitType and UnitQuantity fields to provide information about the weight, volume or other quantity measurement of a listed item so buyers can compare per-unit prices. The European Union requires listings for certain types of products to include the price per unit.
779
2012-06-20
  • VhrAvailable, VhrUrl (added): Returned for eBay Motors listings with Vehicle History Reports.
775
2012-05-23
  • QuantityInfo.MinimumRemnantSet (added): This field is returned for US and CA event ticket listings (if set by the seller). This field enables the seller to avoid being left with 1 item in a multi- quanity, fixed-priced event ticket listing, by setting the minimum number of items that should remain if a buyer doesn't purchase all tickets in the listing.
  • TopRatedListing (added): This field is returned if the listing meets the requirements for qualifying as a Top-Rated 2.0 listing.
723
2011-05-25
  • DiscountPriceInfo (added): Added the ability to retrieve discount pricing values (DiscountPricingInfo) for an item, which gives the item either a Strike-Through Pricing (STP) or Minimum Advertised Price (MAP) display treatment. This feature is available to qualified sellers (and their associated developers) who participate in the Discount Pricing program. Once qualified, sellers can apply Discount Pricing to both MSKU and Non-MSKU items. STP is available on the US, UK, and DE sites while MAP is available only on the US site.
    This feature will be available mid-Summer, 2011. Sellers should contact their account manager or Customer Service to see if they qualify for the Strike-Through Pricing program. For more information, see Displaying Discount Pricing Information to Buyers.
689
2010-09-20
  • ShippingCostSummary.LocalPickup (added): If IncludeSelector is set to ShippingCost, and if the seller has specified local pickup as the shipping option for the item, the LocalPickup boolean is returned as true. If local pickup was not specified for the item, the LocalPickup boolean is not returned at all.
679
2010-07-21
  • SimpleItemType.QuantityThreshold, SimpleItemtype.QuantityAvailableHint (added): Set a quantity threshold for the number of items available. As long as the number of items remains above the threshold, GetMultipleItems will return a quantity in the form, "More than n available," where n is the quantity threshold.
661
2010-03-17
  • ConditionID, ConditionDisplayName (added): ConditionID and ConditionDisplayName are supported in the Sandbox for a few categories. Starting in May 2010, they will be supported in production for most categories. These fields are used instead of ItemSpecifics to specify the item's condition in some categories.
637
2009-09-30
  • Item.LotSize (added): A lot is a set of two or more similar items that must be purchased together in a single transaction. When an item's LotSize is specified, the listing price reflects the price of each lot (not each item within the lot).
603
2009-02-04
  • Item.IntegratedMerchantCreditCardEnabled (added): Integrated merchant credit card status of an item.
589
2008-10-29
  • Item.PaymentAllowedSite (added): Enables you to view the sites on which an item can be purchased.
565
2008-05-14
  • IncludeSelector (added): Allows you to select specific fields for response. Used with new type fields: SimpleItemType.AutoPay and SearchFlagCodeType.AutoPay.
527
2007-08-22
  • ListingType (added): The ListingType field now is returned, by default.
525
2007-08-08
  • (added) New call.

Back to top

User-Contributed Notes