GetSingleItem

GetSingleItem gets publicly visible details about one listing on eBay. This gives you most of the data that eBay shows to the general public on the View Item page (title, description, basic price information, and other details).

See the Input and Output sections below for a complete list of fields in this call.

You just need to know the eBay item ID (a value like 123456789012) in order to retrieve the listing. Typically, you use FindItems to find listings by keyword or by seller, then use the ItemID value from one of those items as input to GetSingleItem. If a listing ended more than 90 days ago, its title, price, and other item information are not returned.

Note: What if you need to see item data that is normally only visible to the seller (where eBay would require them to login)? For this, you would need to use the authenticated version of this call (GetItem) in eBay Trading Web Services instead.

Best Practices

GetSingleItem has been optimized for response size, speed and usability. So, it returns the most commonly used fields by default. Use the IncludeSelector field to get more data—but please note that getting more data can result in longer response times.

See Sample: Basic Call for a sample that returns the default fields. See Sample: Getting the Full Description and Item Specifics for a sample that returns more data.

Refreshing Item Data

If you're monitoring the same item over time, most of the data (such as the seller and the full text of the description) doesn't change at all, or changes rarely. A few pieces of information (like the bid count) change more often.

So, after you initially retrieve an item's details, cache the item data locally, and then use GetItemStatus from then on to more quickly update the details that tend to change. Depending on your use case, you can call GetSingleItem again occasionally to see if the seller has revised any other data in the listing.

Getting Shipping Details

If you want to see an item's shipping cost summary, specify ShippingCosts in IncludeSelector.

See Sample: Including a Shipping Cost Summary for a sample that shows how to add a listing's shipping cost summary to the default results.

Once you know the item has shipping costs, you can call GetShippingCosts with the same item ID if you need more shipping details.

If you're showing an item to a potential buyer and you know where that buyer is located, it may be helpful to check where the seller is willing to ship the item (ShipToLocations). Some sellers will ship worldwide, and others prefer to ship to certain countries or regions only.

Getting an Item from a Different eBay Site

Item IDs are unique across all eBay sites, so you normally don't need to specify a different site ID with your GetSingleItem request to get an item that was listed on another eBay site. (This is a little different from the way FindItems works.)

In fact, if you send your request to the US site and the item was listed on the eBay UK site, we'll give you the original price in Pounds (GBP), and we'll calculate the converted price in US dollars (USD) for you (based on the current exchange rate).

See Sample: Getting a Foreign Listing with Converted Prices for a sample that shows how this works.

By the way, we always return converted prices, even when no conversion takes place. So, if you're comparing the current price of different items and you don't care which site they're listed on, it is simplest to compare the ConvertedCurrentPrice values of each item.

More Tips

If you discover other useful practices, feel free to add them in the User-Contributed Notes at the bottom of this page.

If you're looking for more tips, try searching the Knowledge Base and Developer Forums.

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

Related Information

See also the reference documentation for these calls:



Back to top

GetSingleItem Input

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

See also Samples.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSingleItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <MessageID> string </MessageID>
  <!-- Call-specific Input Fields -->
  <IncludeSelector> string </IncludeSelector>
  <ItemID> string </ItemID>
  <VariationSKU> string </VariationSKU>
  <VariationSpecifics> NameValueListArrayType 
    <NameValueList> NameValueListType 
      <Name> string </Name>
      <Value> string </Value>
      <!-- ... more Value nodes here ... -->
    </NameValueList>
    <!-- ... more NameValueList nodes here ... -->
  </VariationSpecifics>
</GetSingleItemRequest>
Argument Type Occurrence Meaning
Standard Input Fields   [Jump to call-specific 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.
Call-specific Input 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.)

•   ShippingCosts

Include basic shipping costs in the response. (Use GetShippingCosts to retrieve more details.)

•   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
    GetSingleItem Samples

ItemID string Required The item ID that uniquely identifies the item listing for which to retrieve the data.

You can determine an item's ID by calling FindItems or from the eBay Web site.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

See (FindItems) Item.ItemID.

VariationSKU string Optional Variation-level SKU that uniquely identifes a variation within the listing identified by ItemID. Only applicable when the seller included variation-level SKU (Variation.SKU) values. Retrieves all the usual Item fields, but limits the Variations content to the specified variation. If not specified, the response includes all variations.
VariationSpecifics NameValueListArrayType Optional Name-value pairs that identify one or more variations within the listing identified by ItemID. Only applicable when the seller listed the item with variations. Retrieves all the usual Item fields, but limits the Variations content to the specified variation(s). If the specified pairs do not match any variation, eBay returns all variations.

To retrieve only one variation, specify the full set of name/value pairs that match all the name-value pairs of one variation.

To retrieve multiple variations (using a wildcard), specify one or more name/value pairs that partially match the desired variations. For example, if the listing contains variations for shirts in different colors and sizes, specify Color as Red (and no other name/value pairs) to retrieve all the red shirts in all sizes (but no other colors).
VariationSpecifics
  .NameValueList
NameValueListType Optional,
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.
VariationSpecifics
  .NameValueList.Name
string Optional 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.
VariationSpecifics
  .NameValueList.Value
string Optional,
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.



Back to top

GetSingleItem Output

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

