eBay Finding API1.13.0

findItemsByProduct

This call searches for items on eBay using specific eBay product values.

Usage Details

To use this call, input a product number using the productId field. Products on eBay fall into the following categories:

The findItemsByProduct response contains details about items matching your search criteria. By default, eBay returns a specific set of data in the response to your call. Control findItemsByProduct result sets using the following methods:

If you are an eBay affiliate, you can specify your affiliate information using the fields in the affiliate container. By specifying your affiliate information, you can earn commissions on user activity generated from your site. Affiliate data is embedded in the viewItemURL URLs returned in your search results.

For details on these response control mechanisms, refer to findItemsByKeywords.

Related Information

See also the reference documentation for these calls:



Back to top

Input

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

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<findItemsByProductRequest xmlns="http://www.ebay.com/marketplace/search/v1/services">
  <!-- Call-specific Input Fields -->
  <itemFilter> ItemFilter
    <name> ItemFilterType </name>
    <paramName> token </paramName>
    <paramValue> string </paramValue>
    <value> string </value>
    <!-- ... more value values allowed here ... -->
  </itemFilter>
  <!-- ... more itemFilter nodes allowed here ... -->
  <outputSelector> OutputSelectorType </outputSelector>
  <!-- ... more outputSelector values allowed here ... -->
  <productId type="string"> ProductId (string) </productId>
  <!-- Standard Input Fields -->
  <affiliate> Affiliate
    <customId> string </customId>
    <geoTargeting> boolean </geoTargeting>
    <networkId> string </networkId>
    <trackingId> string </trackingId>
  </affiliate>
  <buyerPostalCode> string </buyerPostalCode>
  <paginationInput> PaginationInput
    <entriesPerPage> int </entriesPerPage>
    <pageNumber> int </pageNumber>
  </paginationInput>
  <sortOrder> SortOrderType </sortOrder>
</findItemsByProductRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
itemFilter ItemFilter Optional,
repeatable: [0..*]
Reduce the number of items returned by a find request using item filters. Use itemFilter to specify name/value pairs. You can include multiple item filters in a single request.
itemFilter.name ItemFilterType Optional Specify the name of the item filter you want to use. The itemFilter name must have a corresponding value. You can apply multiple itemFilter Name/Value pairs in a single request.

Applicable values: See name.

See:
    ItemFilterType for more information about the allowed values, usage rules, and dependencies
    findItemsIneBayStores Call Sample: Using itemFilters to define a price range
    findItemsAdvanced Call Sample: Using itemFilters to search for used Buy It Now items

itemFilter.paramName token Optional In addition to filter Name/Value pairs, some itemFilters use an additional parameter Name/Value pair. Specifically, filters that use currency values (MaxPrice and MinPrice) make use of addition parameters. When you use these itemFilters, set paramName to Currency and provide the currency ID in paramValue.

For example, if you use the MaxPrice itemFilter, you will need to specify a parameter Name of Currency with a parameter Value that specifies the type of currency desired.

Note that for MaxPrice and MinPrice itemFilters, the default value for paramName is Currency.
itemFilter.paramValue string Optional The currency value associated with the respective itemFilter parameter Name.

Usually paramName is set to Currency and paramValue is set to the currency type in which the monetary transaction occurs.

Note that for MaxPrice and MinPrice itemFilters, the default value for paramValue is USD.

See currencyId Values for a list of possible currency enumeration values.

itemFilter.value string Optional,
repeatable: [1..*]
The value associated with the respective item filter name. Allowed values and datatypes vary for a given filter name.

See ItemFilterType for information about the allowed values, usage rules, and dependencies.

outputSelector OutputSelectorType Optional,
repeatable: [0..*]
Defines what data to return, in addition to the default set of data, in a response.

If you don't specify this field, eBay returns a default set of item fields. Use outputSelector to include more information in the response. The additional data is grouped into discrete nodes. You can specify multiple nodes by including this field multiple times, as needed, in the request.

If you specify this field, the additional fields returned can affect the call's response time (performance), including in the case with feedback data.

Applicable values:

AspectHistogram
Include an AspectHistogram container with information about aspects from the category that is most relevant to your search.
ConditionHistogram
Include a ConditionHistogram container with the number of items found per condition (for example, how many items are new). This value has no effect when Condition is specified as an item filter. Supported for all eBay sites except US eBay Motors, India (IN), Malaysia (MY) and Philippines (PH).
GalleryInfo
Include the GalleryInfoContainer, which contains URLs for three thumbnail images of the item in different sizes: large, medium, and small.
PictureURLLarge
Include a URL to a picture of the item that is 400x400 pixels in size.
PictureURLSuperSize
Include a URL to a picture of the item that is 800x800 pixels in size.
SellerInfo
Include information about the seller in the response.
StoreInfo
Include information about the seller's eBay store in the response.
UnitPriceInfo
Include the unitPrice container with unit type and quantity information used for per-unit pricing (on eBay EU sites only).

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

See Detail Controls.

productId ProductId (string) Required Input ISBN, UPC, EAN, or ReferenceID (ePID) to specify the type of product for which you want to search.

For example, to search using an ISBN, specify productID.type=ISBN and set productID.value to an ISBN value. To search using an eBay Product Reference ID, set productId.type to "ReferenceID" and set productId.value to an ePID value (also known as an Bay Product Reference ID). If you do not know the ePID value for a product, use FindProducts in the eBay Shopping API to retrieve the desired ePID.

See FindProducts in the Shopping API for information on retrieving eBay product data.

productId
  [ attribute type ]
string Required Input ISBN, UPC, EAN, or ReferenceID (ePID) to specify the type of product for which you want to search.

For example, to search using an ISBN, specify productID.type=ISBN and set productID.value to an ISBN value. To search using an eBay Product Reference ID, set productId.type to "ReferenceID" and set productId.value to an ePID value (also known as an Bay Product Reference ID). If you do not know the ePID value for a product, use FindProducts in the eBay Shopping API to retrieve the desired ePID.
Standard Input Fields  
affiliate Affiliate Optional Container for affiliate details. eBay uses the specified affiliate information to build a View Item URL and Product URL string with correctly formatted affiliate tracking information, which it returns in the response. You can publish these URLs, and if a user clicks them to access eBay, the respective affiliate might get a commission, depending on the user's actions.

See:
    eBay Partner Network site for information about affiliate commissions
    findItemsByKeywords Call Sample: Specifying affiliate information

affiliate.customId string Optional You can define an affiliate customId if you want an ID to monitor your marketing efforts. Chose an ID up to up to 256 characters in length. If you are using the eBay Partner Network, and you provide a customId, the tracking URL returned by the eBay Partner Network will contain your customId value.
affiliate.geoTargeting boolean Optional The geoTargeting parameter will be used for geographical targeting your affiliate programs. The geo-targeting feature works for English speaking countries (US, UK, CA, AU, and IE) only.
affiliate.networkId string Optional Specifies your tracking partner for affiliate commissions. Affiliates earn money from eBay for driving traffic to eBay. This field is required if you specify a tracking ID. Depending on your tracking partner, specify one of the following values. Not all partners are valid for all sites. For PlaceOffer, only the eBay Partner Network and Mediaplex are valid:

2 = Be Free
3 = Affilinet
4 = TradeDoubler
5 = Mediaplex
6 = DoubleClick
7 = Allyes
8 = BJMT
9 = eBay Partner Network

See eBay Partner Network site for information about commissions.

affiliate.trackingId string Optional Specify the affiliate value obtained from your tracking partner. For the eBay Partner Network, the tracking ID is the provided Campaign ID ("campid"). A Campaign ID is a unique 10-digit number used for associating traffic and is valid across all programs to which you have been accepted. Another example of this value is the Affiliate ID given to you by TradeDoubler.
buyerPostalCode string Optional The postal code of the buyer. This is used as the basis for proximity searches as well as local searches.

A proximity search requires buyerPostalCode and a MaxDistance item filter. A local search requires buyerPostalCode and item filters for MaxDistance and LocalSearch.

See findItemsByKeywords Call Sample: Proximity Search for an example of how to restrict searches by distance.

paginationInput PaginationInput Optional Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and the page of data to return. Controls the number of listings returned in the response, but does not specify the details to return for each listing.

Note: No more than 10,000 items can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (100).
paginationInput.entriesPerPage int Optional Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set.

If entriesPerPage is set to a number greater than 100, the default value, 100, will be used.
Min: 1. Max: 100. Default: 100.
paginationInput.pageNumber int Optional Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return.
Min: 1. Max: 100. Default: 1.
sortOrder SortOrderType Optional Sort the returned items according to a single specified sort order.
Default: BestMatch.

Applicable values:

BestMatch
Sorts items by Best Match, which is based on community buying activity and other relevance-based factors.

Note: eBay site search results sorted by Best Match may not match the API search results sorted by Best Match. The site Best Match algorithm takes into account additional factors, such as user information, not available to the API.
BidCountFewest
Sorts items by the number of bids they have received, with items that have received the fewest bids first.

To sort by bid count, you must specify a listing type filter to limit results to auction listings only (such as, & itemFilter.name=ListingType&itemFilter.value=Auction).
BidCountMost
Sorts items by the number of bids they have received, with items that have received the most bids first.

