Detail Controls

Checks specified keywords for spelling errors and returns corrected keywords that will provide better search results. If you make a keyword query search that returns no results, use this call to check the keywords for misspellings. The call checks the words in context of the entire query. For example, if you submit "arry potter" in the request, the response will recommend "harry potter." However, if you submit "potter arry" in the request, the response will recommend "potter army." The response will not return recommended keywords in the following conditions: <ul> <li> Keywords value returns results (even a single item) in either findItemsByKeywords or findItemsAdvanced. </li> <li> Keywords value contains no misspelled words (even if the keywords query returns no items). </li> </ul>

Checks specified keywords and returns correctly spelled keywords for best search results.

findItemsAdvanced,findItemsByKeywords,findItemsIneBayStores samples Specify one or more words to use in a search query for finding items on eBay. It is best to include the complete keywords value, as words are checked in context with each other. If you are using a URL request and your keyword query consists of multiple words, use < code>%20</code> to separate the words (for example, <code>arry%20Potter</code>). Submitted keywords are not case sensitive. Keyword recommendations will not be returned if the submitted keywords are accepted standard spellings for item listings. For example, no recommended keywords are returned for "nrfb" (Never Removed From Box) even if the keywords query does not return any search results, because this is an accepted listing term. If no correct spelling can be identified for submitted keywords (such as <code>aabbccdd</code>), no recommended keywords are returned, even though the keyword is obviously not a word and will not return search results. 350. The maximum length for a single word is 98 getSearchKeywordsRecommendation Yes Response container for the spelling check and correction for keywords. Contains a spell-checked version of the submitted keywords. If no recommended spelling can be identified for the submitted keywords, the response contains a warning to that effect and an empty keywords field is returned. 350 getSearchKeywordsRecommendation Always Searches for items based on a keyword query and returns details for matching items. Item filters can be used to restrict search results. Aspect filters can be used to further refine results. Use outputSelector to expand the amount of data returned for each matching item.

Finds items on eBay based upon a keyword query and returns details for matching items.

findItemsAdvanced,getSearchKeywordsRecommendation samples outputSelector Specify one or more words to use in a search query for finding items on eBay. By default, queries search item titles only. When running queries, it is best to include complete keywords values--eBay checks words in context with each other. If you are using a URL request and your keyword query consists of multiple words, use "%20" to separate the words. For example, use "Harry%20Potter" to search for items containing those words in any order. You can incorporate wildcards in a multi-word search. For example, "ap*%20ip*" returns results for "apple ipod" among other matches. The words "and" and "or" are treated like any other word (and not their logical connotation). Only use "and", "or", or "the" if you are searching for listings containing those specific words. For a list of valid wildcard characters, see <a href="../Concepts/FindingAPIGuide.html#usekeywords">Searching by Keywords</a>. 350. The maximum length for a single word is 98 findItemsByKeywords Yes Reduces the number of items returned in the response according to the filters you specify. findItemsByKeywords No Aspect filters refine (limit) the number of items returned by a find request. Obtain input values for aspectFilter fields from an aspectHistogramContainer returned in the response of a previous query. By issuing a series of find queries, you can continually refine the items returned in your responses. Do this by repeating a query using the aspect values returned in one response as the input values to your next query. For example, the aspectHistogramContainer in a response on Men's Shoes could contain an aspect of Size, along with "aspect values" for the different sizes currently available in Men's Shoes. By populating aspectFilter fields with the values returned in an aspectHistogramContainer, you can hone the item results returned by your new query. For more information on aspects, aspect values, and domains, refer to <a href="#Response.aspectHistogramContainer" > aspectHistogramContainer</a>. Refer to the following samples to see aspectFilters in action:   <a href="./findItemsByCategory.html#sampleaspectHist" >Returning Aspect Histogram Information</a>   <a href="./findItemsByCategory.html#sampleaspectFilter" >Refining Results Using Aspect Filters</a> findItemsByKeywords No Specifies what item data to return in a response in addition to the default set of data. If you don't specify this field, eBay returns a default set of item fields. Use outputSelector to include more item 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 performance (response time), as is the case with including seller feedback data. Yes Detail Controls #detailControls findItemsByKeywords No Restricts results to items listed within the specified domain. Domains are a buy-side grouping of items. such as shoes or digital cameras. A domain can span multiple eBay categories. findItemsByKeywords No Response container for the findItemsByKeywords call. Response container for category histograms. Only returned when one or more category histograms are returned. A category histogram is not returned if the search query returns no matching items. Note: When searching the eBay Motors site, category histograms may not be available for some parent categories. In these cases, aspect histograms should be used to refine search results. This behavior is consistent with eBay Motors site search behavior. findItemsByKeywords

outputSelector: CategoryHistogram

Conditionally Response container for aspect histograms. findItemsByKeywords

outputSelector: AspectHistogram

Conditionally Returns items in one or more specified categories. Filters can be used to restrict the results.

Finds items in a specific category. Results can be filtered and sorted.