See also Samples.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSingleItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <Item> SimpleItemType 
    <AutoPay> boolean </AutoPay>
    <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>
        <VATSite> string </VATSite>
      </VATDetails>
    </BusinessSellerDetails>
    <BuyItNowAvailable> boolean </BuyItNowAvailable>
    <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
    <Charity> CharityType 
      <CharityID> string </CharityID>
      <CharityName> string </CharityName>
      <CharityNumber> int </CharityNumber>
      <DonationPercent> float </DonationPercent>
      <LogoURL> string </LogoURL>
      <Mission> string </Mission>
      <Status> CharityStatusCodeType </Status>
    </Charity>
    <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
    <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
    <Country> CountryCodeType </Country>
    <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
    <Description> string </Description>
    <EndTime> dateTime </EndTime>
    <GalleryURL> anyURI </GalleryURL>
    <HandlingTime> int </HandlingTime>
    <HighBidder> SimpleUserType 
      <FeedbackPrivate> boolean </FeedbackPrivate>
      <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
      <FeedbackScore> int </FeedbackScore>
      <UserAnonymized> boolean </UserAnonymized>
      <UserID> string </UserID>
    </HighBidder>
    <HitCount> long </HitCount>
    <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
    <ItemID> string </ItemID>
    <ItemSpecifics> NameValueListArrayType 
      <NameValueList> NameValueListType 
        <Name> string </Name>
        <Value> string </Value>
        <!-- ... more Value nodes here ... -->
      </NameValueList>
      <!-- ... more NameValueList nodes here ... -->
    </ItemSpecifics>
    <ListingStatus> ListingStatusCodeType </ListingStatus>
    <ListingType> ListingTypeCodeType </ListingType>
    <Location> string </Location>
    <LotSize> int </LotSize>
    <MinimumToBid currencyID="CurrencyCodeType"> AmountType (double) </MinimumToBid>
    <PaymentAllowedSite> SiteCodeType </PaymentAllowedSite>
    <!-- ... more PaymentAllowedSite nodes here ... -->
    <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
    <!-- ... more PaymentMethods nodes here ... -->
    <PictureURL> anyURI </PictureURL>
    <!-- ... more PictureURL nodes here ... -->
    <PostalCode> string </PostalCode>
    <PrimaryCategoryID> string </PrimaryCategoryID>
    <PrimaryCategoryIDPath> string </PrimaryCategoryIDPath>
    <PrimaryCategoryName> string </PrimaryCategoryName>
    <ProductID> ProductIDType (string) </ProductID>
    <Quantity> int </Quantity>
    <QuantitySold> int </QuantitySold>
    <ReserveMet> boolean </ReserveMet>
    <ReturnPolicy> ReturnPolicyType 
      <Description> string </Description>
      <EAN> string </EAN>
      <Refund> string </Refund>
      <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>
      <UserID> string </UserID>
    </Seller>
    <ShippingCostSummary> ShippingCostSummaryType 
      <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
      <ListedShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ListedShippingServiceCost>
      <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      <ShippingType> ShippingTypeCodeType </ShippingType>
    </ShippingCostSummary>
    <ShipToLocations> string </ShipToLocations>
    <!-- ... more ShipToLocations nodes here ... -->
    <Site> SiteCodeType </Site>
    <StartTime> dateTime </StartTime>
    <Storefront> StorefrontType 
      <StoreName> string </StoreName>
      <StoreURL> anyURI </StoreURL>
    </Storefront>
    <Subtitle> string </Subtitle>
    <TimeLeft> duration </TimeLeft>
    <Title> string </Title>
    <Variations> VariationsType 
      <Pictures> PicturesType 
        <VariationSpecificName> string </VariationSpecificName>
        <VariationSpecificPictureSet> VariationSpecificPictureSetType 
          <PictureURL> anyURI </PictureURL>
          <!-- ... more PictureURL nodes here ... -->
          <VariationSpecificValue> string </VariationSpecificValue>
        </VariationSpecificPictureSet>
        <!-- ... more VariationSpecificPictureSet nodes here ... -->
      </Pictures>
      <!-- ... more Pictures nodes here ... -->
      <Variation> VariationType 
        <Quantity> int </Quantity>
        <SellingStatus> SellingStatusType 
          <QuantitySold> int </QuantitySold>
        </SellingStatus>
        <SKU> string </SKU>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <VariationSpecifics> NameValueListArrayType 
          <NameValueList> NameValueListType 
            <Name> string </Name>
            <Value> string </Value>
            <!-- ... more Value nodes here ... -->
          </NameValueList>
          <!-- ... more NameValueList nodes here ... -->
        </VariationSpecifics>
      </Variation>
      <!-- ... more Variation nodes here ... -->
      <VariationSpecificsSet> NameValueListArrayType 
        <NameValueList> NameValueListType 
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value nodes here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes here ... -->
      </VariationSpecificsSet>
    </Variations>
    <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
  </Item>
</GetSingleItemResponse>
Return Value Type Occurrence Meaning
Standard Output Fields   [Jump to call-specific 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 The index of the parameter in the error.
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
    Requirements for Error Handling for more information (in the eBay Trading Web Services 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.

Call-specific Output Fields
Item SimpleItemType Always Contains details about the listing whose ID was 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, including eBay Stores Inventory 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.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.

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.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.BuyItNowAvailable boolean Conditionally Indicates whether the item has an active Buy It Now option. On most sites, the Buy It Now option is disabled once a valid bid for the item has been accepted. To see if the item was listed with a Buy It Now option, see if the response includes Item.BuyItNowPrice.

This field is returned only if the value is true.

IncludeSelector: none (not controlled by IncludeSelector)
Item.BuyItNowPrice AmountType (double) Conditionally The Buy It Now price of the item, returned in the currency of the site on which the item was listed.

For Chinese auctions (competitive bidding online auctions), Buy It Now lets a user purchase the item at a fixed price and end the auction immediately. On most sites, after a Chinese auction has bids, the listing is no longer eligible for Buy It Now. However, calls like FindItems will return BuyItNowPrice if the seller originally listed the item with a Buy It Now option. Use the Item.BidCount field to determine whether an auction with Buy It Now has bids or not, and use Item.BuyItNowAvailable to see if the Buy It Now option is still available.

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 items, where you can buy multiple items from the same listing at a fixed price (instead of bidding).

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.
For fixed-price (FixedPriceItem) and Store Inventory listings (StoresFixedPrice), see CurrentPrice or ConvertedCurrentPrice instead.

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

IncludeSelector: Details

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

Item.BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
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.ConvertedBuyItNowPrice AmountType (double) Conditionally 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) and Store Inventory listings (StoresFixedPrice), 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.ConvertedBuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
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) and Store Inventory listings (StoresFixedPrice), 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.ConvertedCurrentPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
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 currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency.