To sort by bid count, you must specify a listing type filter to limit results to auction listings only (such as, & itemFilter.name=ListingType&itemFilter.value=Auction).
CountryAscending
Sorts items available on the given site (as specified by global ID in the HTTP header or URL parameter) by the country in which they are located. For CountryAscending, items located in the country most closely associated with the site appear first, followed by items in related countries, and then items from other countries.

For example, when searching the Ireland site, items located in Ireland (IE) will be returned first, followed by items located in related countries like the United Kingdom (GB), the United States (US), Hong Kong (HK), and Singapore (SG) next. Remaining items are sorted in alphabetical order by English country name (regardless of the language for the site), with some exceptions (for example, United States sorts first, APO/FPO sorts near the end).

CountryAscending applies to the following sites only: Austria (EBAY-AT), Belgium-French (EBAY-FRBE), Belgium-Netherlands (EBAY-NLBE), Germany (EBAY-DE), Ireland (EBAY-IE), Netherlands (EBAY-NL), Poland (EBAY-PL), Spain (EBAY-ES), and Switzerland (EBAY-CH).
CountryDescending
Sorts items available on the given site (as specified by global ID in the HTTP header or URL parameter) by the country in which they are located. For CountryDescending, items are sorted in reverse order of CountryAscending. That is, items in countries not specifically related to the site appear first, sorted in descending alphabetical order by English country name. For example, when searching the Ireland site, items located in countries like Yugoslavia or Uganda are returned first. Items located in Ireland (IE) will be returned last.

CountryDescending applies to the following sites only: Austria (EBAY-AT), Belgium-French (EBAY-FRBE), Belgium-Netherlands (EBAY-NLBE), Germany (EBAY-DE), Ireland (EBAY-IE), Netherlands (EBAY-NL), Poland (EBAY-PL), Spain (EBAY-ES), and Switzerland (EBAY-CH).
CurrentPriceHighest
Sorts items by their current price, with the highest price first.
DistanceNearest
Sorts items by distance from the buyer in ascending order. The request must also include a buyerPostalCode.
EndTimeSoonest
Sorts items by end time, with items ending soonest listed first.
PricePlusShippingHighest
Sorts items by the combined cost of the item price plus the shipping cost, with highest combined price items listed first. Items are returned in the following groupings: highest total-cost items (for items where shipping was properly specified) appear first, followed by freight- shipping items, and then items for which no shipping was specified. Each group is sorted by price.
PricePlusShippingLowest
Sorts items by the combined cost of the item price plus the shipping cost, with the lowest combined price items listed first. Items are returned in the following groupings: lowest total-cost items (for items where shipping was properly specified) appear first, followed by freight- shipping items, and then items for which no shipping was specified. Each group is sorted by price.
StartTimeNewest
Sorts items by the start time, the most recently listed (newest) items appear first.



Back to top

Output

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

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<findItemsByProductResponse xmlns="http://www.ebay.com/marketplace/search/v1/services">
  <!-- Call-specific Output Fields -->
  <aspectHistogramContainer> AspectHistogramContainer
    <aspect name="string"> Aspect
      <valueHistogram valueName="string"> AspectValueHistogram
        <count> long </count>
      </valueHistogram>
      <!-- ... more valueHistogram nodes allowed here ... -->
    </aspect>
    <!-- ... more aspect nodes allowed here ... -->
    <domainDisplayName> token </domainDisplayName>
    <domainName> string </domainName>
  </aspectHistogramContainer>
  <conditionHistogramContainer> ConditionHistogramContainer
    <conditionHistogram> ConditionHistogram
      <condition> Condition
        <conditionDisplayName> string </conditionDisplayName>
        <conditionId> int </conditionId>
      </condition>
      <count> int </count>
    </conditionHistogram>
    <!-- ... more conditionHistogram nodes allowed here ... -->
  </conditionHistogramContainer>
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <itemSearchURL> anyURI </itemSearchURL>
  <paginationOutput> PaginationOutput
    <entriesPerPage> int </entriesPerPage>
    <pageNumber> int </pageNumber>
    <totalEntries> int </totalEntries>
    <totalPages> int </totalPages>
  </paginationOutput>
  <searchResult count="int"> SearchResult
    <item> SearchItem
      <attribute> ItemAttribute
        <name> string </name>
        <value> string </value>
      </attribute>
      <!-- ... more attribute nodes allowed here ... -->
      <autoPay> boolean </autoPay>
      <charityId> string </charityId>
      <condition> Condition
        <conditionDisplayName> string </conditionDisplayName>
        <conditionId> int </conditionId>
      </condition>
      <country> token </country>
      <discountPriceInfo> DiscountPriceInfo
        <minimumAdvertisedPriceExposure> MapExposureEnum </minimumAdvertisedPriceExposure>
        <originalRetailPrice currencyId="string"> Amount (double) </originalRetailPrice>
        <pricingTreatment> PriceTreatmentEnum </pricingTreatment>
        <soldOffEbay> boolean </soldOffEbay>
        <soldOnEbay> boolean </soldOnEbay>
      </discountPriceInfo>
      <distance unit="string"> Distance (double) </distance>
      <eekStatus> string </eekStatus>
      <!-- ... more eekStatus values allowed here ... -->
      <galleryInfoContainer> GalleryInfoContainer
        <galleryURL gallerySize="GallerySizeEnum"> GalleryURL (anyURI) </galleryURL>
        <!-- ... more galleryURL nodes allowed here ... -->
      </galleryInfoContainer>
      <galleryPlusPictureURL> anyURI </galleryPlusPictureURL>
      <!-- ... more galleryPlusPictureURL values allowed here ... -->
      <galleryURL> anyURI </galleryURL>
      <globalId> token </globalId>
      <isMultiVariationListing> boolean </isMultiVariationListing>
      <itemId> string </itemId>
      <listingInfo> ListingInfo
        <bestOfferEnabled> boolean </bestOfferEnabled>
        <buyItNowAvailable> boolean </buyItNowAvailable>
        <buyItNowPrice currencyId="string"> Amount (double) </buyItNowPrice>
        <convertedBuyItNowPrice currencyId="string"> Amount (double) </convertedBuyItNowPrice>
        <endTime> dateTime </endTime>
        <gift> boolean </gift>
        <listingType> token </listingType>
        <startTime> dateTime </startTime>
      </listingInfo>
      <location> string </location>
      <paymentMethod> token </paymentMethod>
      <!-- ... more paymentMethod values allowed here ... -->
      <pictureURLLarge> anyURI </pictureURLLarge>
      <pictureURLSuperSize> anyURI </pictureURLSuperSize>
      <postalCode> string </postalCode>
      <primaryCategory> Category
        <categoryId> string </categoryId>
        <categoryName> string </categoryName>
      </primaryCategory>
      <productId> ProductId (string) </productId>
      <returnsAccepted> boolean </returnsAccepted>
      <secondaryCategory> Category
        <categoryId> string </categoryId>
        <categoryName> string </categoryName>
      </secondaryCategory>
      <sellerInfo> SellerInfo
        <feedbackRatingStar> token </feedbackRatingStar>
        <feedbackScore> long </feedbackScore>
        <positiveFeedbackPercent> double </positiveFeedbackPercent>
        <sellerUserName> string </sellerUserName>
        <topRatedSeller> boolean </topRatedSeller>
      </sellerInfo>
      <sellingStatus> SellingStatus
        <bidCount> int </bidCount>
        <convertedCurrentPrice currencyId="string"> Amount (double) </convertedCurrentPrice>
        <currentPrice currencyId="string"> Amount (double) </currentPrice>
        <sellingState> token </sellingState>
        <timeLeft> duration </timeLeft>
      </sellingStatus>
      <shippingInfo> ShippingInfo
        <expeditedShipping> boolean </expeditedShipping>
        <handlingTime> int </handlingTime>
        <oneDayShippingAvailable> boolean </oneDayShippingAvailable>
        <shippingServiceCost currencyId="string"> Amount (double) </shippingServiceCost>
        <shippingType> token </shippingType>
        <shipToLocations> string </shipToLocations>
        <!-- ... more shipToLocations values allowed here ... -->
      </shippingInfo>
      <storeInfo> Storefront
        <storeName> string </storeName>
        <storeURL> anyURI </storeURL>
      </storeInfo>
      <subtitle> string </subtitle>
      <title> string </title>
      <topRatedListing> boolean </topRatedListing>
      <unitPrice> UnitPriceInfo
        <quantity> double </quantity>
        <type> string </type>
      </unitPrice>
      <viewItemURL> anyURI </viewItemURL>
    </item>
    <!-- ... more item nodes allowed here ... -->
  </searchResult>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</findItemsByProductResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
aspectHistogramContainer AspectHistogramContainer Conditionally Response container for aspect histograms.

outputSelector: AspectHistogram
aspectHistogramContainer
  .aspect
Aspect Conditionally,
repeatable: [1..*]
A characteristic of an item in a category. For example, "Optical Zoom", "Brand", and "Megapixels" could be aspects of the Digital Cameras category. Aspects are well-known, standardized characteristics of a category, and they vary from category to category (the aspects of "Men's Shoes" are different from those of "Digital Cameras"). A search request on the eBay site will often display aspects and their respective aspect values on the left-had side of a query response.