findItemsAdvanced,findItemsByKeywords samples outputSelector Specifies the category from which you want to retrieve item listings. This field can be repeated to include multiple categories. If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid categories, use the Trading API <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html">GetCategories</a> call. 10 3 findItemsByCategory Yes Reduces the number of items returned in the response according to the filters you specify. findItemsByCategory No Aspect filters refine (limit) the number of items returned by a find request. Obtain input values for aspectFilter fields from an aspectHistogramContainer returned in the response of a previous query. By issuing a series of find queries, you can continually refine the items returned in your responses. Do this by repeating a query using the aspect values returned in one response as the input values to your next query. For example, the aspectHistogramContainer in a response on Men's Shoes could contain an aspect of Size, along with "aspect values" for the different sizes currently available in Men's Shoes. By populating aspectFilter fields with the values returned in an aspectHistogramContainer, you can hone the item results returned by your new query. For more information on aspects, aspect values, and domains, refer to <a href="#Response.aspectHistogramContainer" > aspectHistogramContainer</a>. Refer to the following samples to see aspectFilters in action:   <a href="./findItemsByCategory.html#sampleaspectHist" >Returning Aspect Histogram Information</a>   <a href="./findItemsByCategory.html#sampleaspectFilter" >Refining Results Using Aspect Filters</a> findItemsByCategory No 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. Yes Detail Controls #detailControls findItemsByCategory No Restricts results to items listed within the specified domain. Domains are a buy-side grouping of items. such as shoes or digital cameras. A domain can span multiple eBay categories. findItemsByCategory No Response container for the findItemsByKeywords call. Response container for a category histogram. This container is returned only when the specified category has children categories. Note: The category IDs returned for items in search results are for the leaf categories in which the items are listed. If you use a leaf category ID as input, the response will not return a category histogram. Note: When searching the eBay Motors site, category histograms may not be available for some parent categories. In these cases, aspect histograms should be used to refine search results. This behavior is consistent with eBay Motors site search behavior. findItemsByCategory

outputSelector: CategoryHistogram

Conditionally Response container for aspect histograms. Aspect histograms are returned for categories that have been mapped to domains only. In most cases, just leaf categories are mapped to domains, but there are exceptions. findItemsByCategory

outputSelector: AspectHistogram

Conditionally Request container for the findItemsAdvanced call.

Finds items by a keyword query and/or category and allows searching within item descriptions.

findItemsIneBayStores,findItemsByProduct,getSearchKeywordsRecommendation samples outputSelector Specify one or more words to use in a search query for finding items on eBay. By default, queries search item titles only. When running queries, it is best to include complete keywords values--eBay checks words in context with each other. If you are using a URL request and your keyword query consists of multiple words, use "%20" to separate the words. For example, use "Harry%20Potter" to search for items containing those words in any order. You can incorporate wildcards in a multi-word search. For example, "ap*%20ip*" returns results for "apple ipod" among other matches. The words "and" and "or" are treated like any other word (and not their logical connotation). Only use "and", "or", or "the" if you are searching for listings containing those specific words. For a list of valid wildcard characters, see <a href="../Concepts/FindingAPIGuide.html#usekeywords">Searching by Keywords</a>. findItemsAdvanced requires that you specify either keywords or a categoryId in the search criteria. 350. The maximum length for a single word is 98 findItemsAdvanced Conditionally Specifies the category from which you want to retrieve item listings. This field can be repeated to include multiple categories. If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid categories, use the Trading API <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html" >GetCategories</a> call. 10 3 findItemsAdvanced Conditionally Reduces the number of items returned in the response according to the filters you specify. findItemsAdvanced No Aspect filters refine (limit) the number of items returned by a find request. Obtain input values for aspectFilter fields from an aspectHistogramContainer returned in the response of a previous query. By issuing a series of find queries, you can continually refine the items returned in your responses. Do this by repeating a query using the aspect values returned in one response as the input values to your next query. For example, the aspectHistogramContainer in a response on Men's Shoes could contain an aspect of Size, along with "aspect values" for the different sizes currently available in Men's Shoes. By populating aspectFilter fields with the values returned in an aspectHistogramContainer, you can hone the item results returned by your new query. For more information on aspects, aspect values, and domains, refer to <a href="#Response.aspectHistogramContainer" >aspectHistogramContainer</a>. Refer to the following samples to see aspectFilters in action:   <a href="./findItemsByCategory.html#sampleaspectHist" >Returning Aspect Histogram Information</a>   <a href="./findItemsByCategory.html#sampleaspectFilter" >Refining Results Using Aspect Filters</a> findItemsAdvanced No 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. Yes Detail Controls #detailControls findItemsAdvanced No Specifies whether your keyword query should be applied to item descriptions in addition to titles. Searching the text of item descriptions incurs a performance hit (it can take longer than searches that don't include description searches). If true, the text of the item's description and subtitles will be included in the search. If false, only item titles are included in keyword searches. false findItemsAdvanced No Restricts results to items listed within the specified domain. Domains are a buy-side grouping of items. such as shoes or digital cameras. A domain can span multiple eBay categories. findItemsAdvanced No Response container for the findItemsAdvanced call. Response container for category histograms. Only returned when one or more category histograms are returned. A category histogram is not returned if there are no matching items or if the search is restricted to a single leaf category. Note: The category IDs returned for items in search results are for the leaf categories in which the items are listed. If you use these category IDs as input, the response will not return a category histogram. Note: When searching the eBay Motors site, category histograms may not be available for some parent categories. In these cases, aspect histograms should be used to refine search results. This behavior is consistent with eBay Motors site search behavior. findItemsAdvanced

outputSelector: CategoryHistogram

Conditionally Response container for aspect histograms. findItemsAdvanced