For competitive-bidding auction listings, this is the current minimum bid price (if the listing has no bids) or the current high bid (if the listing has bids). This does not reflect the BuyItNow price.

For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), and Ad format (AdType) listings, this is the current fixed price.

IncludeSelector: Details
Item.CurrentPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
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.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). In FindItemsAdvanced and FindItems, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times.

In search results (like the FindItemsAdvanced response), the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing.

IncludeSelector: none (not controlled by IncludeSelector)

See (GetSingleItem) Item.Variations.

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.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. The seller sets this to a positive integer value (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 DispatchTimeMax only when shipping service options are specified for the item and the seller specified a dispatch time.

Valid for flat and calculated shipping. Does not apply when there is no shipping, when it is local pickup only or it is freight shipping.
the listing ends, you can add or change the dispatch (handling) time.

IncludeSelector: Details
Item.HighBidder SimpleUserType Conditionally The high bidder for comptetitive-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 and Store Inventory 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
  .IntegratedMerchantCreditCardEnabled
boolean Conditionally 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.

In search results (like the FindItemsAdvanced response), the same ItemID may be returned for multiple results if the results are variations from the same multi-variation listing.
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 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.

•   Dutch

Deprecated as of version 611.
(out) Multiple-quantity online auction format. A Dutch auction has a Quantity greater than one (1). Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com. They are also listed in a seller's eBay Store if the seller is a Store owner.

Note: Dutch-style (multi-item) auctions are being deprecated and will soon be unsupported. Although you can retrieve information relating to a Dutch-style listing, starting with version 615, you cannot submit a Dutch item listing with AddItem or VerifyAddItem on the following sites: US, CA, CAFR, DE, or UK. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the quantity to 1. To ensure forward compliance, please avoid listing multi-item auctions.

Deprecation version: 611. See also Deprecated Objects.

•   Express

Deprecated as of version 561.
(out) For Germany only: eBay Express-only format (item is listed only on eBay Express Germany, not on eBay).
Deprecation version: 561. See also Deprecated Objects.

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

Note: Dutch-style (multi-item) auctions are being deprecated and will soon be unsupported. Although you can retrieve information relating to a Dutch-style listing, starting with version 615, you cannot submit a Dutch item listing with AddItem or VerifyAddItem on the following sites: US, CA, CAFR, DE, or UK. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the quantity to 1. To ensure forward compliance, please avoid listing multi-item auctions.

•   LeadGeneration

(out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).

•   Live

(out) Live auction, on-site auction that can include non-eBay bidders. Live auctions are listed on the eBay Live Auctions site, in live auction categories. They can also appear on eBay if the seller lists the lot in a secondary, eBay category.

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

•   StoresFixedPrice

(out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. This item type can only be specified by sellers who have an eBay Store. Store Inventory listings are listed on eBay.com as well as in the seller's eBay Store.

•   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),Store Inventory (StoresFixedPrice), and Ad type listings.

IncludeSelector: Details
Item.MinimumToBid
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
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 6 picture URLs hosted by a third party (such as the a photo site). 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 online, comptetitive-bidding auction with a Quantity of 1 is referred to as a < i>Chinese auction. Basic fixed-price and Store Inventory 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 lightbulbs for US 2.00 each, they might list 10 lightbulbs 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 lightbulbs each, Quantity would be 5.



IncludeSelector: Details

See Item.ListingType.

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.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
  .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.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 Contains basic shipping-related costs for the item. If Item.Quantity is greater than 1, this is the shipping cost for one item. If the seller offers a choice of more than one shipping service (such as UPS Ground and USPS Media mail), this is the cost of the "first" shipping option (usually the lowest cost option).

If a listing has shipping costs, use GetShippingCosts if you want 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.

IncludeSelector: ShippingCosts
Item.ShippingCostSummary
  .InsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingCostSummary
  .ListedShippingServiceCost
AmountType (double) Conditionally The listed shipping cost of the item. If multiple items were purchased, this includes the listed ShippingServiceAdditionalCost.

In GetSingleItem, this is always returned when ShippingCostSummary is returned, except when the ShippingType is Freight.

IncludeSelector: ShippingCosts
Item.ShippingCostSummary
  .ListedShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingCostSummary
  .ShippingServiceCost
AmountType (double) Conditionally The basic shipping cost of the item. If multiple items were purchased, this includes the ShippingServiceAdditionalCost.

In GetSingleItem, this is always returned when ShippingCostSummary is returned, except for when the ShippingType is Freight.

IncludeSelector: ShippingCosts
Item.ShippingCostSummary
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingCostSummary
  .ShippingType
ShippingTypeCodeType Always How the seller stated that cost of shipping is to be determined, such as flat rate or calculated.

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

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

In search results (like the FindItemsAdvanced response), the same TimeLeft may be returned for multiple results if the results are variations from the same multi-variation listing.

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

In finding calls (like FindItemsAdvanced), this value concatenates several Item Specifics: The Make (e.g., "Buick"), Model (e.g., Skylark), Submodel (e.g., Limited), and the seller's customized subtitle (e.g., "Great deal!"). Call GetSingleItem with IncludeSelector=ItemSpecifics to see the individual Item Specifics (in Item.ItemSpecifics).

Note: GetSingleItem and FindItemsAdvanced do 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.

In general, FindItemsAdvanced maps to eBay's advanced search functionality. The Item.Title value described above for FindItemsAdvanced maps to the item's search result title in the eBay Motors search results page.



IncludeSelector: none (not controlled by IncludeSelector)
Item.Variations VariationsType Conditionally Variations are multiple similar (but not identical) items in a single fixed-price (or Store Inventory Format) 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,
repeatable: [0..1]
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
  .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.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
  .StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

For a list of possible enumeration values, see CurrencyCodeType.
Item.Variations.Variation
  .VariationSpecifics
NameValueListArrayType Conditionally 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
  .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 ?. In the Sandbox environment and on the Hong Kong site (site ID 201), the data returned in this field by FindItemsAdvanced is a standard ViewItem URL, rather than the ViewItem URL for natural search that generally is returned in the Production environment.

In search results (like the FindItemsAdvanced response),if the result is a variation from a multi-variation listing, this link to the View Item page is configured to select the applicable variation.

IncludeSelector: none (not controlled by IncludeSelector)

See (GetSingleItem) Item.Variations.



Back to top

GetSingleItem Detail Controls


Detail Control: 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 description for a clarification of these conditions.

YThe field is always returned.
(Y)The field is conditionally returned. See the field description 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.BuyItNowAvailable(Y)------
Item.BuyItNowPrice--(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.ConvertedBuyItNowPrice(Y)------
Item.ConvertedCurrentPriceY------
Item.CountryY------
Item.CurrentPrice--Y----
Item.Description-Y---Y-
Item.EndTimeY------
Item.GalleryURL(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.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.QuantitySold--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.UserID--Y----
Item.ShippingCostSummary----Y--
Item.ShippingCostSummary.InsuranceCost----(Y)--
Item.ShippingCostSummary.ListedShippingServiceCost----(Y)--
Item.ShippingCostSummary.ShippingServiceCost----(Y)--
Item.ShippingCostSummary.ShippingType----Y--
Item.ShipToLocations--Y----
Item.Site--Y----
Item.StartTime--Y----
Item.Storefront--Y----
Item.Storefront.StoreName--Y----
Item.Storefront.StoreURL--Y----
Item.Subtitle--(Y)----
Item.TimeLeftY------
Item.TitleY------
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.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.ViewItemURLForNaturalSearchY------



Back to top

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

Available samples:

Sample: Basic Call

Retrieves the default, most commonly used, set of item fields.

Input

If you want to show potential buyers basic information pertaining to a listing (such as the title, a picture, current and Buy It Now prices, and the listing ending time), pass an itemID as input to GetSingleItem.

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=GetSingleItem
   &responseencoding=XML
   &appid=YourAppIDHere
   &siteid=0
   &version=515
   &ItemID=180126682091

   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"?>
<GetSingleItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>180126682091</ItemID>
</GetSingleItemRequest>

Output

When you pass just an itemID to GetSingleItem, eBay returns the default set of item fields: the listing's title, prices (in the currency of the site to which you sent the request), category, end time, and a few other fields (depending on what the seller specifeid in the listing). See Detail Control: IncludeSelector for a list of the default set of fields that eBay returns for an item listing. Retrieving only these basic fields gives you the fastest response time.

Notice that the value of BidCount is 1 in this example. If this is a Chinese auction (single-quantity, competitive-bidding listing), this would indicate that the Buy It Now option is no longer available (even though the response shows ConvertedBuyItNowPrice). If knowing the availability of Buy It Now is important to your use case, you would need to get additional details about the item to determine the listing type. See Sample: Converting Prices from a Non-Local Listing for a sample that shows ListingType.

If you think the user might want to see the item again, you should cache the results instead of making the call again later. This will help reduce the number of calls you make per day. Also, if you expect to monitor the item (for example, to get the latest bid count and price) don't call GetSingleItem again to get the updates. Use instead GetItemStatus, it's a more efficient call.

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

<?xml version="1.0" encoding="UTF-8"?>
  <GetSingleItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2007-06-07T15:55:58.261Z</Timestamp>
   <Ack>Success</Ack>
   <Build>e515_core_APILW_4756831_R1</Build>
   <Version>515</Version>
   <Item>
    <ItemID>180126682091</ItemID>
    <ConvertedBuyItNowPrice currencyID="USD">12.88</ConvertedBuyItNowPrice>
    <EndTime>2007-06-12T18:51:06.000Z</EndTime>
    <ViewItemURLForNaturalSearch>http://cgi.ebay.com/EMMA-WATSON-entertainment-weekly-HARRY-POTTER-phoenix_W0QQitemZ180126682091QQcategoryZ29798QQcmdZViewItem</ViewItemURLForNaturalSearch>
    <Location>NEW JERSEY</Location>
    <GalleryURL>http://thumbs.ebaystatic.com/pict/180126682091.jpg</GalleryURL>
    <PictureURL>http://imagehost.vendio.com/bin/imageserver.x/00000000/jackensack/.mids/EWEMMAMARCH2007A.jpg</PictureURL>
    <PrimaryCategoryID>29798</PrimaryCategoryID>
    <PrimaryCategoryName>Collectibles:Fantasy, Mythical & Magic:Harry Potter:Other Items</PrimaryCategoryName>
    <BidCount>1</BidCount>
    <ConvertedCurrentPrice currencyID="USD">0.88</ConvertedCurrentPrice>
    <ListingStatus>Active</ListingStatus>
    <TimeLeft>P5DT2H55M8S</TimeLeft>
    <Title>EMMA WATSON entertainment weekly HARRY POTTER phoenix</Title>
   </Item>
  </GetSingleItemResponse>

Back to list of samples

Sample: Including a Shipping Cost Summary

Retrieves a listing's basic shipping costs in addition to the default set of item fields.

Input

A seller can offer one or more shipping options to potential buyers. Some sellers will offer flat shipping while others will give users a range of options at different prices. The seller will usually show the lowest-cost shipping option first.

GetSingleItem can return the shipping and, if it exists, the insurance cost of the seller's first shipping option. To retrieve this information, pass the itemID and specify an IncludeSelector of ShippingCosts to the call.

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=GetSingleItem
   &responseencoding=XML
   &appid=YourAppIDHere
   &siteid=0
   &version=515
   &ItemID=180126682091
   &IncludeSelector=ShippingCosts

   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"?>
<GetSingleItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>180126682091</ItemID>
  <IncludeSelector>ShippingCosts</IncludeSelector>
</GetSingleItemRequest>

Output

The response from this sample gets the listing's defuault set of fields as well as the shipping cost information. Note that retrieving shipping costs can increase the call's response time.

If you determine that the item has shipping costs, you can call GetShippingCosts with the same itemID if you need more shipping details. (It's best to call GetShippingCosts only when you know there are shipping details to return.)

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

<?xml version="1.0" encoding="UTF-8"?>
  <GetSingleItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2007-06-07T16:49:04.164Z</Timestamp>
   <Ack>Success</Ack>
   <Build>e515_core_APILW_4756831_R1</Build>
   <Version>515</Version>
   <Item>
    <ItemID>180126682091</ItemID>
    <ConvertedBuyItNowPrice currencyID="USD">12.88</ConvertedBuyItNowPrice>
    <EndTime>2007-06-12T18:51:06.000Z</EndTime>
    <ViewItemURLForNaturalSearch>http://cgi.ebay.com/EMMA-WATSON-entertainment-weekly-HARRY-POTTER-phoenix_W0QQitemZ180126682091QQcategoryZ29798QQcmdZViewItem</ViewItemURLForNaturalSearch>
    <Location>NEW JERSEY</Location>
    <GalleryURL>http://thumbs.ebaystatic.com/pict/180126682091.jpg</GalleryURL>
    <PictureURL>http://imagehost.vendio.com/bin/imageserver.x/00000000/jackensack/.mids/EWEMMAMARCH2007A.jpg</PictureURL>
    <PrimaryCategoryID>29798</PrimaryCategoryID>
    <PrimaryCategoryName>Collectibles:Fantasy, Mythical & Magic:Harry Potter:Other Items</PrimaryCategoryName>
    <BidCount>1</BidCount>
    <ConvertedCurrentPrice currencyID="USD">0.88</ConvertedCurrentPrice>
    <ListingStatus>Active</ListingStatus>
    <TimeLeft>P5DT2H2M2S</TimeLeft>
    <Title>EMMA WATSON entertainment weekly HARRY POTTER phoenix</Title>
    <ShippingCostSummary>
     <ShippingServiceCost currencyID="USD">4.75</ShippingServiceCost>
     <InsuranceCost currencyID="USD">0.0</InsuranceCost>
     <ShippingType>Flat</ShippingType>
    </ShippingCostSummary>
   </Item>
  </GetSingleItemResponse>

Back to list of samples

Sample: Getting Item Descriptions and Item Specifics

Retrieves the full item description and Item Specifics in addition to the default set of item fields.

Input

A seller usually writes a detailed description of the item they're selling. In addition to the description, the seller might also specify various Item Specifics (or they might be pre-filled from a catalog offered by eBay). On the US site, cars & trucks, tickets, and real estate listings always have Item Specifics. Many other listings have them as well. Sellers most often use Item Specifics to specify the condition of an item.

This example shows how to retrieve the listing description and Item Specifics. Pass in the itemID as usual, and specify Description,ItemSpecifics (separated by a comma) in the IncludeSelector field.

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=GetSingleItem
   &responseencoding=XML
   &appid=YourAppIDHere
   &siteid=0
   &version=515
   &ItemID=180126682091
   &IncludeSelector=Description,ItemSpecifics

   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"?>
<GetSingleItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>180126682091</ItemID>
  <IncludeSelector>Description,ItemSpecifics</IncludeSelector>
</GetSingleItemRequest>

Output

As shown in this example, descriptions often include HTML markup (and sometimes they also include JavaScript). Some sellers can also put additional pictures in their description instead of using eBay's picture options. Pictures included within the seller's description are not returned in the PictureURL field.

This response also shows the item condition (New) in the ItemSpecifics node. Some listings have other specifics as well. Because descriptions and some lists of Item Specifics can be very long, getting this data can increase the call's response time.

Note: This example shows a SIFFTAS item specific with no value. In general, you should ignore SIFFTAS item specifics, as they are not useful to users. They're for internal use at eBay.

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

<?xml version="1.0" encoding="UTF-8"?>
<GetSingleItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2007-06-08T13:33:32.871Z</Timestamp>
  <Ack>Success</Ack>
  <Build>e515_core_APILW_4756831_R1</Build>
  <Version>515</Version>
  <Item>
    <Description>

<!-- Partial sample of the Description field.
See the .txt version of this response for the full description. -->

&lt;table width=100% border=0 cellspacing=0 cellpadding=0&gt;
&lt;tr&gt;&lt;td width=21&gt;&lt;img src=&quot;http://imagehost.vendio.com/my/templates/Themes/Standard/Standard%2001/corner_tl.gif&quot; width=21 height=25&gt;&lt;/td&gt;
&lt;td width=100% background=&quot;http://imagehost.vendio.com/my/templates/Themes/Standard/Standard%2001/expander.gif&quot;&gt;&amp;nbsp;&lt;/td&gt;
&lt;td background=&quot;http://imagehost.vendio.com/my/templates/Themes/Standard/Standard%2001/expander.gif&quot; width=24&gt;&lt;img src=&quot;http://imagehost.vendio.com/my/templates/Themes/Standard/Standard%2001/corner_tr.gif&quot; width=24 height=25&gt;&lt;/td&gt;
&lt;/tr&gt;&lt;tr&gt;&lt;td width=21 background=&quot;http://imagehost.vendio.com/my/templates/Themes/Standard/Standard%2001/st_top_menu_l.gif&quot; valign=top&gt;&lt;img src=&quot;http://imagehost.vendio.com/my/templates/Themes/Standard/Standard%2001/space_tl.gif&quot; width=21 height=13&gt;&lt;/td&gt;
&lt;td bgcolor=#687498 width=100%&gt;

<!-- More HTML and JavaScript here.
See the .txt version of this response for the full description. -->

    </Description>
    <ItemID>180126682091</ItemID>
    <ConvertedBuyItNowPrice currencyID="USD">12.88</ConvertedBuyItNowPrice>
    <EndTime>2007-06-12T18:51:06.000Z</EndTime>
    <ViewItemURLForNaturalSearch>http://cgi.ebay.com/EMMA-WATSON-entertainment-weekly-HARRY-POTTER-phoenix_W0QQitemZ180126682091QQcategoryZ29798QQcmdZViewItem</ViewItemURLForNaturalSearch>
    <Location>NEW JERSEY</Location>
    <GalleryURL>http://thumbs.ebaystatic.com/pict/180126682091.jpg</GalleryURL>
    <PictureURL>http://imagehost.vendio.com/bin/imageserver.x/00000000/jackensack/.mids/EWEMMAMARCH2007A.jpg</PictureURL>
    <PrimaryCategoryID>29798</PrimaryCategoryID>
    <PrimaryCategoryName>Collectibles:Fantasy, Mythical &amp; Magic:Harry Potter:Other Items</PrimaryCategoryName>
    <BidCount>1</BidCount>
    <ConvertedCurrentPrice currencyID="USD">0.88</ConvertedCurrentPrice>
    <ListingStatus>Active</ListingStatus>
    <TimeLeft>P4DT5H17M34S</TimeLeft>
    <Title>EMMA WATSON entertainment weekly HARRY POTTER phoenix</Title>
    <ItemSpecifics>
      <NameValueList>
        <Name>SIFFTAS Group Pseudo Attribute</Name>
        <Value></Value>
      </NameValueList>
      <NameValueList>
        <Name>Condition</Name>
        <Value>New</Value>
      </NameValueList>
    </ItemSpecifics>
  </Item>
</GetSingleItemResponse>

Back to list of samples

Sample: Converting Prices from a Non-Local Listing

Retrieves a listing from a non-local site and converts the prices to the local currency.

Input

When searching for items on eBay, you sometimes find items that are listed on an international eBay site, but the seller is willing to ship to different countries. To support this, eBay can return the listing's price data converted into the currency of the site you're using, as well as showing the price in the listing's original currency.

This example retrieves an item listed on the US site from the eBay Germany site. By specifying siteid=77 in the URL, the German site becomes the "local" site, and the US site (where the item is listed) becomes the "foreign" site.

Pass in the itemID as usual, and specify Details in the IncludeSelector field. This causes eBay to included prices in their original currency, as well as providing other item details.

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=GetSingleItem
   &responseencoding=XML
   &appid=YourAppID
   &siteid=77
   &version=515
   &ItemID=280351167497
   &IncludeSelector=Details

   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"?>
<GetSingleItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>280351167497</ItemID>
  <IncludeSelector>Details</IncludeSelector>
</GetSingleItemRequest>

Output

The eBay response shows the original price (CurrentPrice) in US Dollars and the converted price (ConvertedCurrentPrice) in Euros. The response also shows values for BuyItNowPrice and ConveretedBuyItNowPrice, indicating that the item was listed with the Buy It Now feature.

Because the query specified the Details IncludeSelector, the result has detailed information about the listing, such as the listing type (a Chinese auction, which means it's a single-quantity, auction-style listing), information about the high bidder (anonymized as a***o, per eBay policy) and various other listing details. Note that using an IncludeSelector can increase the call's response time.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSingleItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-06-05T21:22:13.130Z</Timestamp>
  <Ack>Success</Ack>
  <Build>e619__Bundled_9067380_R1</Build>
  <Version>619</Version>
  <Item>
    <BestOfferEnabled>false</BestOfferEnabled>
    <BuyItNowPrice currencyID="USD">1000.0</BuyItNowPrice>
    <ItemID>280351167497</ItemID>
    <BuyItNowAvailable>true</BuyItNowAvailable>
    <ConvertedBuyItNowPrice currencyID="EUR">704.8</ConvertedBuyItNowPrice>
    <EndTime>2009-06-07T02:05:22.000Z</EndTime>
    <StartTime>2009-05-28T02:05:22.000Z</StartTime>
    <ViewItemURLForNaturalSearch>http://cgi.ebay.de/US-Fender-Highway-1
        -pro-painted-Sea-Foam-Green-Nitro_W0QQitemZ280351167497
        QQcategoryZ64400QQcmdZViewItem</ViewItemURLForNaturalSearch>
    <ListingType>Chinese</ListingType>
    <Location>Phoenix, Arizona</Location>
    <PaymentMethods>PayPal</PaymentMethods>
    <GalleryURL>http://thumbs3.ebaystatic.com/pict/978080_1.jpg</GalleryURL>
    <PictureURL>http://i.ebayimg.com/04/!BTQ)2u!BGk~$(KGrHgoH-
        EQEjlLluvvMBKHe69g9dQ~~_1.JPG?set_id=880000500F</PictureURL>
    <PostalCode>85064</PostalCode>
    <PrimaryCategoryID>64400</PrimaryCategoryID>
    <PrimaryCategoryName>Musical Instruments:Guitar:Bass:Right-Handed:
        Fender:Jazz</PrimaryCategoryName>
    <Quantity>1</Quantity>
    <Seller>
      <UserID>johnnywadd1</UserID>
      <FeedbackRatingStar>Purple</FeedbackRatingStar>
      <FeedbackScore>862</FeedbackScore>
      <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
    </Seller>
    <BidCount>3</BidCount>
    <ConvertedCurrentPrice currencyID="EUR">430.63</ConvertedCurrentPrice>
    <CurrentPrice currencyID="USD">611.0</CurrentPrice>
    <HighBidder>
      <UserID>a***o</UserID>
      <FeedbackPrivate>false</FeedbackPrivate>
      <FeedbackRatingStar>Yellow</FeedbackRatingStar>
      <FeedbackScore>11</FeedbackScore>
    </HighBidder>
    <ListingStatus>Active</ListingStatus>
    <QuantitySold>0</QuantitySold>
    <ReserveMet>false</ReserveMet>
    <ShipToLocations>Worldwide</ShipToLocations>
    <Site>US</Site>
    <TimeLeft>P1DT4H43M9S</TimeLeft>
    <Title>US Fender Highway 1, pro painted Sea Foam Green Nitro</Title>
    <HitCount>798</HitCount>
    <Subtitle>Nordstrand NPJ4SV pick ups, Gotoh 28:1 Vintage Tuners</Subtitle>
    <PrimaryCategoryIDPath>619:3858:38078:160931:64399:64400</PrimaryCategoryIDPath>
    <Storefront>
      <StoreURL>http://stores.ebay.de/id=0</StoreURL>
      <StoreName>
      </StoreName>
    </Storefront>
    <Country>US</Country>
    <MinimumToBid currencyID="USD">621.0</MinimumToBid>
    <AutoPay>true</AutoPay>
    <PaymentAllowedSite>CanadaFrench</PaymentAllowedSite>
    <PaymentAllowedSite>Spain</PaymentAllowedSite>
    <PaymentAllowedSite>Canada</PaymentAllowedSite>
    <PaymentAllowedSite>US</PaymentAllowedSite>
    <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
  </Item>
</GetSingleItemResponse>

Back to list of samples

Sample: Getting All Variations in a Multi-Variation Listing

Retrieves a multi-variation listing with all available variations.

Description

User bountifulbuyer has searched for and found a listing with women's Polo tops. She has determined that this is a multi-variation listing and she wants to see all the available tops within the listing.

Input

The key inputs for this call scenario are the ItemID, which she obtained from a search call response, and IncludSelector, which she sets to Variations and ItemSpecifics to make sure she sees all the available variations and gets any shared specifics, such as Brand.

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=GetSingleItem
   &responseencoding=XML
   &appid=YourAppIDHere
   &siteid=0
   &version=615
   &ItemID=350001227490
   &IncludeSelector=Variations,ItemSpecifics

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

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

<?xml version="1.0" encoding="utf-8"?>
<GetSingleItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>350001227490</ItemID>
  <IncludeSelector>Variations,ItemSpecifics</IncludeSelector>
</GetSingleItemRequest>

Output

The response includes all the basic details of the listing and all the available variations. The important fields for bountifulbuyer are the Variation fields, which help her decide which variation she wants to purchase, the quantity of items available in that variation, and the variation's price.

Note that the item-level fixed price (Item.ConvertedCurrentPrice) is the value of the lowest-priced variation that is still available for sale.

Note that the sample output displays only a few variations (to keep the sample shorter). In practice, the response could be much larger--a single listing can contain up to 120 variations (as of the time of this writing).

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetSingleItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-05-04T01:05:11.834Z</Timestamp>
  <Ack>Success</Ack>
  <Build>e615__Bundled_8552129_R1</Build>
  <Version>615</Version>
  <Item>
    <ItemID>350001227490</ItemID>
    <EndTime>2009-06-03T00:00:09.000Z</EndTime>
    <ViewItemURLForNaturalSearch>http://cgi.ebay.com/New-Ralph-Lauren-Polo-shirt-Pink-Black-Blue-Yellow_W0QQitemZ350001227490QQcategoryZ37565QQvarZ510000002745QQcmdZViewItem</ViewItemURLForNaturalSearch>
    <ListingType>FixedPriceItem</ListingType>
    <Location>San Jose, California</Location>
    <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sbl.JPG</PictureURL>
    <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sbl.JPG</PictureURL>
    <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d88f_1_sbl.JPG</PictureURL>
    <PrimaryCategoryID>37565</PrimaryCategoryID>
    <PrimaryCategoryName>Everything Else:Test Auctions:Attributes:Attributes7</PrimaryCategoryName>
    <BidCount>0</BidCount>
    <ConvertedCurrentPrice currencyID="USD">17.99</ConvertedCurrentPrice>
    <ListingStatus>Active</ListingStatus>
    <TimeLeft>P29DT22H54M40S</TimeLeft>
    <Title>New Ralph Lauren Polo shirt Pink Black Blue Yellow</Title>
    <ItemSpecifics>
      <NameValueList>
        <Name>Occasion</Name>
        <Value>Casual</Value>
      </NameValueList>
      <NameValueList>
        <Name>Brand</Name>
        <Value>Ralph Lauren</Value>
      </NameValueList>
      <NameValueList>
        <Name>Style</Name>
        <Value>Polo Shirt</Value>
      </NameValueList>
      <NameValueList>
        <Name>Sleeve Style</Name>
        <Value>Short Sleeve</Value>
      </NameValueList>
    </ItemSpecifics>
    <Country>US</Country>
    <AutoPay>false</AutoPay>
    <Variations>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Pnk_S</SKU>
        <StartPrice currencyID="USD">17.99</StartPrice>
        <Quantity>4</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Pink</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>S</Value>
          </NameValueList>
        </VariationSpecifics>
        <SellingStatus>
          <QuantitySold>0</QuantitySold>
        </SellingStatus>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Pnk_M</SKU>
        <StartPrice currencyID="USD">17.99</StartPrice>
        <Quantity>8</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Pink</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>M</Value>
          </NameValueList>
        </VariationSpecifics>
        <SellingStatus>
          <QuantitySold>0</QuantitySold>
        </SellingStatus>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Blk_S</SKU>
        <StartPrice currencyID="USD">20.0</StartPrice>
        <Quantity>10</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Black</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>S</Value>
          </NameValueList>
        </VariationSpecifics>
        <SellingStatus>
          <QuantitySold>0</QuantitySold>
        </SellingStatus>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Blk_M</SKU>
        <StartPrice currencyID="USD">20.0</StartPrice>
        <Quantity>10</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Black</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>M</Value>
          </NameValueList>
        </VariationSpecifics>
        <SellingStatus>
          <QuantitySold>0</QuantitySold>
        </SellingStatus>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Blu_S</SKU>
        <StartPrice currencyID="USD">20.0</StartPrice>
        <Quantity>10</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Blue</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>S</Value>
          </NameValueList>
        </VariationSpecifics>
        <SellingStatus>
          <QuantitySold>0</QuantitySold>
        </SellingStatus>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Blu_M</SKU>
        <StartPrice currencyID="USD">20.0</StartPrice>
        <Quantity>10</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Blue</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>M</Value>
          </NameValueList>
        </VariationSpecifics>
        <SellingStatus>
          <QuantitySold>0</QuantitySold>
        </SellingStatus>
      </Variation>
      <Pictures>
        <VariationSpecificName>Color</VariationSpecificName>
        <VariationSpecificPictureSet>
          <VariationSpecificValue>Pink</VariationSpecificValue>
          <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sbl.JPG</PictureURL>
          <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sb2.JPG</PictureURL>
        </VariationSpecificPictureSet>
        <VariationSpecificPictureSet>
          <VariationSpecificValue>Blue</VariationSpecificValue>
          <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sbl.JPG</PictureURL>
          <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sb2.JPG</PictureURL>
          <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sb3.JPG</PictureURL>
        </VariationSpecificPictureSet>
        <VariationSpecificPictureSet>
          <VariationSpecificValue>Black</VariationSpecificValue>
          <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d88f_1_sbl.JPG</PictureURL>
        </VariationSpecificPictureSet>
        <VariationSpecificPictureSet>
          <VariationSpecificValue>Yellow</VariationSpecificValue>
          <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d89f_1_sbl.JPG</PictureURL>
        </VariationSpecificPictureSet>
      </Pictures>
      <VariationSpecificsSet>
        <NameValueList>
          <Name>Size</Name>
          <Value>XS</Value>
          <Value>S</Value>
          <Value>M</Value>
          <Value>L</Value>
          <Value>XL</Value>
        </NameValueList>
        <NameValueList>
          <Name>Color</Name>
          <Value>Black</Value>
          <Value>Pink</Value>
          <Value>Yellow</Value>
          <Value>Blue</Value>
        </NameValueList>
      </VariationSpecificsSet>
    </Variations>
  </Item>
</GetSingleItemResponse>

Back to list of samples



Back to top

GetSingleItem Change History
Version Description
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).
  • ShippingCostSummaryType.ListedShippingServiceCost (added): The listed shipping cost for an item.
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.
573
2008-07-09
  • Item.DigitalDeliveryRequirements, Item.DigitalDeliveryMethod (deprecated): The digital delivery feature is disabled as of March 28, 2008.
559
2008-04-02
  • SimpleItem.BusinessSellerDetails (modified): GetSingleItem now returns the seller's information (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. This is only applicable for sites where Business Seller options are supported.
535
2007-10-12
  • CharityType.CharityID, CharityType.CharityName, CharityType.CharityNumber, CharityType.DonationPercent, CharityType.Mission, CharityType.LogoURL, CharityType.CharityListing, CharityType.CharityStatusCodeType.Status (added): Additional fields (showing information about seller's charitable status) are returned in this call.
533
2007-10-03
  • Item.Seller.PositiveFeedbackPercent, Item.ReturnPolicy (added): Additional fields (showing percentage value of seller's positive feedback and showing return policy details, if any) are returned in this call.
527
2007-08-22
  • ListingType (modified): The ListingType field now is returned by default.
525
2007-08-08
  • HitCount, PrimaryCategoryIDPath, SecondaryCategoryID, SecondaryCategoryIDPath, SecondaryCategoryIDName, Subtitle (added): Several new fields have been added in the response.
515
2007-06-10
  • (added) New call.

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

© 2006–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.