Aspects are extracted from item listing properties (such as item titles and subtitles), and represent the characteristics of active items. Values returned in the Aspect container can be used as inputs to the aspectFilter fields in a query to distill the items returned by the query. eBay generates aspects dynamically from the items currently listed; aspects provide a view into what is currently available on eBay. Because of this, aspect values returned one day cannot be guaranteed to be valid the next day.

The following graphic shows how eBay might return a set of aspects for the Digital Cameras category. In this graphic, "Product Type", "Brand", and "Megapixels" are aspects, and "Point & Shoot", "Canon", and "12.0 to 12.9 MP" are aspect values. Histogram values (item counts) are shown for each aspect value.

eBay Aspects

outputSelector: AspectHistogram
aspectHistogramContainer
  .aspect
  [ attribute name ]
string Conditionally A characteristic of an item in a category. For example, "Optical Zoom", "Brand", and "Megapixels" could be aspects of the Digital Cameras category. Aspects are well-known, standardized characteristics of a category, and they vary from category to category (the aspects of "Men's Shoes" are different from those of "Digital Cameras"). A search request on the eBay site will often display aspects and their respective aspect values on the left-had side of a query response.

Aspects are extracted from item listing properties (such as item titles and subtitles), and represent the characteristics of active items. Values returned in the Aspect container can be used as inputs to the aspectFilter fields in a query to distill the items returned by the query. eBay generates aspects dynamically from the items currently listed; aspects provide a view into what is currently available on eBay. Because of this, aspect values returned one day cannot be guaranteed to be valid the next day.

The following graphic shows how eBay might return a set of aspects for the Digital Cameras category. In this graphic, "Product Type", "Brand", and "Megapixels" are aspects, and "Point & Shoot", "Canon", and "12.0 to 12.9 MP" are aspect values. Histogram values (item counts) are shown for each aspect value.

eBay Aspects
aspectHistogramContainer
  .aspect.valueHistogram
AspectValueHistogram Conditionally,
repeatable: [0..*]
Container that returns the name of the respective aspect value and the histogram (the number of available items) that share that item characteristic.

This value is not returned if there are no matching aspects for the category.

outputSelector: AspectHistogram
aspectHistogramContainer
  .aspect.valueHistogram
  [ attribute valueName ]
string Conditionally Container that returns the name of the respective aspect value and the histogram (the number of available items) that share that item characteristic.

This value is not returned if there are no matching aspects for the category.
aspectHistogramContainer
  .aspect.valueHistogram.count
long Conditionally Number of items that share the characteristic the respective aspect value.

outputSelector: AspectHistogram
aspectHistogramContainer
  .domainDisplayName
token Conditionally As of October 2014, this field returns a category name, which is a buy-side group of items, for example "Shoes."

outputSelector: AspectHistogram
aspectHistogramContainer
  .domainName
string Conditionally As of October 2014, this field returns a category name. A buy-side group of items that share aspects, but not necessarily an eBay category. For example "Women's Dresses" or "Digital Cameras" could be categories. You can use a domainName to label a set of aspects that you display.

outputSelector: AspectHistogram
conditionHistogramContainer ConditionHistogramContainer Conditionally Response container for condition histograms.

Not returned when Condition is specified in itemFilter. That is, only returned when you have not yet narrowed your search based on specific conditions.

Only returned when you search the eBay US site (as of February 2011). International items in US search results are included in the histogram counts.

outputSelector: ConditionHistogram
conditionHistogramContainer
  .conditionHistogram
ConditionHistogram Conditionally,
repeatable: [0..*]
Statistical (item count) information on the condition of items that match the search criteria (or specified category). For example, the number of brand new items that match the query.

Each conditionHistogram specifies one condition and the number of matching items found. The list of all conditionHistogram containers returned represents the union of all conditions that were found in the item results. For example, if items were found in different categories, and if those categories support different sets of item conditions, then all those conditions are returned in the list, regardless of category.

If multiple items use the same condition ID, but some items use different display names for that condition, the histogram shows the site's default display name for that condition. This means that the condition name in a histogram may not always exactly match the condition names on the counted items.

outputSelector: ConditionHistogram
conditionHistogramContainer
  .conditionHistogram.condition
Condition Conditionally The ID and name of a condition that was found in the item results.

outputSelector: ConditionHistogram
conditionHistogramContainer
  .conditionHistogram.condition
  .conditionDisplayName
string Conditionally The human-readable label for the item condition. Display names are localized for the site on which they're listed (not necessarily the site on which they're viewed).

In item results, this is only returned when the seller specified the item's condition using a structured format eBay recognizes (for example, conditionId or an older item specifics format).

When conditionId is also present: Most categories use the same display name for the same condition ID. Some categories may override the display name based on buyer expectations for items in the category. For example, condition ID 1000 could be called "New" in one category and "New with tags" in another. If an item is listed in two categories, the primary category controls the display name.

Behind the scenes, eBay's search engine uses the ID (not the display name) to determine whether items are new, used, or refurbished. So, if you need to normalize the conditions across categories (such as to group items by condition), it may be easier to use the ID and then show the varying display names for reference.

In condition histograms: If you search against a specific category and some items match based on their secondary category, the histogram only shows the display name if the secondary category supports the condition. (Condition IDs and names are dependent on the primary category.) However, the histogram shows the condition ID and item counts. This should only occur in a very small percent of results. Histograms may support display names in these cases later in 2011. As a workaround, you can fill in the missing name based on the "Item Condition IDs and Names" (link below) or based on the condition from an applicable item in the results.

For example, suppose a seller lists a concert T-shirt in a clothing category with the condition "New without tags" (1500), and also in a music accessories secondary category (where "New without tags" isn't a recognized condition). If you specify the music accessories category in your request, the condition ID (1500) is shown in the histogram, but not the display name. However, the display name is shown within the items.
Max length: 50.

outputSelector: none (not controlled by outputSelector)

See Item Condition IDs and Names for a list of display names and the typical meaning of each condition.

conditionHistogramContainer
  .conditionHistogram.condition
  .conditionId
int Conditionally The numeric ID (for example, 1000) for the item condition.

In item results, this is only returned when the seller listed the item with a condition ID. Some categories don't support or require condition IDs (for example, most Antiques categories don't). Also, until spring 2011, some GTC listings may define the item condition in item specifics instead, so no ID is returned.

If you specify Condition in itemFilter, the response returns items with the correctly matching condition(s), even if conditionId is not returned. For example, if you specify a value of "New" or "1000" in the item filter, the response only returns new items.
Min: 1000. Max: 7000.

outputSelector: none (not controlled by outputSelector)

See Item Condition IDs and Names for a list of display names and the typical meaning of each condition.

conditionHistogramContainer
  .conditionHistogram.count
int Conditionally The number of items found that match the condition. Only counts items where the seller specified the condition by using item.conditionId.

outputSelector: ConditionHistogram
Standard Output Fields  
ack AckValue Always Indicates whether or not errors or warnings were generated during the processing of the request.

Applicable values:

Failure
eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data.
PartialFailure
eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. For best results, requests should return without warning messages. Inspect the message details and resolve any problems before resubmitting the request.
Success
eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result.
Warning
The request was successfully processed, but eBay encountered a non-fatal error during the processing. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.



outputSelector: none (not controlled by outputSelector)
errorMessage ErrorMessage Conditionally Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success.

outputSelector: none (not controlled by outputSelector)
errorMessage.error ErrorData Conditionally,
repeatable: [0..*]
Details about a single error.

outputSelector: none (not controlled by outputSelector)
errorMessage.error.category ErrorCategory Conditionally There are three categories of errors: request errors, application errors, and system errors.

Applicable values:

Application
An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay.
Request
An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay.
System
Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.



outputSelector: none (not controlled by outputSelector)
errorMessage.error.domain string Conditionally Name of the domain in which the error occurred.
domain values:
Marketplace
A business or validation error occurred in the service.
SOA
An exception occurred in the Service Oriented Architecture (SOA) framework.


outputSelector: none (not controlled by outputSelector)
errorMessage.error.errorId long 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.

outputSelector: none (not controlled by outputSelector)
errorMessage.error.exceptionId token Conditionally Unique identifier for an exception associated with an error.

outputSelector: none (not controlled by outputSelector)
errorMessage.error.message string Conditionally A detailed description of the condition that caused in the error.

outputSelector: none (not controlled by outputSelector)
errorMessage.error.parameter ErrorParameter (string) Conditionally,
repeatable: [0..*]
Various 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.

outputSelector: none (not controlled by outputSelector)
errorMessage.error.parameter
  [ attribute name ]
string Conditionally Various 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.
errorMessage.error.severity ErrorSeverity Conditionally Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information on the cause.

If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, 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, re-send the request to eBay.

If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form.

If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem.

Applicable values:

Error
eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request.
Warning
The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this case, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.



outputSelector: none (not controlled by outputSelector)
errorMessage.error.subdomain string Conditionally Name of the subdomain in which the error occurred.
subdomain values:
Finding
The error is specific to the Finding service.
MarketplaceCommon
The error is common to all Marketplace services.