outputSelector: AspectHistogram

Conditionally You can use product IDs (such as an ISBN, UPC, EAN, or eBay Product Reference ID) to find associated items listed on eBay.

Finds items based upon a product ID, such as an ISBN, UPC, EAN, or ePID.

findItemsAdvanced,findItemsIneBayStores samples outputSelector 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, specify productID.type= 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: <a href=" http://developer.ebay.com/DevZone/shopping/docs/CallRef/FindProducts.html" > FindProducts</a> findItemsByProduct Yes Reduces the number of items returned in the response according to the filters you specify. findItemsByProduct No 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. Yes Detail Controls #detailControls findItemsByProduct No Response container for the findItemsByProduct call. Response container for aspect histograms. findItemsByProduct

outputSelector: AspectHistogram

Conditionally Use findItemsIneBayStores to find items listed in eBay stores. Specify storeName in the request to retrieve all listings within a single store. You can combine storeName with keywords to find specific items, or use keywords without storeName to search for items in all eBay stores. Search results can be filtered by item details or aspects and sorted by a variety of criteria.

Finds items in eBay stores. Can search a specific store or can search all stores with a keyword query.

findItemsAdvanced,getSearchKeywordsRecommendation samples outputSelector Specify one or more words to use in a search query for finding items on eBay. By default, queries search item titles only. When running queries, it is best to include complete keywords values--eBay checks words in context with each other. If you are using a URL request and your keyword query consists of multiple words, use "%20" to separate the words. For example, use "Harry%20Potter" to search for items containing those words in any order. You can incorporate wildcards in a multi-word search. For example, "ap*%20ip*" returns results for "apple ipod" among other matches. The words "and" and "or" are treated like any other word (and not their logical connotation). Only use "and", "or", or "the" if you are searching for listings containing those specific words. For a list of valid wildcard characters, see <a href="../Concepts/FindingAPIGuide.html#usekeywords">Searching by Keywords</a>. 350. The maximum length for a single word is 98 findItemsIneBayStores No The name of the eBay store to search. Returns all items in the store. Can be used with keywords to search for specific items in an eBay store. The results can be filtered by item listing details or aspects. Note: Store names are case sensitive. Also, if the store name contains an ampersand (&), you must use the & character entity (& amp;) in its place. findItemsIneBayStores No Reduces the number of items returned in the response according to the filters you specify. findItemsIneBayStores No 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. Yes Detail Controls #detailControls findItemsIneBayStores No Aspect filters refine (limit) the number of items returned by a find request. Obtain input values for aspectFilter fields from an aspectHistogramContainer returned in the response of a previous query. By issuing a series of find queries, you can continually refine the items returned in your responses. Do this by repeating a query using the aspect values returned in one response as the input values to your next query. For example, the aspectHistogramContainer in a response on Men's Shoes could contain an aspect of Size, along with "aspect values" for the different sizes currently available in Men's Shoes. By populating aspectFilter fields with the values returned in an aspectHistogramContainer, you can hone the item results returned by your new query. For more information on aspects, aspect values, and domains, refer to <a href="#Response.aspectHistogramContainer" >aspectHistogramContainer</a>. Refer to the following samples to see aspectFilters in action:   <a href="./findItemsByCategory.html#sampleaspectHist" >Returning Aspect Histogram Information</a>   <a href="./findItemsByCategory.html#sampleaspectFilter" >Refining Results Using Aspect Filters</a> findItemsIneBayStores No Restricts results to items listed within the specified domain. Domains are a buy-side grouping of items. such as shoes or digital cameras. A domain can span multiple eBay categories. findItemsIneBayStores No Specifies the category from which you want to retrieve item listings. This field can be repeated to include multiple categories. If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid categories, use the Trading API <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html">GetCategories</a> call. 10 3 findItemsIneBayStores No Response container for the findItemsIneBayStores call. Response container for category histograms. Only returned when one or more category histograms are returned. A category histogram is not returned if there are no matching items or if the search is restricted to a single leaf category. Note: The category IDs returned for items in search results are for the leaf categories in which the items are listed. If you use these category IDs as input, the response will not return a category histogram. Note: When searching the eBay Motors site, category histograms may not be available for some parent categories. In these cases, aspect histograms should be used to refine search results. This behavior is consistent with eBay Motors site search behavior. findItemsIneBayStores

outputSelector: CategoryHistogram

Conditionally Response container for aspect histograms. findItemsIneBayStores

outputSelector: AspectHistogram

Conditionally Get request for histogram information on the supplied category or aspect.

Gets category and/or aspect metadata for the specified category.

