Retrieves publicly available data for one or more listings.
Use this call to retrieve much of the information that is visible on a listing's View Item page on the eBay Web site, such as title, prices, and basic shipping costs. Provide ItemID for every item for which you want information. This call returns the same minimal information that is returned by GetSingleItem for each item with no IncludeSelector specified. (Use GetShippingCosts to retrieve more detailed shipping cost information for a given item.)
For information about specifying affiliate parameters, see Affiliate URL Parameters and HTTP Header Values.
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History |
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"?>
<GetMultipleItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Standard Input Fields -->
<MessageID> string </MessageID>
<!-- Call-specific Input Fields -->
<IncludeSelector> string </IncludeSelector>
<ItemID> string </ItemID>
<!-- ... more ItemID nodes here ... -->
</GetMultipleItemsRequest>
| 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.) • 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. |
| ItemID | string | Required,
repeatable: [1..*] |
The item ID that uniquely identifies the item listing for which to retrieve the data. You can provide a maximum of 20 item IDs. When making a URL request, repeating ItemID parameters must be specified as an indexed array (e.g., ...&ItemID(0)=130310421484&ItemID(1)= 300321408208& ItemID(2)=370214653822...). Alternatively, as a shortcut for URL requests, you can specify the item IDs as a comma-separated list in a single ItemID parameter (e.g., ...< code>&ItemID=130310421484,300321408208,370214653822... ) for convenience. You can determine an item's ID by calling FindItems or from the eBay Web site. Provide ItemID for every item for which you want information. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). |
| Input Detail Controls Samples Change History |
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"?>
<GetMultipleItemsResponse 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>
<Charity> CharityType
<CharityID> string </CharityID>
<CharityName> string </CharityName>
<CharityNumber> int </CharityNumber>
<DonationPercent> float </DonationPercent>
<LogoURL> string </LogoURL>
<Mission> string </Mission>
<Status> CharityStatusCodeType </Status>
</Charity>
<ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
<Country> CountryCodeType </Country>
<CurrentPrice> 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> 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>
<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> 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>
<!-- ... more Item nodes here ... -->
</GetMultipleItemsResponse>
| 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.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. |
| Call-specific Output Fields | |||
| Item | SimpleItemType | Always,
repeatable: [1..*] |
Contains details for a listing (or multiple) listings that correspond to the item ID(s) specified in the request.
IncludeSelector: none (not controlled by IncludeSelector) |
| Item.AutoPay | boolean | Always |
If true, the seller requires immediate payment for the item. If false (or not specified), immediate payment is not requested. Buyers must have a PayPal account to purchase items that require immediate payment. A seller can choose to require immediate payment for Fixed Price and Buy It Now listings, 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:
|
| 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 |
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.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.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:
|
| 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.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) |
| 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 | Always |
Indicates whether the item can be paid for through a payment gateway account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account.
IncludeSelector: Details |
| Item.ItemID | string | Always |
The ID that uniquely identifies the item listing. eBay generates this ID when an item is listed. This ID is unique across all eBay sites. 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) |
| 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.
• Express Deprecated as of version 561.
• FixedPriceItem (out) A basic fixed-price listing with a Quantity of 1. Allows no auction-style bidding. Also known as Buy It Now Only on some sites, this should not to be confused with the BuyItNow option that is available for competitive-bid auctions. Fixed-price listings appear on eBay.com. They are also listed in a seller's eBay Store if the seller is a Store owner. • LeadGeneration (out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • 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.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.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) |
| 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 .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) |
| Input Output Samples Change History |
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.
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field description for clarification of conditions. |
| Input Output Detail Controls Change History |
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.
Retrieves the basic, default set of information pertaining to multiple items (itemIDs).
Input
You wish to see the basic details about several items whose itemID values were obtained from another call (for example, you might have conducted a search with FindItems). To accomplish this, call GetMultipleItems with an itemID value for each item you want to inspect.
URL format (HTTP GET). See also the non-wrapped version of this URL. For results in a format other than XML,
specify a different value for responseencoding. http://open.api.ebay.com/shopping?callname=GetMultipleItems
&responseencoding=XML
&appid=YourAppIDHere
&siteid=0
&version=525
&ItemID=190000456297,280000052600,9600579283
Here is the same input in XML format (HTTP POST). Note that this does not include standard values.
XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <GetMultipleItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <ItemID>190000456297</ItemID> <ItemID>280000052600</ItemID> <ItemID>9600579283</ItemID> </GetMultipleItemsRequest>
Output
XML format. Also available are the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="UTF-8"?> <GetMultipleItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <Timestamp>2007-07-06T21:36:26.968Z</Timestamp> <Ack>Success</Ack> <Build>e527_core_APILW_4863605_R1</Build> <Item> <ItemID>190000456297</ItemID> <BuyItNowAvailable>false</BuyItNowAvailable> <EndTime>2009-07-25T09:27:34.000Z</EndTime> <ViewItemURLForNaturalSearch>http://cgi.ebay.com/harry-potter-gwq-minimium_W0QQitemZ190000456297QQcategoryZ617QQcmdZViewItem</ViewItemURLForNaturalSearch> <Location>qwg</Location> <PrimaryCategoryID>617</PrimaryCategoryID> <PrimaryCategoryName>DVDs & Movies:DVD, HD DVD & Blu-ray</PrimaryCategoryName> <BidCount>0</BidCount> <ConvertedCurrentPrice currencyID="USD">1.0</ConvertedCurrentPrice> <ListingStatus>Active</ListingStatus> <TimeLeft>P729DT11H49M7S</TimeLeft> <Title>harry potter gwq minimium</Title> </Item> <Item> <ItemID>280000052600</ItemID> <EndTime>2009-07-25T10:01:59.000Z</EndTime> <ViewItemURLForNaturalSearch>http://cgi.ebay.com/faridakp-blacck-harry-potter_W0QQitemZ280000052600QQcategoryZ63889QQcmdZViewItem</ViewItemURLForNaturalSearch> <Location>San Jose, California</Location> <GalleryURL>http://thumbs.ebaystatic.com/pict/280000052600.jpg</GalleryURL> <PictureURL>http://i3.ebayimg.com/05/i/07/62/4f/9b_1_b.JPG</PictureURL> <PrimaryCategoryID>63889</PrimaryCategoryID> <PrimaryCategoryName>Clothing, Shoes & Accessories:Women's Shoes</PrimaryCategoryName> <BidCount>0</BidCount> <ConvertedCurrentPrice currencyID="USD">15.0</ConvertedCurrentPrice> <ListingStatus>Active</ListingStatus> <TimeLeft>P729DT12H23M32S</TimeLeft> <Title>faridakp blacck harry potter</Title> </Item> <Item> <ItemID>9600579283</ItemID> <EndTime>2009-07-25T10:03:56.000Z</EndTime> <ViewItemURLForNaturalSearch>http://cgi.ebay.com/Harry-Potter-Literature-Guide-2000_W0QQitemZ9600579283QQcategoryZ279QQcmdZViewItem</ViewItemURLForNaturalSearch> <Location>San Jose</Location> <PrimaryCategoryID>279</PrimaryCategoryID> <PrimaryCategoryName>Books:Children's Books</PrimaryCategoryName> <BidCount>0</BidCount> <ConvertedCurrentPrice currencyID="USD">21.85</ConvertedCurrentPrice> <ListingStatus>Active</ListingStatus> <TimeLeft>P729DT12H25M29S</TimeLeft> <Title>Harry Potter Literature Guide (2000)</Title> </Item> </GetMultipleItemsResponse>
| Input Output Detail Controls Samples |
| Version | Description |
|---|---|
| 637 2009-09-30 |
|
| 603 2009-02-04 |
|
| 589 2008-10-29 |
|
| 565 2008-05-14 |
|
| 527 2007-08-22 |
|
| 525 2007-08-08 |
|
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.