outputSelector: none (not controlled by outputSelector)
itemSearchURL anyURI Always A URL to view the search results on the eBay web site. The search results on the web site will use the same pagination as the API search results.

Note: eBay URLs returned in fields, such as viewItemURL, are subject to syntax and other changes without notice. To avoid problems in your application when eBay alters the URL format, we advise you to avoid parsing eBay URLs programmatically. We strive to ensure that other fields in the response contain all the information that is encoded in the URL, and more.

outputSelector: none (not controlled by outputSelector)
paginationOutput PaginationOutput Conditionally Indicates the pagination of the result set. Child elements indicate the page number that is returned, the maximum number of item listings to return per page, total number of pages that can be returned, and the total number of listings that match the search criteria.

outputSelector: none (not controlled by outputSelector)
paginationOutput
  .entriesPerPage
int Conditionally The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage.

The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field.
Min: 1. Max: 100.

outputSelector: none (not controlled by outputSelector)
paginationOutput.pageNumber int Conditionally The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of items matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of item data.

This returned value indicates the page number of item data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set.

The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number.
Min: 0. Max: 100.

outputSelector: none (not controlled by outputSelector)
paginationOutput.totalEntries int Conditionally The total number of items found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any items that match the search criteria.
Min: 0.

outputSelector: none (not controlled by outputSelector)
paginationOutput.totalPages int Conditionally The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any items that match the search criteria.
Min: 0.

outputSelector: none (not controlled by outputSelector)
searchResult SearchResult Always Container for the item listings that matched the search criteria. The data for each item is returned in individual containers, if any matches were found.

outputSelector: none (not controlled by outputSelector)
searchResult
  [ attribute count ]
int Always Container for the item listings that matched the search criteria. The data for each item is returned in individual containers, if any matches were found.
searchResult.item SearchItem Always,
repeatable: [1..*]
Container for the data of a single item that matches the search criteria.

outputSelector: none (not controlled by outputSelector)
searchResult.item.attribute ItemAttribute Conditionally,
repeatable: [0..*]
Contains a name/value pair defining an item attribute. Multiple attribute containers can be returned for an item.

outputSelector: none (not controlled by outputSelector)
searchResult.item.attribute
  .name
string Conditionally The name of an item attribute.

outputSelector: none (not controlled by outputSelector)
searchResult.item.attribute
  .value
string Conditionally The value of the item attribute identified by the name field.

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

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

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

outputSelector: none (not controlled by outputSelector)
searchResult.item.charityId string Conditionally A unique identification number assigned by eBay to a registered non-profit charity organization.

outputSelector: none (not controlled by outputSelector)

See GetCharities in the Trading API for information to retrieve details on a specific charity.

searchResult.item.condition Condition Conditionally Contains information about the item's condition. Only returned when the seller listed the item with an item condition.

Different categories can support different condition choices. If a listing is in two categories, the seller uses condition details that are supported in the primary category. Thus, even if two nearly identical items are found in the same category search, they could support different condition details if they have different primary categories. For example, suppose Seller A lists a concert T-shirt in clothing, and also in music accessories as the secondary category. Seller B lists an identical shirt in music accessories only. If you search against the music accessories category, you will find both items, but seller A's shirt may have condition details that are slightly different from seller B's shirt, because the listings have different primary categories.

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

In item results, this is only returned when the seller specified the item's condition using a structured format eBay recognizes (for example, conditionId or an older item specifics format).

When conditionId is also present: Most categories use the same display name for the same condition ID. Some categories may override the display name based on buyer expectations for items in the category. For example, condition ID 1000 could be called "New" in one category and "New with tags" in another. If an item is listed in two categories, the primary category controls the display name.

Behind the scenes, eBay's search engine uses the ID (not the display name) to determine whether items are new, used, or refurbished. So, if you need to normalize the conditions across categories (such as to group items by condition), it may be easier to use the ID and then show the varying display names for reference.

In condition histograms: If you search against a specific category and some items match based on their secondary category, the histogram only shows the display name if the secondary category supports the condition. (Condition IDs and names are dependent on the primary category.) However, the histogram shows the condition ID and item counts. This should only occur in a very small percent of results. Histograms may support display names in these cases later in 2011. As a workaround, you can fill in the missing name based on the "Item Condition IDs and Names" (link below) or based on the condition from an applicable item in the results.

For example, suppose a seller lists a concert T-shirt in a clothing category with the condition "New without tags" (1500), and also in a music accessories secondary category (where "New without tags" isn't a recognized condition). If you specify the music accessories category in your request, the condition ID (1500) is shown in the histogram, but not the display name. However, the display name is shown within the items.
Max length: 50.

outputSelector: none (not controlled by outputSelector)

See Item Condition IDs and Names for a list of display names and the typical meaning of each condition.

searchResult.item.condition
  .conditionId
int Conditionally The numeric ID (for example, 1000) for the item condition.

In item results, this is only returned when the seller listed the item with a condition ID. Some categories don't support or require condition IDs (for example, most Antiques categories don't). Also, until spring 2011, some GTC listings may define the item condition in item specifics instead, so no ID is returned.

If you specify Condition in itemFilter, the response returns items with the correctly matching condition(s), even if conditionId is not returned. For example, if you specify a value of "New" or "1000" in the item filter, the response only returns new items.
Min: 1000. Max: 7000.

outputSelector: none (not controlled by outputSelector)

See Item Condition IDs and Names for a list of display names and the typical meaning of each condition.

searchResult.item.country token Conditionally Two-letter ISO 3166 country code to indicate the country where the item is located (for example, "US" for the United States or "GB" for the United Kingdom).

outputSelector: none (not controlled by outputSelector)

See English country names and code elements for country names and corresponding ISO 3166 codes.

searchResult.item
  .discountPriceInfo
DiscountPriceInfo Conditionally Returns information on the item if it is listed as a Strikethrough Price (STP) or Minimum Advertised Price (MAP) item by the seller.

outputSelector: none (not controlled by outputSelector)

See Displaying Discount Pricing Information to Buyers.

searchResult.item
  .discountPriceInfo
  .minimumAdvertisedPriceExposure
MapExposureEnum Conditionally If pricingTreatment is MAP, the item price cannot be displayed directly on the page containing the item. When listing a MAP item, the seller stipulates how they want the buyer to view the price of the item by setting this field to either PreCheckout or DuringCheckout.

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

MAP items are supported only on the eBay US site.

Applicable values:

DuringCheckout
DuringCheckout specifies that the discounted price must be shown on the eBay checkout flow page.
PreCheckout
PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate page (or window) that displays the discount price.

searchResult.item
  .discountPriceInfo
  .originalRetailPrice
Amount (double) Conditionally This field contains the price to which a discounted-price display treatment is to be applied (for example, a strikethrough price). The discounted price of an item (specified in the currentPrice field) is the BIN price and is less than the originalRetailPrice of the item.
searchResult.item
  .discountPriceInfo
  .originalRetailPrice
  [ attribute currencyId ]
string Always This field contains the price to which a discounted-price display treatment is to be applied (for example, a strikethrough price). The discounted price of an item (specified in the currentPrice field) is the BIN price and is less than the originalRetailPrice of the item.
searchResult.item
  .discountPriceInfo
  .pricingTreatment
PriceTreatmentEnum Conditionally This field denotes whether or not an item qualifies for a discount pricing treatment display. If a seller lists an item with DiscountPriceInfo values, the item response container will include a DiscountPriceInfo container, and this field will be set to either STP, MAP, or None. If this field is set to MAP, you must abide by the rules for displaying MAP items, as described in minimumAdvertisedPriceExposure.

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

Applicable values:

MAP
MAP stands for Miminum Advertised Price.
STP
STP stands for Strike-Through Pricing.

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

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

In the event both soldOffEbay and soldOnEbay fields are set, soldOnEbay takes precedence.
searchResult.item.distance Distance (double) Conditionally The distance that the item is from the buyer, calculated using buyerPostalCode. The unit for distance varies by site, and is either miles or kilometers. If the country whose site you are searching uses kilometers to measure distance (for example, India/EBAY-IN), the unit is kilometers. If the site is either the US or UK, the distance unit is miles.

This value is only returned for distance-based searches. You must specify a buyerPostalCode and either sort by Distance, or use a combination of the MaxDistance LocalSearch itemFilters.

outputSelector: none (not controlled by outputSelector)
searchResult.item.distance
  [ attribute unit ]
string Conditionally The distance that the item is from the buyer, calculated using buyerPostalCode. The unit for distance varies by site, and is either miles or kilometers. If the country whose site you are searching uses kilometers to measure distance (for example, India/EBAY-IN), the unit is kilometers. If the site is either the US or UK, the distance unit is miles.

This value is only returned for distance-based searches. You must specify a buyerPostalCode and either sort by Distance, or use a combination of the MaxDistance LocalSearch itemFilters.
searchResult.item.eekStatus string Conditionally,
repeatable: [0..*]
Indicates the energy efficiency rating of the item. Energy efficiency ratings apply to products listed by commercial vendors in electronics categories only. Rating values are of the form A+++, A++, A+, A, B, C, D, E, F, or G. This field is only returned if the seller has specified the energy efficiency rating in the item specifics.

Applicable to the eBay Germany site (EBAY-DE) only.