findItemsByCategory,findItemsAdvanced,findItemsByKeywords samples Specifies the category from which you want to retrieve histogram information. If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid categories, use the Trading API <a href= " http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html" >GetCategories</a> call. 10 getHistograms Yes Response container for the getHistogram call. Response container for category histograms. This container is returned only when the specified category has children categories. Note: Category histograms may not be available for some parent categories on the eBay Motors site. getHistograms Conditionally Response container for aspect histograms. Aspect histograms are returned for categories that have been mapped to domains only. In most cases, just leaf categories are mapped to domains, but there are exceptions. getHistograms Conditionally This is the base request container for all Finding Service operations. 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). findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No The postal code of the buyer. This is used as the basis for proximity searches as well as local searches. The following sample uses buyerPostalCode and the MaxDistance itemFilter to perform a proximity search:   <a href="./findItemsByKeywords.html#sampleproximity" >Proximity Search</a> findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No 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 the <a href="https://www.ebaypartnernetwork.com/" target="_blank">eBay Partner Network</a> site for information about affiliate commissions. Refer to the following sample for details on including affiliate information:   <a href="./findItemsByKeywords.html#sampleaffiliate" >Specifying affiliate information</a> findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No Sort the returned items according to a single specified sort order. BestMatch findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No Base response container for all Finding Service operations. 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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Always 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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally eBay uses specified details to build a View Item URL and Product URL string in the response. These URLs include correctly formatted affiliate tracking information. When a user clicks through one of these URLs to eBay, the respective affiliate might get a commission, based on the tasks performed by the user. For information about commissions, see the <a href="https://www.ebaypartnernetwork.com/">eBay Partner Network</a> site. 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. No 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 For information about commissions, see the <a href="https://www.ebaypartnernetwork.com/">eBay Partner Network</a> site. No 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. No Statistical (histogram) information about categories that contain items that match the query, if any. For categories associated with specific items, see items returned in each search result. Shows the distribution of items across each category. Not returned if there is no match. The total number of items in the associated category that match the search criteria. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct categoryHistogram childCategoryHistogram

outputSelector: CategoryHistogram

Conditionally getHistograms Conditionally Container for histogram information pertaining to a child of the category specified in the request. Histograms return data on up to 10 children. Histograms are only a single level deep. That is, a given category histogram contains only immediate children. 10 findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: CategoryHistogram

Conditionally getHistograms Conditionally Base container for histogram information. Statistical (item count) information on the categories that contain items that match the search criteria or specified category or categories. A category histogram contains information for up to 10 child categories. Search result total entries may not necessarily match the sum of category histogram item counts. For search calls, the item count shows the distribution of matching items across each of the returned categories. A category histogram is not returned if there are no matching items or if the search is restricted to a single leaf category. For getHistograms, the category histogram contains the total item count for the specified category and item counts for the child categories containing the most item listings. A category histogram is not returned if the specified category is a leaf category. For categories associated with specific items, review the individual item containers returned in the search result. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: CategoryHistogram

Conditionally getHistograms Conditionally Container for details pertaining to individual aspect values, including their histogram information (item counts). Number of items that share the characteristic the respective aspect value. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: AspectHistogram

Conditionally getHistograms Conditionally Name of an aspect value. For example, "Short Sleeve" could be an aspect value of the Sleeve Style aspect in the Women's Dresses domain, or "Athletic" could be an aspect value of the Style aspect in the Men's Shoes domain. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: AspectHistogram

Conditionally getHistograms Conditionally Container for a top-level set of aspect histograms. 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 domains. You can use a domainName to label a set of aspects that you display. Domains are extracted from item listing properties (such as item titles and subtitles).

outputSelector: AspectHistogram

Conditionally A buy-side group of items, for example "Shoes." Domains are extracted from item listing properties, such as the title, descriptions, and so on.

outputSelector: AspectHistogram

Conditionally A characteristic of an item in a domain. For example, "Optical Zoom", "Brand", and "Megapixels" could be aspects of the Digital Cameras domain. Aspects are well-known, standardized characteristics of a domain, and they vary from domain to domain (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 domain. 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. <img src="../Concepts/images/refinesearch.jpg" alt="eBay Aspects" />

outputSelector: AspectHistogram

Conditionally Characteristic of an item in a domain. For example, "Shoes Size" or "Style" might be aspects of the Men's Shoes domain, while "Genre" and "Album Type" could be aspects of the Music CDs domain. This container is not returned if there are no matching aspects for the associated domain. 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 associated domain. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: AspectHistogram

Conditionally getHistograms Conditionally Name of an aspect that is part of a domain. For example, "Optical Zoom" or "Megapixels" could be aspects of the Digital Cameras domain. For the current aspect names associated with a specific item, refer to the aspectHistogramContainer returned for the respective item. This value is not returned if there are no matching aspects for the associated domain. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: AspectHistogram

Conditionally getHistograms Conditionally Use aspect filters to refine the number of results returned in a response. Populate the aspectFilter container with aspect values obtained from the response of a query that returns an aspectHistogram. Name of a standard item characteristic associated with a given domain. For example, "Optical Zoom" or "Megapixels" are aspects for the Digital Cameras domain. The current aspect names associated with a specific domain can be found in the aspect histogram. Aspect histograms can be retrieved for a given keyword query or category. The aspect histogram contains information about aspects from the domain that is most relevant to your search (or category). findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No A value name for a given aspect. For example, "Point & Shoot" is a value name for the "Product Type" aspect in the "Digital Cameras" domain. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No Contains the returned item listings, if any. The data for each listing is returned in individual item containers. Container for the data of a single item that matches the search criteria. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Always The total number of items returned in the search response. This is often equal to the entriesPerPage value. If the count is less than the specified entriesPerPage, it indicates the end of the result set. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Always Name of the domain to which search results will be restricted. Specify the name of the domain to which you want to restrict search results. Only items listed within the specified domain will be returned in the search results. Domain names can be retrieved from an aspect histogram. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores No Values that can be used to sort search results. Sorts items by Best Match, which is based on community buying activity and other relevance-based factors. Sorts items by their current price, with the highest price first. Sorts items by distance from the buyer in ascending order. The request must also include a buyerPostalCode. Sorts items by end time, with items ending soonest listed first. 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. 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. Sorts items by the start time, the most recently listed (newest) items appear first. Values that can be used to retrieve additional information for in the search results. Include information about the seller in the response. Include information about the seller's eBay store in the response. Include a CategoryHistogram container with information about categories that match your search. Include an AspectHistogram container with information about aspects from the domain that is most relevant to your search. Contains details about a category. The unique ID of a category on the specified eBay site. 10 findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct primaryCategory

outputSelector: CategoryHistogram

Always findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct secondaryCategory

outputSelector: CategoryHistogram

Conditionally findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct categoryHistogram

outputSelector: CategoryHistogram

Conditionally getHistograms Conditionally Display name of a category as it appears on the eBay Web site. 30 findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct primaryCategory

outputSelector: CategoryHistogram

Always findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct secondaryCategory

outputSelector: CategoryHistogram

Conditionally findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct categoryHistogram

outputSelector: CategoryHistogram

Conditionally getHistograms Conditionally Distance, used for local searches. Unit of measure used in a distance calculation. Units can be in either kilometers or miles, depending on the Global ID. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct Conditionally Type that represents the unique identifier for a single product. The nature of the identifier being used. For findItemsByProduct, search by a single type. <dl> <dt> productId values: </dt> <dt> ReferenceID </dt> <dd> The global reference ID (ePID) for an eBay catalog product. A reference ID is a fixed reference to a product, regardless of version. Use FindProducts in the Shopping API to determine valid ePID values that you can use as input to findItemsByProduct. Each product in the response includes its reference ID. </dd> <dt> ISBN </dt> <dd> ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay Reference ID to search for that book. Max length of corresponding value: 13 </dd> <dt> UPC </dt> <dd> UPC value for products in Music (e.g., CDs), DVDs & Movies, and Video Games categories (or domains). If you know a product's UPC, you can use this instead of the eBay Reference ID to search for that product. Max length of corresponding value: 12 </dd> <dt> EAN </dt> <dd> EAN value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay Reference ID to search for that book. Max length of corresponding value: 13 </dd> </dl> findItemsByProduct Yes Selling details pertaining to the respective item. 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), Store Inventory (StoreInventory), and Ad Format (AdFormat) listings, currentPrice is the current fixed price. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally The listing's current price converted to the currency of the site specified in the find request (globalId). findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally The number of bids that have been placed on the item. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. <dl> <dt> sellingState values: </dt> <dt> Active </dt> <dd> The listing is still live. It is also possible that the auction has recently ended, but eBay has not completed the final processing (e.g., the high bidder is still being determined). </dd> <dt> Canceled </dt> <dd> The listing has been canceled by either the seller or eBay. </dd> <dt> Ended </dt> <dd> The listing has ended and eBay has completed the processing of the sale (if any). </dd> </dl> findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally Denotes whether the item is a storefront listing. The name of the seller's eBay Store. 200 findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: StoreInfo

Conditionally The URL of the seller's eBay Store page. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: StoreInfo

Conditionally Reduce the number of items returned by a find request using itemFilters. Use the itemFilter container to specify itemFilter Name/Value pairs. You can include multiple itemFilters in a single request. 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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No 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. For a list of possible currency enumeration values, see <a href="Enums/currencyIdList.html">currencyId Values</a>. Note that for MaxPrice and MinPrice itemFilters, the default value for paramValue is USD. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No 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. See the <a href="types/ItemFilterType.html">ItemFilterType</a> type documentation for more information about the allowed values, usage rules, and dependencies. Refer to the following samples to see itemFilters in action:   <a href="./findItemsIneBayStores.html#Samples" >Using itemFilters to define a price range</a>   <a href="./findItemsAdvanced.html#sampleaspectHist" >Using itemFilters to search for used Buy It Now items</a> findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No The value associated with the respective itemFilter name. See the <a href="types/ItemFilterType.html">ItemFilterType</a> type documentation for more information about the allowed values, usage rules, and dependencies. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No Values that can be used for the itemFilter.name field. Limits items to those that have the matching item condition. Only one value can be specified. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): <blockquote> <dl> <dt> New </dt> <dd> The seller specified the Item Condition as New, or did not specify a condition. (Excludes items that the seller listed as Used.) </dd> <dt> Used </dt> <dd> The seller specified the Item Condition as Used, or did not specify a condition. (Excludes items that the seller listed as New.) </dd> </dl> </blockquote> Limits results to items listed with the specified currency only. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): For a list of allowed currency values, see <a href="Enums/currencyIdList.html">currencyId Values</a>. Limits the results to items ending on or after the specified time. Specify a time in the past. Item filter EndTimeFrom cannot be used together with item filter EndTimeTo. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#dateTime">dateTime</a>): Specify the time in GMT. Limits the results to items ending on or before the specified time. Specify a time in the future. Item filter EndTimeFrom cannot be used together with item filter EndTimeTo. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#dateTime">dateTime</a>): Specify the time in GMT. If true, excludes all items requiring immediate payment. Default is false. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false If true, search results will Return featured item listings only. Default is false. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false Specifies the maximum feedback score of a seller whose items can be included in the response. If FeedbackScoreMin is also specified, the FeedbackScoreMax value must be greater than or equal to the FeedbackScoreMin value. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#int">int</a>): Integer greater than or equal to 0. Specifies the mininum feedback score of a seller whose items can be included in the response. If FeedbackScoreMax is also specified, the FeedbackScoreMax value must be greater than or equal to the FeedbackScoreMin value. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#int">int</a>): Integer greater than or equal to 0. If true, the search results are limited to only items with free shipping to the site specified in the request (see <a href="GlobalIdList.html">Global ID Values</a>). Default is false. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false If true, the search results are limited to only Get It Fast listings. Default is false. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false If true, and there are duplicate items for an item in the search results, the subsequent duplicates will not appear in the results. Default is false. Item listings are considered duplicates when all of the ollowing conditions are met: 1. Items are listed by the same seller 2. Items have exactly the same item title 3. Items have similar listing formats:     - Auctions (Auction Items, Auction BIN items, Multi-Quantity Auctions, and Multi-Quantity Auctions BIN items)     - Fixed Price (Fixed Price, Multi-quantity Fixed Price, Fixed Price with Best Offer, and Store Inventory Format items)     - Classified Ads For Auctions, items must also have the same price and number of bids to be considered duplicates. Filtering of duplicate item listings is not supported on all sites. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false Limits items to those available to the specified country only. Item filter LocatedIn cannot be used together with item filter AvailableTo. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): Expects the two-letter ISO 3166 country code to indicate the country where the item is located. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site: <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html"> http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html</a>. Limits the result set to just those items located in the specified country. Item filter AvailableTo cannot be used together with item filter LocatedIn. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): Expects the two-letter ISO 3166 country code to indicate the country where the item is located. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site: <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html"> http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html</a>. If true, the search results are limited to only items which have local pickup available. Default is false. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false If true, returns only matching items with the Local Inventory Listing Options (LILO). Must be used together with the MaxDistance item filter, and the request must also specify buyerPostalCode. Currently, this is only available for the Motors site (global ID EBAY-MOTOR). Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false Filters items based listing type information. Default behavior is to return all matching items, except Store Inventory format listings. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): <blockquote> <dl> <dt>AdFormat</dt> <dd>Retrieve matching Ad Format listings only.</dd> <dt>Auction</dt> <dd>Retrieve matching auction listings (i.e., listings eligible for competitive bidding at auction) only. Excludes auction items with Buy It Now.</dd> <dt>AuctionWithBIN</dt> <dd>Retrieve all matching auction listings, including auction items with Buy It Now.</dd> <dt>Classified</dt> <dd>Retrieves Classified Ad format listings only.</dd> <dt>FixedPrice</dt> <dd>Retrieve matching fixed price items only. Excludes Store Inventory format items. </dd> <dt>StoreInventory</dt> <dd>Retrieve Store Inventory format items only.</dd> <dt>All</dt> <dd>Retrieve matching items for any listing type.</dd> </blockquote> Note: Multiple listing type values can be specified for this filter. Example: <pre> ... &itemFilter(0).name=ListingType &itemFilter(0).value(0)=AuctionWithBIN &itemFilter(0).value(1)=FixedPrice &itemFilter(0).value(2)=StoreInventory ... </pre> If true, returns only matching listings for which the lot size is 2 or more. Default is false. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false Limits the results to items with bid counts less than or equal to the specified value. If MinBids is also specified, the MaxBids value must be greater than or equal to the MinBids value. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#int">int</a>): Integer greater than or equal to 0. Limits the results to items with bid counts greater than or equal to the specified value. If MaxBids is also specified, the MaxBids value must be greater than or equal to the MinBids value. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#int">int</a>): Integer greater than or equal to 0. Specifies the maximum current price an item can have to be included in the response. Optionally, you can also specify a currency ID, using the paramName and paramValue fields (e.g., <code>&paramName=Currency&paramValue=EUR</code>). If using with MinPrice to specify a price range, the MaxPrice value must be greater than or equal to MinPrice. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#decimal">decimal</a>): Decimal values greater than or equal to 0.0. Specifies the minimum current price an item can have to be included in the response. Optionally, you can also specify a currency ID, using the paramName and paramValue fields (e.g., <code>&paramName=Currency&paramValue=EUR</code>). If using with MaxPrice to specify a price range, the MaxPrice value must be greater than or equal to MinPrice. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#decimal">decimal</a>): Decimal values greater than or equal to 0.0. Limits results to items that accept the specified payment method. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): <blockquote> <dl> <dt>PayPal</dt> <dd>PayPal payment method.</dd> <dt>PaisaPay</dt> <dd>PaisaPay payment method. The PaisaPay payment method is only for the India site (global ID EBAY-IN).</dd> <dt>PaisaPayEMI</dt> <dd>PaisaPayEscrow EMI (Equal Monthly Installment) payment method. The PaisaPayEscrowEMI payment method is only for the India site (global ID EBAY-IN).</dd> </blockquote> Limits the results to listings with a quantity less than or equal to the specified value. If MinQuantity is also specified, the MaxQuantity value must be greater than or equal to the MinQuantity value. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#int">int</a>): Integer greater than or equal to 1. Limits the results to listings with a quantity greater than or equal to the specified value. If MaxQuantity is also specified, the MaxQuantity value must be greater than or equal to the MinQuantity value. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#int">int</a>): Integer greater than or equal to 1. Specify one or more seller names. Search results will include items from the specified sellers only. Item filter ExcludeSeller cannot be used together with item filter Seller. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): Valid seller names. Note: Multiple values are allowed. Up to 100 sellers can be specified. Example: <pre> ... &itemFilter(0).name=Seller &itemFilter(0).value(0)=seller01 &itemFilter(0).value(1)=seller02 &itemFilter(0).value(2)=seller03 ... </pre> Specify one or more seller names. Search results will not include items from the specified sellers. Item filter ExcludeSeller cannot be used together with item filter Seller. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): Valid seller names. Note: Multiple values are allowed. Up to 100 sellers can be specified. Example: <pre> ... &itemFilter(0).name=ExcludeSeller &itemFilter(0).value(0)=seller01 &itemFilter(0).value(1)=seller02 &itemFilter(0).value(2)=seller03 ... </pre> If true, returns only items listed in the World of Good marketplace. Defaults to false. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#boolean">boolean</a>): true, false Specifies the maximum distance from the specified postal code (buyerPostalCode) to search for items. Must be used together with the LocalSearchOnly item filter, and the request must also specify buyerPostalCode. Currently, this is only available for the Motors site (global ID EBAY-MOTOR). Allowed values (<a class="defn_type" href="../types/simpleTypes.html#int">int</a>): Integer greater than or equal to 0 and less than 3000. Restricts the items to those that are from sellers whose business type is the specified value Limits items to those that have the matching item condition. Only one value can be specified. This filter is applicable to UK, France, and Germany only. If the filter is used for any other site, an error is returned. Allowed values (<a class="defn_type" href="../types/simpleTypes.html#string">string</a>): <blockquote> <dl> <dt> Commercial </dt> <dd> The seller is registered as a business on eBay. </dd> <dt> Private </dt> <dd> The seller is registered as an individual on eBay. </dd> </dl> </blockquote> Container for the data of a single item that matches the search criteria. 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. 19 (normally, item IDs are 9 to 12 digits in length) findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Always Name of the item as it appears in the listing title, or in search and browse results. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally 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. For a list of possible enumeration values and how they map to eBay sites, see <a href="Enums/GlobalIdList.html">Global ID Values</a>. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Always Subtitle of the item. Only returned if the seller included a subtitle for the listing. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally 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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Always 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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally URL for the Gallery thumbnail image. The image must be provided in one of the following graphics formats: JPEG, BMP, TIF, or GIF. Returned only if the seller chose to show a gallery image. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. To note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes to "QQ", and "=" (equals sign) optimizes to "Z". Do not modify the returned URLs in your application queries (for example, eBay won't recognize the URL if you change QQ to &). In the Sandbox environment (and on the Hong Kong site), the data returned in this field is a standard ViewItem URL rather than the ViewItemURL for natural search. If you enabled affiliate tracking in the call, viewItemURL contains a string that includes affiliate tracking information (see the <a href="https://www.ebaypartnernetwork.com/">eBay Partner Network</a>). findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally A unique identification number assigned by eBay to registered nonprofit charity organizations. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally 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. See <a href="http://developer.ebay.com/DevZone/shopping/docs/CallRef/types/BuyerPaymentMethodCodeType.html" >BuyerPaymentMethodCodeType</a> in the Shopping API for a complete list of possible paymentMethod response values. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally If true, the seller requires immediate payment for the item. If false (or not specified), immediate payment is not requested. Buyers must have a PayPal account to purchase items that require immediate payment. A seller can choose to require immediate payment for Fixed Price and Buy It Now listings, including eBay Stores Inventory listings. If a Buy It Now item ends as an auction (that is, if the Buy It Now option is removed due to bids being placed on the listing), the immediate payment requirement does not apply. Note: The value of the AutoPay flag indicates the seller's stated preference only. It does not indicate whether the listing is still a candidate for purchase via immediate payment. For example, if a listing receives bids and no longer qualifies for immediate payment, the value of the AutoPay flag does not change. Only applicable to items listed on PayPal-enabled sites and in categories that support immediate payment. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Always The postal code where the listed item is located, 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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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). findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally Two-letter ISO 3166 country code to indicate the country where the item is located. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site: <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html"> http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html</a>. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: StoreInfo