outputSelector: none (not controlled by outputSelector)

See eBay Germany Legal Portal for more information about energy efficiency ratings and related EU regulations.

searchResult.item
  .galleryInfoContainer
GalleryInfoContainer Conditionally Contains three URLs for item thumbnail images in standard sizes. Not returned if the item has no images. That is, if the item was not listed using a product identifier and the seller has not uploaded images, the container will not be returned, even when the outputSelector is set to GalleryInfo.

outputSelector: GalleryInfo
searchResult.item
  .galleryInfoContainer
  .galleryURL
GalleryURL (anyURI) Always,
repeatable: [1..3]
URL for a single item image thumbnail of a specific size.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .galleryInfoContainer
  .galleryURL
  [ attribute gallerySize ]
GallerySizeEnum Conditionally URL for a single item image thumbnail of a specific size.

For a list of possible enumeration values, see GallerySizeEnum.
searchResult.item
  .galleryPlusPictureURL
anyURI Conditionally,
repeatable: [0..*]
URL for the Gallery Plus image. The size of Gallery Plus images (up to 500 pixels on the longest side) is bigger than the size of standard gallery images. In site search results, you can view the Gallery Plus image by hovering over or clicking the Enlarge link or magnifying glass icon. This field is only returned when the seller has opted for the Gallery Plus option for the given item.

outputSelector: none (not controlled by outputSelector)
searchResult.item.galleryURL anyURI Conditionally URL for the Gallery thumbnail image. Returned only if the seller uploaded images for the item or the item was listed using a product identifier.

outputSelector: none (not controlled by outputSelector)
searchResult.item.globalId token Always The identifier for the site on which the item is listed. Returns a Global ID, which is a unique identifier that specifies the combination of the site, language, and territory. In other eBay APIs (such as the Shopping API), this value is know as the site ID.

outputSelector: none (not controlled by outputSelector)

See Global ID Values for a list of possible enumeration values and how they map to eBay sites.

searchResult.item
  .isMultiVariationListing
boolean Conditionally Returns true if the item is a multi-variation listing.

outputSelector: GalleryInfo
searchResult.item.itemId string Always The ID that uniquely identifies the item listing. eBay generates this ID when an item is listed. ID values are unique across all eBay sites.
Max length: 19 (normally, item IDs are 9 to 12 digits in length).

outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo ListingInfo Conditionally The format type of the listing, such as online auction, fixed price, or advertisement.

outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo
  .bestOfferEnabled
boolean Conditionally Shows whether or not the seller will accept a best offer for the associated item. Best Offer allows a buyer to make a lower-priced binding offer on a fixed price item. Buyers cannot 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.

outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo
  .buyItNowAvailable
boolean Conditionally Applies only to auction listings that were listed with a Buy It Now price. Buy It Now lets a user purchase the item at a fixed price, effectively ending the auction. On most sites, the Buy It Now option is removed (and this value returns false) once a valid bid is made on the associated item (a valid bid could be a bid above the reserve price).

buyItNowAvailable will return "false" if the listing type is anything but "AuctionWithBIN". Please ignore buyItNowAvailable for fixed-price listings.

outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo
  .buyItNowPrice
Amount (double) Conditionally The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed. You can use this field to determine if the item was originally listed with Buy It Now, even if the Buy It Now option is no longer available for the item.

For Basic Fixed-Price (FixedPrice), Ad Format (AdFormat), and Classified Ad (Classified) listings, currentPrice is the current fixed price.

Only returned if an item was listed with Buy It Now.

outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo
  .buyItNowPrice
  [ attribute currencyId ]
string Always The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed. You can use this field to determine if the item was originally listed with Buy It Now, even if the Buy It Now option is no longer available for the item.

For Basic Fixed-Price (FixedPrice), Ad Format (AdFormat), and Classified Ad (Classified) listings, currentPrice is the current fixed price.

Only returned if an item was listed with Buy It Now.
searchResult.item.listingInfo
  .convertedBuyItNowPrice
Amount (double) Conditionally The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent your search request. For active items, refresh this value every 24 hours to pick up changes in conversion rates (if this value has been converted).

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.

Only returned if an item was listed with Buy It Now.

outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo
  .convertedBuyItNowPrice
  [ attribute currencyId ]
string Always The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent your search request. For active items, refresh this value every 24 hours to pick up changes in conversion rates (if this value has been converted).

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.

Only returned if an item was listed with Buy It Now.
searchResult.item.listingInfo
  .endTime