Conditionally Information about the item's seller. Only returned if SellerInfo is specified in the outputSelector field in the request. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: SellerInfo

Conditionally Container for data about a listing's shipping details. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally Specifies the item's selling status with regards to eBay's processing workflow. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally The format type of the listing, such as online auction, fixed price, or advertisement. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally Container for information about this listing's seller. The seller's eBay user name; a unique value. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: SellerInfo

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: SellerInfo

Conditionally The percentage value of a user's positive feedback (their positive feedbackScore divided by their total positive plus negative feedback). findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: SellerInfo

Conditionally Visual indicator of user's feedback score. <dl> <dt> feedbackRatingStar values: </dt> <dt> None </dt> <dd> No graphic displayed, feedback score 0-9. </dd> <dt> Yellow </dt> <dd> Yellow Star, feedback score 10-49. </dd> <dt> Blue </dt> <dd> Blue Star, feedback score 50-99. </dd> <dt> Turquoise </dt> <dd> Turquoise Star, feedback score 100-499. </dd> <dt> Purple </dt> <dd> Purple Star, feedback score 500-999. </dd> <dt> Red </dt> <dd> Red Star, feedback score 1,000-4,999. </dd> <dt> Green </dt> <dd> Green Star, feedback score 5,000-9,999. </dd> <dt> YellowShooting </dt> <dd> Yellow Shooting Star, feedback score 10,000-24,999. </dd> <dt> TurquoiseShooting </dt> <dd> Turquoise Shooting Star, feedback score 25,000-49,999. </dd> <dt> PurpleShooting </dt> <dd> Purple Shooting Star, feedback score 50,000-99,999. </dd> <dt> RedShooting </dt> <dd> Red Shooting Star, feedback score 100,000-499,000 and above. </dd> <dt> GreenShooting </dt> <dd> Green Shooting Star, feedback score 500,000-999,000 and above. </dd> <dt> SilverShooting </dt> <dd> Silver Shooting Star, feedback score 1,000,000 or more. </dd> </dl> findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: SellerInfo

Conditionally Container holding the item's shipping details. The basic shipping cost of the item. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. <dl> <dt> shippingType values: </dt> <dt> Calculated </dt> <dd> 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. </dd> <dt> CalculatedDomesticFlatInternational </dt> <dd> The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. </dd> <dt> Flat </dt> <dd> 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. </dd> <dt> FlatDomesticCalculatedInternational </dt> <dd> The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. </dd> <dt> Free </dt> <dd> Free is used when the seller has declared that shipping is free for the buyer. </dd> <dt> FreePickup </dt> <dd> No shipping available, the buyer must pick up the item from the seller. </dd> <dt> Freight </dt> <dd> The freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the buyer's address (postal code). </dd> <dt> FreightFlat </dt> <dd> 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. </dd> <dt> NotSpecified </dt> <dd> The seller did not specify the shipping type. </dd> </dl> findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally An international location or region to which the seller is willing to ship the item. Returned only for items that have shipToLocations specified. For a complete list of shipping locations, see <a href="Enums/shipToLocationList.html">shipToLocations</a>. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally Contains information specific to the item listing. 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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally Used with competitive-bid auctions, the associated item includes a Buy It Now option if this value returns true. 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). findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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), Store Inventory (StoreInventory), and Ad Format (AdFormat) listings, currentPrice is the current fixed price. Only returned if an item was listed with Buy It Now. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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). findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally The format of the listing, such as online auction, fixed price, or advertisement. <dl> <dt> listingType values: </dt> <dt> AdFormat </dt> <dd> 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. </dd> <dt> Auction </dt> <dd> 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. </dd> <dt> AuctionWithBIN </dt> <dd> 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. </dd> <dt> Classified </dt> <dd> 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. </dd> <dt> FixedPrice </dt> <dd> 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. </dd> <dt> StoreInventory </dt> <dd> A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item listings on eBay. Store items have a lower Insertion Fee and longer listing durations. This selling type can only be specified by sellers who have an eBay Store. Store Inventory listings are listed on eBay.com as well as in the seller's eBay Store. </dd> </dl> findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally If true, a generic gift icon displays next the listing's title in search and browse pages. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally Monetary amount of the transaction. Currency in which the monetary amount is specified. For a list of currencyId enumeration values, see <a href="Enums/currencyIdList.html">currencyId Values</a>. Always Base response container for all service operations. Contains error information associated with the request. Indicates whether or not errors or warnings were generated during the processing of the request.