dateTime Conditionally Time stamp specifying when the listing is scheduled to end, or the actual end time if the item listing has ended. This value is returned in GMT, the ISO 8601 date and time format (YYYY-MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.

Note: For items that are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. This difference in time is intended to facilitate the renewal of these items' end times (which occurs every 30 days).

outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo
  .gift
boolean Conditionally If true, a generic gift icon displays next the listing's title in search and browse pages.

outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo
  .listingType
token Conditionally The format of the listing, such as online auction, fixed price, or advertisement.
listingType values:
AdFormat
Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay and eBay Feedback is not available for ad format listings.
Auction
Competitive-bid online auction format. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no valid bids have been placed. Online auctions are listed on eBay.com; they can also be listed in a seller's eBay Store if the seller is a Store owner.
AuctionWithBIN
Same as Auction format, but Buy It Now is enabled. AuctionWithBIN changes to Auction if a valid bid has been placed on the item. Valid bids include bids that are equal to or above any specified reserve price.
Classified
Classified Ads connect buyers and sellers, who then complete the sale outside of eBay. This format does not enable buyers and sellers to transact online through eBay and eBay Feedback is not available for these listing types.
FixedPrice
A fixed-price listing. Auction-style bidding is not allowed. On some sites, this auction format is also known as "Buy It Now Only" (not to be confused with the Buy It Now option available with competitive- bidding auctions). Fixed-price listings appear on eBay.com; they can also be listed in a seller's eBay Store if the seller is a Store owner.


outputSelector: none (not controlled by outputSelector)
searchResult.item.listingInfo
  .startTime
dateTime Conditionally Time stamp that eBay recorded as the moment the listing was made available. This value is returned in GMT, the ISO 8601 date and time format (YYYY-MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. Note that it is possible for startTime to be different from the value returned by GetSingleItem.

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

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .paymentMethod
token Conditionally,
repeatable: [0..*]
Identifies the payment method (or methods) the seller will accept for the item (such as PayPal).

Note: If the seller accepts only 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 listing formats.

outputSelector: none (not controlled by outputSelector)

See BuyerPaymentMethodCodeType in the Shopping API for a complete list of possible paymentMethod response values.

searchResult.item
  .pictureURLLarge
anyURI Conditionally URL to a picture of the item that is 400x400 pixels in size.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .pictureURLSuperSize
anyURI Conditionally URL to a picture of the item that is 800x800 pixels in size.

outputSelector: none (not controlled by outputSelector)
searchResult.item.postalCode string Conditionally The postal code where the listed item is located. This field is returned only if a postal code has been specified by the seller. eBay proximity and local search behavior can use the combination of buyerPostalCode and postalCode values.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .primaryCategory
Category Always Details about the first (or only) category in which the item is listed. Note that items can be listed in more than a single category.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .primaryCategory.categoryId
string Always The unique ID of a category on the specified eBay site.
Max length: 10.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .primaryCategory.categoryName
string Always Display name of a category as it appears on the eBay Web site.
Max length: 30.

outputSelector: none (not controlled by outputSelector)
searchResult.item.productId ProductId (string) Conditionally Unique identifier for the eBay catalog product with which the item was listed. An eBay catalog product consists of pre-filled Item Specifics, additional descriptive information, plus a stock photo (if available). These product details are used to pre-fill item information, which is used to describe the item and can also help surface the item in searches.

eBay supports the following types of product ID types: ISBN, UPC, EAN, and ReferenceID (ePID, also known as an eBay Product Reference ID). ReferenceID values are returned when available. A UPC, ISBN, or EAN product identifier will be returned only when a ReferenceID is not available.

This productId value can be used as input with findItemsByProduct to retrieve items that were listed with the specified eBay catalog product.

This field is only returned when a product was used to list the item.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .returnsAccepted
boolean Conditionally This is set to true if the seller accepts return of the item.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .secondaryCategory
Category Conditionally Details about the second category in which the item is listed. This element is not returned if the seller did not specify a secondary category.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .secondaryCategory.categoryId
string Conditionally The unique ID of a category on the specified eBay site.
Max length: 10.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .secondaryCategory
  .categoryName
string Conditionally Display name of a category as it appears on the eBay Web site.
Max length: 30.

outputSelector: none (not controlled by outputSelector)
searchResult.item.sellerInfo SellerInfo Conditionally Information about the item's seller. Only returned if SellerInfo is specified in the outputSelector field in the request.

outputSelector: SellerInfo
searchResult.item.sellerInfo
  .feedbackRatingStar
token Conditionally Visual indicator of user's feedback score.
feedbackRatingStar values:
None
No graphic displayed, feedback score 0-9.
Yellow
Yellow Star, feedback score 10-49.
Blue
Blue Star, feedback score 50-99.
Turquoise
Turquoise Star, feedback score 100-499.
Purple
Purple Star, feedback score 500-999.
Red
Red Star, feedback score 1,000-4,999.
Green
Green Star, feedback score 5,000-9,999.
YellowShooting
Yellow Shooting Star, feedback score 10,000-24,999.
TurquoiseShooting
Turquoise Shooting Star, feedback score 25,000-49,999.
PurpleShooting
Purple Shooting Star, feedback score 50,000-99,999.
RedShooting
Red Shooting Star, feedback score 100,000-499,000 and above.
GreenShooting
Green Shooting Star, feedback score 500,000-999,000 and above.
SilverShooting
Silver Shooting Star, feedback score 1,000,000 or more.


outputSelector: SellerInfo
searchResult.item.sellerInfo
  .feedbackScore
long Conditionally The aggregate feedback score of the seller. A seller's feedback score is their net positive feedback minus their net negative feedback. Feedback scores are a quantitative expression of the desirability of dealing with a seller in a transaction.

outputSelector: SellerInfo
searchResult.item.sellerInfo
  .positiveFeedbackPercent
double Conditionally The percentage value of a user's positive feedback (their positive feedbackScore divided by their total positive plus negative feedback).

outputSelector: SellerInfo
searchResult.item.sellerInfo
  .sellerUserName
string Conditionally The seller's eBay user name; a unique value.

outputSelector: SellerInfo
searchResult.item.sellerInfo
  .topRatedSeller
boolean Conditionally Indicates whether the seller of the item is top rated. A Top Rated Seller:
  • Consistently receives highest buyers' ratings
  • Ships items quickly
  • Has earned a track record of excellent service
eBay regularly reviews the performance of these sellers to confirm that they continue to meet the program's requirements.

outputSelector: SellerInfo

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

searchResult.item
  .sellingStatus
SellingStatus Conditionally Specifies the item's selling status with regards to eBay's processing workflow.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .sellingStatus.bidCount
int Conditionally The number of bids that have been placed on the item.
Min: 0.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .sellingStatus
  .convertedCurrentPrice
Amount (double) Conditionally The listing's current price converted to the currency of the site specified in the find request (globalId).

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .sellingStatus
  .convertedCurrentPrice
  [ attribute currencyId ]
string Always The listing's current price converted to the currency of the site specified in the find request (globalId).
searchResult.item
  .sellingStatus.currentPrice
Amount (double) Conditionally The current price of the item given in the currency of the site on which the item is listed. That is, currentPrice is returned in the original listing currency.

For competitive-bid item listings, currentPrice is the current minimum bid price if the listing has no bids, or the current high bid if the listing has bids. A Buy It Now price has no effect on currentPrice.

For Basic Fixed-Price (FixedPrice), Ad Format (AdFormat), and Classified Ad (Classified) listings, currentPrice is the current fixed price.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .sellingStatus.currentPrice
  [ attribute currencyId ]
string Always The current price of the item given in the currency of the site on which the item is listed. That is, currentPrice is returned in the original listing currency.

For competitive-bid item listings, currentPrice is the current minimum bid price if the listing has no bids, or the current high bid if the listing has bids. A Buy It Now price has no effect on currentPrice.

For Basic Fixed-Price (FixedPrice), Ad Format (AdFormat), and Classified Ad (Classified) listings, currentPrice is the current fixed price.
searchResult.item
  .sellingStatus.sellingState
token Conditionally Specifies the listing's status in eBay's processing workflow. If an item's EndTime is in the past, but there are no details about the buyer or high bidder (and the user is not anonymous), you can use sellingState information to determine whether eBay has finished processing the listing.
sellingState values:
Active
The listing is still live. It is also possible that the auction has recently ended, but eBay has not completed the final processing (for example, the high bidder is still being determined).
Canceled
The listing has been canceled by either the seller or eBay.
Ended
The listing has ended and eBay has completed the processing of the sale (if any).
EndedWithSales
The listing has been ended with sales.
EndedWithoutSales
The listing has been ended without sales.


outputSelector: none (not controlled by outputSelector)
searchResult.item
  .sellingStatus.timeLeft
duration Conditionally Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). For listings that have ended, the time left is PT0S (zero seconds). See the "duration" type for information about this time format.

outputSelector: none (not controlled by outputSelector)
searchResult.item.shippingInfo ShippingInfo Conditionally Container for data about a listing's shipping details.

outputSelector: none (not controlled by outputSelector)
searchResult.item.shippingInfo
  .expeditedShipping
boolean Conditionally This is returned set to true if expedited shipping is available for the item.

This field is returned only for items listed on the eBay US site.

outputSelector: none (not controlled by outputSelector)
searchResult.item.shippingInfo
  .handlingTime
int Conditionally The number of days it will take the seller to ship this item.

This field is returned only for items listed on the eBay US site.

outputSelector: none (not controlled by outputSelector)
searchResult.item.shippingInfo
  .oneDayShippingAvailable
boolean Conditionally This is returned set to true if one-day shipping is available for the item.

This field is returned only for items listed on the eBay US site.

outputSelector: none (not controlled by outputSelector)
searchResult.item.shippingInfo
  .shippingServiceCost
Amount (double) Conditionally The basic shipping cost of the item. This reflects the domestic shipping cost or the international shipping costs, depending on which applies (that is, whether the bidder/buyer is in the same country as the listing site of the item).

outputSelector: none (not controlled by outputSelector)
searchResult.item.shippingInfo
  .shippingServiceCost
  [ attribute currencyId ]
string Always The basic shipping cost of the item. This reflects the domestic shipping cost or the international shipping costs, depending on which applies (that is, whether the bidder/buyer is in the same country as the listing site of the item).
searchResult.item.shippingInfo
  .shippingType
token Conditionally The shipping method that was used for determining the cost of shipping. For example: flat rate, calculated, or free. The seller specifies the available shipping services when they list the item.
shippingType values:
Calculated
The calculated shipping model: The posted cost of shipping is based on the buyer-selected shipping service, chosen by the buyer from the different shipping services offered by the seller. The shipping costs are calculated by eBay and the shipping carrier, based on the buyer's address. Any packaging and handling costs established by the seller are automatically rolled into the total.
CalculatedDomesticFlatInternational
The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.
Flat
The flat-rate shipping model: The seller establishes the cost of shipping and any shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.
FlatDomesticCalculatedInternational
The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.
Free
Free is used when the seller has declared that shipping is free for the buyer.
FreePickup
No shipping available, the buyer must pick up the item from the seller.
Freight
The freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the buyer's address (postal code).
FreightFlat
The flat rate shipping model: the seller establishes the cost of freight shipping and freight insurance, regardless of what any buyer-selected shipping service might charge the seller.
NotSpecified
The seller did not specify the shipping type.
Note: The international leg of the Global Shipping Program is always considered to be a calculated shipping type, and it is entirely the responsibility of the international shipping provider. If Global Shipping is available for an item, and the seller chooses to provide the Flat shipping type domestically for that item, this field will return a value of FlatDomesticCalculatedInternational to account for both legs of the shipment. If the seller offers the item with Calculated domestic shipping, this field will return a value of Calculated, which also accounts for both legs of the shipment. For a purely domestic shipment, you can ignore the information about the international leg.

outputSelector: none (not controlled by outputSelector)
searchResult.item.shippingInfo
  .shipToLocations
string Conditionally,
repeatable: [0..*]
An international location or region to which the seller is willing to ship the item. Only returned when the seller has specifically identified locations where she is willing to ship the given item. specified.

outputSelector: none (not controlled by outputSelector)

See shipToLocations for a complete list of shipping locations.

searchResult.item.storeInfo Storefront Conditionally Information about the eBay store in which the item is listed. Only returned if the item is listed in a store and StoreInfo is specified in the outputSelector field in the request.

outputSelector: StoreInfo
searchResult.item.storeInfo
  .storeName
string Conditionally The name of the seller's eBay Store.
Max length: 200.

outputSelector: StoreInfo
searchResult.item.storeInfo
  .storeURL
anyURI Conditionally The URL of the seller's eBay Store page.

outputSelector: StoreInfo
searchResult.item.subtitle string Conditionally Subtitle of the item. Only returned if the seller included a subtitle for the listing.

outputSelector: none (not controlled by outputSelector)
searchResult.item.title string Conditionally Name of the item as it appears in the listing title, or in search and browse results.

outputSelector: none (not controlled by outputSelector)
searchResult.item
  .topRatedListing
boolean Conditionally Indicates whether the item listing is a Top-Rated Plus listing. A Top-Rated Plus listing must meet the following requirements:
  • 14-day (or longer) return policy with Money Back option
  • 1-day Handling Time or better
  • Listed by a Top-Rated Seller
This field is returned only for the US (EBAY-US) site.

outputSelector: none (not controlled by outputSelector)

See eBay Top Rated Plus page for more information about Top-Rated Plus listings.

searchResult.item.unitPrice UnitPriceInfo Conditionally Contains information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the UnitInfo data and the item's listed price to calculate and display the per-unit price on eBay EU sites.

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

outputSelector: UnitPriceInfo
searchResult.item.unitPrice
  .quantity
double Conditionally Number of units of size, weight, volume or count of the specified unit type for the item. eBay divides the item price by this number to get the price per unit to be displayed in the item listing for comparison purposes.

outputSelector: UnitPriceInfo
searchResult.item.unitPrice
  .type
string Conditionally Designation of size, weight, volume or count to be used to specify the unit quantity of the item. This value can be one of the following:

 Kg 100g 10g L 100ml 10ml M M2 M3 Unit 


outputSelector: UnitPriceInfo
searchResult.item.viewItemURL anyURI Conditionally The URL to view this specific listing on eBay.

The returned URL is optimized to support natural search. That is, the URL is designed to make items on eBay easier to find via popular internet search engines. The URL includes the item title along with other optimizations.

If you enabled affiliate tracking in the call, viewItemURL contains a string that includes affiliate tracking information.

Note: eBay URLs returned in fields, such as viewItemURL, are subject to syntax and other changes without notice. To avoid problems in your application when eBay alters the URL format, we advise you to avoid parsing eBay URLs programmatically. We strive to ensure that other fields in the response contain all the information that is encoded in the URL, and more.

outputSelector: none (not controlled by outputSelector)

See eBay Partner Network for more information.

timestamp dateTime Always This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.

outputSelector: none (not controlled by outputSelector)
version string Always The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site.

outputSelector: none (not controlled by outputSelector)



Back to top

Detail Controls


DetailLevel

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


outputSelector

The outputSelector input field gives you control over which call-specific output fields may be returned from your queries. outputSelector 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 outputSelector.)

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

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

Output Field none AspectHistogram ConditionHistogram GalleryInfo SellerInfo StoreInfo UnitPriceInfo
ackY------
aspectHistogramContainer-(Y)-----
aspectHistogramContainer.aspect-(Y)-----
aspectHistogramContainer.aspect.valueHistogram-(Y)-----
aspectHistogramContainer.aspect.valueHistogram.count-(Y)-----
aspectHistogramContainer.domainDisplayName-(Y)-----
aspectHistogramContainer.domainName-(Y)-----
conditionHistogramContainer--(Y)----
conditionHistogramContainer.conditionHistogram--(Y)----
conditionHistogramContainer.conditionHistogram.condition--(Y)----
conditionHistogramContainer.conditionHistogram.condition
  .conditionDisplayName
(Y)------
conditionHistogramContainer.conditionHistogram.condition
  .conditionId
(Y)-(Y)----
conditionHistogramContainer.conditionHistogram.count--(Y)----
errorMessage(Y)------
errorMessage.error(Y)------
errorMessage.error.category(Y)------
errorMessage.error.domain(Y)------
errorMessage.error.errorId(Y)------
errorMessage.error.exceptionId(Y)------
errorMessage.error.message(Y)------
errorMessage.error.parameter(Y)------
errorMessage.error.severity(Y)------
errorMessage.error.subdomain(Y)------
itemSearchURLY------
paginationOutput(Y)------
paginationOutput.entriesPerPage(Y)------
paginationOutput.pageNumber(Y)------
paginationOutput.totalEntries(Y)------
paginationOutput.totalPages(Y)------
searchResultY------
searchResult.itemY------
searchResult.item.attribute(Y)------
searchResult.item.attribute.name(Y)------
searchResult.item.attribute.value(Y)------
searchResult.item.autoPayY------
searchResult.item.charityId(Y)------
searchResult.item.condition(Y)------
searchResult.item.condition.conditionDisplayName(Y)------
searchResult.item.condition.conditionId(Y)-(Y)----
searchResult.item.country(Y)------
searchResult.item.discountPriceInfo(Y)------
searchResult.item.distance(Y)------
searchResult.item.eekStatus(Y)------
searchResult.item.galleryInfoContainer---(Y)---
searchResult.item.galleryInfoContainer.galleryURLY------
searchResult.item.galleryPlusPictureURL(Y)------
searchResult.item.galleryURL(Y)------
searchResult.item.globalIdY------
searchResult.item.isMultiVariationListing---(Y)---
searchResult.item.itemIdY------
searchResult.item.listingInfo(Y)------
searchResult.item.listingInfo.bestOfferEnabled(Y)------
searchResult.item.listingInfo.buyItNowAvailable(Y)------
searchResult.item.listingInfo.buyItNowPrice(Y)------
searchResult.item.listingInfo.convertedBuyItNowPrice(Y)------
searchResult.item.listingInfo.endTime(Y)------
searchResult.item.listingInfo.gift(Y)------
searchResult.item.listingInfo.listingType(Y)------
searchResult.item.listingInfo.startTime(Y)------
searchResult.item.location(Y)------
searchResult.item.paymentMethod(Y)------
searchResult.item.pictureURLLarge(Y)------
searchResult.item.pictureURLSuperSize(Y)------
searchResult.item.postalCode(Y)------
searchResult.item.primaryCategoryY------
searchResult.item.primaryCategory.categoryIdY------
searchResult.item.primaryCategory.categoryNameY------
searchResult.item.productId(Y)------
searchResult.item.returnsAccepted(Y)------
searchResult.item.secondaryCategory(Y)------
searchResult.item.secondaryCategory.categoryId(Y)------
searchResult.item.secondaryCategory.categoryName(Y)------
searchResult.item.sellerInfo----(Y)--
searchResult.item.sellerInfo.feedbackRatingStar----(Y)--
searchResult.item.sellerInfo.feedbackScore----(Y)--
searchResult.item.sellerInfo.positiveFeedbackPercent----(Y)--
searchResult.item.sellerInfo.sellerUserName----(Y)--
searchResult.item.sellerInfo.topRatedSeller----(Y)--
searchResult.item.sellingStatus(Y)------
searchResult.item.sellingStatus.bidCount(Y)------
searchResult.item.sellingStatus.convertedCurrentPrice(Y)------
searchResult.item.sellingStatus.currentPrice(Y)------
searchResult.item.sellingStatus.sellingState(Y)------
searchResult.item.sellingStatus.timeLeft(Y)------
searchResult.item.shippingInfo(Y)------
searchResult.item.shippingInfo.expeditedShipping(Y)------
searchResult.item.shippingInfo.handlingTime(Y)------
searchResult.item.shippingInfo.oneDayShippingAvailable(Y)------
searchResult.item.shippingInfo.shippingServiceCost(Y)------
searchResult.item.shippingInfo.shippingType(Y)------
searchResult.item.shippingInfo.shipToLocations(Y)------
searchResult.item.storeInfo-----(Y)-
searchResult.item.storeInfo.storeName-----(Y)-
searchResult.item.storeInfo.storeURL-----(Y)-
searchResult.item.subtitle(Y)------
searchResult.item.title(Y)------
searchResult.item.topRatedListing(Y)------
searchResult.item.unitPrice------(Y)
searchResult.item.unitPrice.quantity------(Y)
searchResult.item.unitPrice.type------(Y)
searchResult.item.viewItemURL(Y)------
timestampY------
versionY------

Back to top

Samples

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

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

Sample: Basic Call

Retrieves a set of items based on the product type and value you provide. Product types can be ISBN, UPC, EAN, or ReferenceID (eBay Product Reference ID, or ePID).

Description

The user wants to search for a specific book by the eBay Product Reference ID number (ReferenceID).

Input

Like the other types of products on which you can make queries, the value of the associated product type (here, the ePID number) must be known before you can make the request.

Note: In the Finding Service, to specify an element parameter in a URL request, you must proceed the parameter with an "@" sign. For example, to specify a product ID type, use the following syntax:

&productId.@type=ReferenceID

Note: URL samples have been wrapped for readability. To run the samples, undo the line wrapping and insert your own SECURITY-APPNAME.

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://svcs.ebay.com/services/search/FindingService/v1?
   OPERATION-NAME=findItemsByProduct&
   SERVICE-VERSION=1.0.0&
   SECURITY-APPNAME=YourAppID&
   RESPONSE-DATA-FORMAT=XML&
   REST-PAYLOAD&
   paginationInput.entriesPerPage=2&
   productId.@type=ReferenceID&
   productId=53039031

   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"?>
<findItemsByProductRequest xmlns="http://www.ebay.com/marketplace/search/v1/services">
  <productId type="ReferenceID">53039031</productId>
  <paginationInput>
    <entriesPerPage>2</entriesPerPage>
  </paginationInput>
</findItemsByProductRequest>

Output

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