outputSelector: none

Always Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success.

outputSelector: none

Conditionally 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

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

Always Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Run-time errors are not reported here, but are instead reported as part of a SOAP fault. Details about a single error.

outputSelector: none

Conditionally A container for error details. 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

Conditionally Name of the domain in which the error occurred. <dl> <dt> domain values: </dt> <dt> Marketplace </dt> <dd> A business or validation error occurred in the Merchandising Service. </dd> <dt> SOA </dt> <dd> An exception occurred in the Service Oriented Architecture (SOA) framework. </dd> </dl>

outputSelector: none

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.

outputSelector: none

Conditionally There are three categories of errors: request errors, application errors, and system errors.

outputSelector: none

Conditionally A detailed description of the condition that caused in the error.

outputSelector: none

Conditionally Name of the subdomain in which the error occurred. <dl> <dt> subdomain values: </dt> <dt> Finding </dt> <dd> The error is specific to the Finding service. </dd> <dt> MarketplaceCommon </dt> <dd> The error is common to all Marketplace services. </dd> </dl>

outputSelector: none

Conditionally Unique identifier for an exception associated with an error.

outputSelector: none

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.

outputSelector: none

Conditionally Contextual data associated with an error. The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. Conditionally Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. 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. 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. 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. 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. Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. 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. 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. There are three categories of error: request errors, application errors, and system errors. Request and application errors are often caused by passing invalid data in the request. System errors are primarily caused by application failures and cannot be corrected by changing request values. 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. 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. 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. This is the base class container for all service operation requests. Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. Controls which listings are returned in the response, but does not control the details associated with the returned items. 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. 1 100 findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No 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. 100 100 findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct No Shows the pagination data for the item search. Child elements include the page number returned, the maximum entries returned per page, the total number of pages that can be returned, and the total number of items that match the search criteria. 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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

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. findItemsByCategory findItemsAdvanced findItemsByKeywords findItemsIneBayStores findItemsByProduct

outputSelector: none

Conditionally 1.0.0