<?xml version="1.0" encoding="utf-8"?>
<findItemsByProductResponse xmlns:ms="http://www.ebay.com/marketplace/services"
xmlns="http://www.ebay.com/marketplace/search/v1/services">
   <ack>Success</ack>
   <version>1.0.0</version>
   <timestamp>2009-09-10T00:54:12.443Z</timestamp>
   <searchResult count="2">
      <item>
         <itemId>180404288689</itemId>
         <title>The Little Mermaid DVD Disney Platinum Special Edition</title>
         <globalId>EBAY-US</globalId>
         <primaryCategory>
            <categoryId>617</categoryId>
            <categoryName>DVD, HD DVD & Blu-ray</categoryName>
         </primaryCategory>
         <galleryURL>
         http://thumbs2.ebaystatic.com/pict/1804042886898080_1.jpg</galleryURL>
         <viewItemURL>http://cgi.ebay.com/The-Little-Mermaid-DVD-Disney-Platinum-Special-
         Edition_W0QQitemZ180404288689QQcmdZViewItemQQptZUS_DVD_HD_DVD_Blu_ray?hash=
         item2a00eefcb1</viewItemURL>
         <productId type="ReferenceID">53039031</productId>
         <paymentMethod>PayPal</paymentMethod>
         <autoPay>false</autoPay>
         <postalCode>19135</postalCode>
         <location>Philadelphia,PA,USA</location>
         <country>US</country>
         <shippingInfo>
            <shippingServiceCost currencyId="USD">0.0</shippingServiceCost>
            <shippingType>Free</shippingType>
            <shipToLocations>US</shipToLocations>
         </shippingInfo>
         <sellingStatus>
            <currentPrice currencyId="USD">15.5</currentPrice>
            <convertedCurrentPrice currencyId="USD">15.5</convertedCurrentPrice>
            <bidCount>4</bidCount>
            <sellingState>Active</sellingState>
            <timeLeft>P0DT2H59M5S</timeLeft>
         </sellingStatus>
         <listingInfo>
            <bestOfferEnabled>false</bestOfferEnabled>
            <buyItNowAvailable>false</buyItNowAvailable>
            <startTime>2009-09-05T03:53:17.000Z</startTime>
            <endTime>2009-09-10T03:53:17.000Z</endTime>
            <listingType>Auction</listingType>
            <gift>false</gift>
         </listingInfo>
      </item>
      <item>
         <itemId>310166249754</itemId>
         <title>SEALED WALT DISNEY THE LITTLE MERMAID PLATINUM EDITION</title>
         <globalId>EBAY-US</globalId>
         <primaryCategory>
            <categoryId>617</categoryId>
            <categoryName>DVD, HD DVD & Blu-ray</categoryName>
         </primaryCategory>
         <galleryURL>
         http://thumbs1.ebaystatic.com/pict/3101662497548080_1.jpg</galleryURL>
         <viewItemURL>http://cgi.ebay.com/SEALED-WALT-DISNEY-THE-LITTLE-MERMAID-PLATINUM-
         EDITION_W0QQitemZ310166249754QQcmdZViewItemQQptZUS_DVD_HD_DVD_Blu_ray?hash=
         item483759611a</viewItemURL>
         <productId type="ReferenceID">53039031</productId>
         <paymentMethod>PayPal</paymentMethod>
         <autoPay>false</autoPay>
         <location>USA</location>
         <country>US</country>
         <shippingInfo>
            <shippingServiceCost currencyId="USD">0.0</shippingServiceCost>
            <shippingType>Free</shippingType>
            <shipToLocations>US</shipToLocations>
         </shippingInfo>
         <sellingStatus>
            <currentPrice currencyId="USD">13.5</currentPrice>
            <convertedCurrentPrice currencyId="USD">13.5</convertedCurrentPrice>
            <bidCount>8</bidCount>
            <sellingState>Active</sellingState>
            <timeLeft>P0DT23H42M34S</timeLeft>
         </sellingStatus>
         <listingInfo>
            <bestOfferEnabled>false</bestOfferEnabled>
            <buyItNowAvailable>false</buyItNowAvailable>
            <startTime>2009-09-04T00:36:46.000Z</startTime>
            <endTime>2009-09-11T00:36:46.000Z</endTime>
            <listingType>Auction</listingType>
            <gift>false</gift>
         </listingInfo>
      </item>
   </searchResult>
   <paginationOutput>
      <totalPages>50</totalPages>
      <totalEntries>99</totalEntries>
      <pageNumber>1</pageNumber>
      <entriesPerPage>2</entriesPerPage>
   </paginationOutput>
</findItemsByProductResponse>



Back to top

Change History

Version Description
1.13.0
10/21/2014
  • eekStatus (added): Indicates the energy efficiency rating of the item. Note This is currently applicable only for the DE-Germany site.
1.12.0
05/16/2012
  • topRatedListing (doc change): In the call reference documentation, topRatedListing had appeared erroneously under searchResult.item.sellerInfo. It now appears in its correct location under searchResult.item, with an updated description.
  • unitPrice (doc change): In the call reference documentation, unitPrice had appeared erroneously under searchResult.item.sellerInfo. It now appears in its correct location under searchResult.item, with an updated description. The unitPrice container and its child fields, quantity and type, are returned only if the value of outputSelector is UnitPriceInfo.
  • shippingInfo (doc change): Three shippingInfo fields (expeditedShipping, handlingTime and oneDayShippingAvailable) are returned only for items listed on the eBay US site. This was not previously made clear in the field descriptions.
  • itemFilter (doc change): Descriptions of this container and its fields have been clarified. The itemFilter container provides the specifications for limiting the number of items returned by a find request. Use itemFilter to specify name/value pairs. The itemFilter.name field (ItemFilterType) provides the names of filters that can be used to limit the number of items returned by a find request. Must be accompanied by a corresponding itemFilter.value field. See the ItemFilterType reference page for descriptions of the available filters.
  • OutputSelector, aspectFilter (doc change): Added this note to the outputSelector.AspectHistogram enum and aspectFilter field descriptions: If a call that specifies an outputSelector value of AspectHistogram returns aspectHistogramContainer.domainName, this is a sign that aspect histogram data might not be returned if you also specify an aspectFilter in the next call. To ensure that aspect histogram data is returned for the next call, add a domainFilter to the call as well.
1.11.0
06/08/2011
  • outputSelector.PictureURLSuperSize (added): Added two enums to outputSelector (PictureURLLarge and PictureURLSuperSize) that specify whether or not you want to return URLs to large images of the item.
  • searchResult.isMultiVariationListing (added): Added a return field that shows whether or not the item is a multi-variation listing.
  • affiliate.geoTargeting (added): Added the ability to determine whether or not to return a roverized lgeo affiliate link.
  • searchResult.DiscountPriceInfo (added): Added the ability to retrieve discount pricing values (DiscountPricingInfo) for an item, which gives the item either a Strike-Through Pricing (STP) or Minimum Advertised Price (MAP) display treatment. This feature is available to qualified sellers (and their associated developers) who participate in the Discount Pricing program. Once qualified, sellers can apply Discount Pricing to both MSKU and Non-MSKU items. STP is available on the US, UK, and DE sites while MAP is available only on the US site.
  • ItemFilter.name.LocatedIn (modified): Modified allowed filter values to include WorldWide, North America, and European.
  • .name.AvailableTo, ItemFilter.name.LocatedIn (modified): AvailableTo and LocatedIn filters can now be used together in the same request.
1.10.0
02/16/2011
  • outputSelector.GalleryInfo (added): When the GalleryInfo outputSelector is specified in the request, each item in the response includes an array of thumbnail images for the item in different sizes.
  • searchResult.item.galleryInfoContainer (added): Contains an array of thumbnail images for the item in different sizes.
  • outputSelector (modified): ConditionHistogram is now supported for most sites.
  • conditionHistogramContainer (added): Returns the distribution of relevant items based on their condition (e.g., the number of items that are new vs. used).
1.9.0
12/08/2010
  • itemFilter.name.ValueBoxInventory (added): Item filter for restricting search results to only items that meet value box criteria.
  • itemFilter.name.ExpeditedShippingType (added): Item filter for restricting search results to only items for which the seller provides Expedited or one-day shipping.
  • itemFilter.name.ListedIn (added): Item filter for restricting search results to only items that were originally listed in the specified site.
  • itemFilter.name.MaxHandlingTime (added): Item filter for restricting search results to only items that meet the specified maximum handling time before the seller ships.
  • itemFilter.name.ReturnsAcceptedOnly (added): Item filter for restricting search results to only items that can be returned to the seller.
  • SearchItem.returnsAccepted (added): Set to true if this item can be returned to the seller.
  • ShippingInfo.expeditedShipping (added): Set to true if this item can be shipped by expedited shipping.
  • ShippingInfo.oneDayShippingAvailable (added): Set to true if this item can be shipped by one-day shipping.
  • ShippingInfo.handlingTime (added): The number of days the seller takes to ship this item.
1.5.0
06/09/2010
  • itemFilter.name.Condition (modified): Modified the allowed filter values to include condition IDs.
  • Item.Condition (added): Returns the item's condition ID and condition display name, if any.
1.4.0
04/14/2010
  • ItemFilterType values (added): New filters (BestOfferOnly, ExcludeCategory, ModTimeFrom) to control search results.
  • SortOrderType values (added): New ways to sort search results, based on item bid counts (BidCountFewest, BidCountMost) or item location (CountryAscending, CountryDescending).
1.1.0
11/11/2009
  • searchResult.item.galleryPlusPictureURL (added): Image URL for items listed with Gallery Plus upgrade.
  • itemFilter.name.SellerBusinessType (doc change): Corrected the allowed filter values to include Business and Private only.
  • itemFilter.name.Condition (doc change): Corrected the allowed filter values to include Unspecified.
1.0.1
09/29/2009
  • itemFilter.name.TopRatedSellerOnly (added): New item filter to limit search results to items listed by Top-rated Sellers only.
  • searchResult.item.sellerInfo.topRatedSeller (added): Indicates whether or not the seller is a Top-rated Seller.
1.0.0
06/24/2009
  • (added) New call.

Back to top

User-Contributed Notes