Returns the current version of the service. This simple call can be used to
monitor the service for availability. This call has no input parameters and
the response contains only the standard output fields.
Returns the current service version.
Response container for the getVersion call.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Request container for the findCompletedItems call.
Finds items by a keyword query and/or category and doesn't allow searching
within item descriptions.
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. Queries aren't case-sensitive,
so it doesn't matter whether you use uppercase or lowercase letters.
<br><br>
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.
<br><br>
findCompletedItems requires that you specify either keywords or a
categoryId in the search criteria.
350. The maximum length for a single word is 98.
<b>Min length:</b> 2
../Concepts/FindingAPIGuide.html#usekeywords
Searching by Keywords
a list of valid wildcard characters
Specifies the category from which you want to retrieve item listings.
This field can be repeated to include multiple categories.
<br><br>
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 <b
class="con">GetCategories</b> call.
<br><br>
Category searches are not supported on the eBay Italy site (global ID
EBAY-IT) at this time.
10
3
../../XML/docs/Reference/eBay/GetCategories.html
GetCategories in the Trading API
information on retrieving eBay category information
Reduce the number of items returned by a find request using item
filters. Use <b class="con">itemFilter</b> to specify
name/value pairs. You can include multiple item filters in a single
request.
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.
<br><br>
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.
<br><br>
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.
<br><br>
#Response.aspectHistogramContainer
aspectHistogramContainer
more information on aspects, aspect values, and domains.
findItemsByCategory.html#sampleaspectHist
findItemsByCategory Call Sample: Returning Aspect Histogram Information
findItemsByCategory.html#sampleaspectFilter
findItemsByCategory Call Sample: Refining Results Using Aspect Filters
Defines what data to return, in addition to the default set of data,
in a response.
<br><br>
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.
<br><br>
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
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.
Input ISBN, UPC, EAN, or ReferenceID (ePID) to specify the type of
product for which you want to search.
<br><br>
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:
<br><br>
<a
href=" https://developer.ebay.com/DevZone/shopping/docs/CallRef/FindProducts.html"
> FindProducts</a>
findItemsByProduct
Yes
Response container for the findCompletedItems 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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
Response container for aspect histograms.
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." <br><br>
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
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.
<br> <br>
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.
<b>Min length:</b> 2
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
Reserved for future use.
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
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. Queries aren't case-sensitive,
so it doesn't matter whether you use uppercase or lowercase letters.
<br><br>
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.
350. The maximum length for a single word is 98.
<b>Min length:</b> 2
findItemsByKeywords
Yes
../Concepts/FindingAPIGuide.html#usekeywords
Searching by Keywords
a list of valid wildcard characters
Reduce the number of items returned by a find request using item
filters. Use <b class="con">itemFilter</b> to specify
name/value pairs. You can include multiple item filters in a single
request.
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.
<br><br>
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.
<br><br/>
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 refine the item results returned by
your new query.
findItemsByKeywords
No
#Response.aspectHistogramContainer
aspectHistogramContainer
more information on aspects, aspect values, and domains.
findItemsByCategory.html#sampleaspectHist
findItemsByCategory Call Sample: Returning Aspect Histogram Information
findItemsByCategory.html#sampleaspectFilter
findItemsByCategory Call Sample: Refining Results Using Aspect Filters
Specifies what item data to return in a response in addition to the
default set of data.
<br><br>
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.
<br><br>
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
findItemsByKeywords
outputSelector: CategoryHistogram
Conditionally
Response container for aspect histograms.
findItemsByKeywords
outputSelector: AspectHistogram
Conditionally
Response container for condition histograms.<br>
<br>
Not returned when Condition is specified in itemFilter.
That is, only returned when you have not yet narrowed
your search based on specific conditions.<br>
<br>
Supported for all eBay sites except US eBay Motors,
India (IN), Malaysia (MY) and Philippines (PH).
International items that appear in search results
are included in a site's histogram counts.
findItemsByKeywords
outputSelector: ConditionHistogram
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
Specifies the category from which you want to retrieve item listings.
This field can be repeated to include multiple categories.
<br><br>
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 <b
class="con">GetCategories</b> call.
<br><br>
Up to three (3) categories can be specified.
<br><br>
Category searches are not supported on the eBay Italy site (global ID
EBAY-IT) at this time.
10
3
findItemsByCategory
Yes
../../XML/docs/Reference/eBay/GetCategories.html
GetCategories in the Trading API
information on retrieving eBay category information
Reduce the number of items returned by a find request using item
filters. Use <b class="con">itemFilter</b> to specify
name/value pairs. You can include multiple item filters in a single
request.
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.
<br><br>
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.
<br><br>
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 refine the item results returned by
your new query.
findItemsByCategory
No
#Response.aspectHistogramContainer
aspectHistogramContainer
more information on aspects, aspect values, and domains.
findItemsByCategory.html#sampleaspectHist
findItemsByCategory Call Sample: Returning Aspect Histogram Information
findItemsByCategory.html#sampleaspectFilter
findItemsByCategory Call Sample: Refining Results Using Aspect Filters
Defines what data to return, in addition to the default set of data,
in a response.
<br><br>
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.
<br><br>
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
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
Response container for condition histograms.
Condition histograms are returned for any category
(leaf or parent).<br>
<br>
Not returned when Condition is specified in itemFilter.
That is, only returned when you have not yet narrowed
your search based on specific conditions.<br>
<br>
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.
findItemsByCategory
outputSelector: ConditionHistogram
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
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. Queries aren't case-sensitive,
so it doesn't matter whether you use uppercase or lowercase letters.
<br><br>
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.
<br><br>
<b class="con">findItemsAdvanced</b> requires that you
specify <b class="con">keywords</b> and/or a <b
class="con">categoryId</b> in the request. The exception to
this rule is when the Seller item filter is used. The Seller item
filter can be used without specifying either <b class="con">
keywords</b> or <b class="con">categoryId</b> to
retrieve all active items for the specified seller.
<br><br>
350. The maximum length for a single word is 98.
<b>Min length:</b> 2
findItemsAdvanced
Conditionally
../Concepts/FindingAPIGuide.html#usekeywords
Searching by Keywords
a list of valid wildcard characters
Specifies the category from which you want to retrieve item listings.
This field can be repeated to include multiple categories. Up to
three (3) categories can be specified.
<br><br>
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 <b
class="con">GetCategories</b> call.
<br><br>
<b class="con">findItemsAdvanced</b> requires that you
specify <b class="con">keywords</b> and/or a <b
class="con">categoryId</b> in the request. The exception to
this rule is when the Seller item filter is used. The Seller item
filter can be used without specifying either <b class="con">
keywords</b> or <b class="con">categoryId</b> to
retrieve all active items for the specified seller.
<br><br>
Category searches are not supported on the eBay Italy site (global ID
EBAY-IT) at this time.
10
3
findItemsAdvanced
Conditionally
../../XML/docs/Reference/eBay/GetCategories.html
GetCategories in the Trading API
information on retrieving eBay category information
Reduce the number of items returned by a find request using item
filters. Use <b class="con">itemFilter</b> to specify
name/value pairs. You can include multiple item filters in a single
request.
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.
<br><br>
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.
<br><br>
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 refine the item results returned by
your new query.
findItemsAdvanced
No
#Response.aspectHistogramContainer
aspectHistogramContainer
more information on aspects, aspect values, and domains.
findItemsByCategory.html#sampleaspectHist
findItemsByCategory Call Sample: Returning Aspect Histogram Information
findItemsByCategory.html#sampleaspectFilter
findItemsByCategory Call Sample: Refining Results Using Aspect Filters
Defines what data to return, in addition to the default set of data,
in a response.
<br><br>
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.
<br><br>
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
findItemsAdvanced
outputSelector: CategoryHistogram
Conditionally
Response container for aspect histograms.
findItemsAdvanced
outputSelector: AspectHistogram
Conditionally
Response container for condition histograms.
<br>
<br>
Not returned when Condition is specified in itemFilter.
That is, only returned when you have not yet narrowed
your search based on specific conditions.<br>
<br>
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.
findItemsAdvanced
outputSelector: ConditionHistogram
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
Input ISBN, UPC, EAN, or ReferenceID (ePID) to specify the type of
product for which you want to search.
<br><br>
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 <b class="con">productId.type</b> to
"ReferenceID" and set <b class="con">productId.value</b>
to an ePID value (also known as an Bay Product Reference ID). If you
do not know the ePID value for a product, use <b
class="con">FindProducts</b> in the eBay Shopping API to
retrieve the desired ePID.
findItemsByProduct
Yes
../../shopping/docs/CallRef/FindProducts.html
FindProducts in the Shopping API
information on retrieving eBay product data
Reduce the number of items returned by a find request using item
filters. Use <b class="con">itemFilter</b> to specify
name/value pairs. You can include multiple item filters in a single
request.
findItemsByProduct
No
Defines what data to return, in addition to the default set of data,
in a response.
<br><br>
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.
<br><br>
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
CategoryHistogram
No
Response container for the findItemsByProduct call.
Response container for aspect histograms.
findItemsByProduct
outputSelector: AspectHistogram
Conditionally
Response container for condition histograms.<br>
<br>
Not returned when Condition is specified in itemFilter.
That is, only returned when you have not yet narrowed
your search based on specific conditions.<br>
<br>
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.
findItemsByProduct
outputSelector: ConditionHistogram
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.
<br><br>
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
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. Queries aren't case-sensitive,
so it doesn't matter whether you use uppercase or lowercase letters.
<br><br>
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.
<br><br>
You must specify keywords when you are searching across all eBay
stores. That is, <b class="con">keywords</b> is required
if <b class="con">storeName</b> is not specified in the
request.
350. The maximum length for a single word is 98.
<b>Min length:</b> 2
findItemsIneBayStores
Conditionally
../Concepts/FindingAPIGuide.html#usekeywords
Searching by Keywords
a list of valid wildcard characters
The name of the eBay store to search. Returns all items in the store,
or can be used with keywords to search for specific items in an eBay
store. If you do not specify keywords, you must specify storeName.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Store names are case sensitive. Also, if the store name contains an
ampersand (&), you must use the & character entity (&
amp;) in its place.
</span>
If you do not specify <b class="con">storeName</b> in the
request, the search is across all eBay stores. When searching across
all stores, you must specify keywords.
<br><br>
The results can be filtered by item listing details or aspects.
findItemsIneBayStores
Conditionally
Reduce the number of items returned by a find request using item
filters. Use <b class="con">itemFilter</b> to specify
name/value pairs. You can include multiple item filters in a single
request.
findItemsIneBayStores
No
Defines what data to return, in addition to the default set of data,
in a response.
<br><br>
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.
<br><br>
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.
<br><br>
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.
<br><br/>
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 refine the item results returned by
your new query.
findItemsIneBayStores
No
#Response.aspectHistogramContainer
aspectHistogramContainer
more information on aspects, aspect values, and domains.
findItemsByCategory.html#sampleaspectHist
findItemsByCategory Call Sample: Returning Aspect Histogram Information
findItemsByCategory.html#sampleaspectFilter
findItemsByCategory Call Sample: Refining Results Using Aspect Filters
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.
<br><br>
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 <b
class="con">GetCategories</b> call.
<br><br>
Up to three (3) categories can be specified.
<br><br>
Category searches are not supported on the eBay Italy site (global ID
EBAY-IT) at this time.
10
3
findItemsIneBayStores
No
../../XML/docs/Reference/eBay/GetCategories.html
GetCategories in the Trading API
information on retrieving eBay category information
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
findItemsIneBayStores
outputSelector: CategoryHistogram
Conditionally
Response container for aspect histograms.
findItemsIneBayStores
outputSelector: AspectHistogram
Conditionally
Response container for condition histograms.
These can be returned for any category (parent or leaf).
<br>
<br>
Not returned when Condition is specified in itemFilter.
That is, only returned when you have not yet narrowed
your search based on specific conditions.<br>
<br>
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.
findItemsIneBayStores
outputSelector: ConditionHistogram
Conditionally
Find items based on the image similarity to the specified item.
Find items based on their image similarity to the specified item.
findItemsByProduct
Specifies the item that the customer wants to use for retrieving
more listings with similar images. The item must active and it must
be listed in a Clothing, Shoes & Accessories category (parent
category ID 11450 on the eBay US site).
19 (normally, item IDs are 9 to 12 digits in length)
findItemsByImage
Yes
Specifies the leaf category from which you want to retrieve item
listings with similar images. If no category is specified, search
results can come from any Clothing, Shoes & Accessories leaf
category. This field can be repeated (up to 3 times) to include
multiple categories.
<br><br>
Image similarity searches are only supported in Clothing, Shoes &
Accessories leaf categories on the eBay US, UK, and Germany sites.
<br><br>
If a specified category ID doesn't match an existing category for the
site, eBay returns an invalid-category error message. To determine
valid leaf categories, use the Trading API <b
class="con">GetCategories</b> call.
10
findItemsByImage
No
Reduce the number of items returned by a find request using item
filters. Use <b class="con">itemFilter</b> to specify
name/value pairs. You can include multiple item filters in a single
request.
findItemsByImage
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.
<br><br>
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.
<br><br>
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 refine the item results returned by
your new query.
findItemsByImage
No
#Response.aspectHistogramContainer
aspectHistogramContainer
more information on aspects, aspect values, and domains.
findItemsByCategory.html#sampleaspectHist
findItemsByCategory Call Sample: Returning Aspect Histogram Information
findItemsByCategory.html#sampleaspectFilter
findItemsByCategory Call Sample: Refining Results Using Aspect Filters
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.
findItemsByImage
No
Defines what data to return, in addition to the default set of data,
in a response.
<br><br>
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.
<br><br>
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
findItemsByImage
No
Response container for the findItemsByImage 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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
outputSelector: CategoryHistogram
Conditionally
Response container for aspect histograms.
outputSelector: AspectHistogram
Conditionally
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
Specifies the category from which you want to retrieve histogram
information.
<br><br>
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 <b
class="con">GetCategories</b> call.
<br><br>
Retrieving histograms by category is not supported on the eBay Italy
site (global ID EBAY-IT) at this time.
10
getHistograms
Yes
../../XML/docs/Reference/eBay/GetCategories.html
GetCategories in the Trading API
information on retrieving eBay category information
Response container for the getHistogram call.
Response container for category histograms. This container is
returned only when the specified category has children categories.
<br><br>
<span class="tablenote"><strong>Note:</strong>
Category histograms may not be available for some parent categories
on the eBay Motors site.
</span>
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
Response container for condition histograms.
Returned for leaf and parent categories.<br>
<br>
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.
getHistograms
Conditionally
Reserved for future use.
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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). </span>
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
No
The postal code of the buyer. This is used as the basis for proximity
searches as well as local searches.
<br><br>
A proximity search requires <b
class="con">buyerPostalCode</b> and a <b
class="con">MaxDistance</b> item filter.
A local search requires <b
class="con">buyerPostalCode</b> and item filters for <b
class="con">MaxDistance</b> and <b
class="con">LocalSearch</b>.
<br><br>
<b>Note: </b> To get the accurate shipping cost for items
listed using a rate table, you <i>must</i> include
<b>buyerPostalCode</b> in the request.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
No
findItemsByKeywords.html#sampleproximity
findItemsByKeywords Call Sample: Proximity Search
an example of how to restrict searches by distance
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
No
https://www.ebaypartnernetwork.com/
eBay Partner Network site
information about affiliate commissions
findItemsByKeywords.html#sampleaffiliate
findItemsByKeywords Call Sample: Specifying affiliate information
This is the base request container for all Finding Service operations.
Sort the returned items according to a single specified sort order.
BestMatch
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
eBay URLs returned in fields, such as <b
class="con">viewItemURL</b>, 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.
</span>
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Always
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
Reserved for future use.
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.
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:
<br>
<br>2 = Be Free
<br>3 = Affilinet
<br>4 = TradeDoubler
<br>5 = Mediaplex
<br>6 = DoubleClick
<br>7 = Allyes
<br>8 = BJMT
<br>9 = eBay Partner Network
No
https://www.ebaypartnernetwork.com/
eBay Partner Network site
information about commissions
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
The lgeo parameter will be used for geo-targeting feature that is already implemented on the affiliate tracking side
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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
1
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
<br><br>
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.
<br><br>
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.
<br><br>
For categories associated with specific items, review the individual item
containers returned in the search result.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
<br><br>
Domains are extracted from item listing properties (such as item titles
and subtitles).
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: AspectHistogram
Conditionally
getHistograms
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: AspectHistogram
Conditionally
getHistograms
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.
<br><br>
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.
<br><br>
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.
<br><br>
<img
src="https://developer.ebay.com/devzone/finding/concepts/images/refinesearch.jpg"
alt="eBay Aspects" />
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: AspectHistogram
Conditionally
getHistograms
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.
<br><br>
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.
<br><br>
This value is not returned if there are no matching aspects for the
associated domain.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
<br><br>
This value is not returned if there are no matching aspects for the
associated domain.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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).
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Always
The total number of items returned in the search response. This is often
equal to the <b class="con">entriesPerPage</b> value. If the
count is less than the specified <b
class="con">entriesPerPage</b>, it indicates the end of
the result set.
1
100
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Always
Description
Description
Strike through price
Miminum Advertised Price
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
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 <strong>buyerPostalCode</strong>.
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.
Sorts items by the number of bids they have received, with items that
have received the most bids first.
<br><br>
Sorting by bid count is supported on the eBay US (global ID EBAY-US),
eBay Germany (global ID EBAY-DE), and eBay Australia (global ID EBAY-AU)
sites only. To sort by bid count, you must specify a listing type filter
to limit results to auction listings only (e.g., <code>&
itemFilter.name=ListingType&itemFilter.value=Auction</code>).
Sorts items by the number of bids they have received, with items that
have received the fewest bids first.
<br><br>
Sorting by bid count is supported on the eBay US (global ID EBAY-US),
eBay Germany (global ID EBAY-DE), and eBay Australia (global ID EBAY-AU)
sites only. To sort by bid count, you must specify a listing type filter
to limit results to auction listings only (e.g., <code>&
itemFilter.name=ListingType&itemFilter.value=Auction</code>).
Sorts items available on the the given site (as specified by <a
href="https://developer.ebay.com/devzone/finding/concepts/makingacall.html#standardurlparameters"
>global ID in the HTTP header or URL parameter</a>) 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.
<br><br>
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 (e.g., United States sorts first, APO/FPO sorts
near the end).
<br><br>
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).
Sorts items available on the 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.
<br><br>
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).
Sorts items by watch count in decreasing order for the given site.
The items with highest watch count appear earlier in results than those
with lower watch count.
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>
<strong>productId values:</strong>
</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
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.
<br><br>
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.
<br><br>
Note that for MaxPrice and MinPrice itemFilters, the default value for
paramName is Currency.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
No
The currency value associated with the respective itemFilter parameter
Name.
<br><br>
Usually paramName is set to Currency and paramValue is set to the
currency type in which the monetary transaction occurs.
<br><br>
Note that for MaxPrice and MinPrice itemFilters, the default value for
paramValue is USD.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
No
Enums/currencyIdList.html
currencyId Values
a list of possible currency enumeration values
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.
<br><br>
<b>Item Filter Names</b>:
<br><br>
<ul>
<li>AvailableTo</li>
<li>BestOfferOnly</li>
<li>CharityOnly</li>
<li>Condition</li>
<li>Currency</li>
<li>EndTimeFrom</li>
<li>EndTimeTo</li>
<li>ExcludeAutoPay</li>
<li>ExcludeCategory</li>
<li>ExcludeSeller</li>
<li>ExpeditedShippingType</li>
<li>FeedbackScoreMax</li>
<li>FeedbackScoreMin</li>
<li>FreeShippingOnly</li>
<li>HideDuplicateItems</li>
<li>ListedIn</li>
<li>ListingType</li>
<li>LocalPickupOnly</li>
<li>LocalSearchOnly</li>
<li>LocatedIn</li>
<li>LotsOnly</li>
<li>MaxBids</li>
<li>MaxDistance</li>
<li>MaxHandlingTime</li>
<li>MaxPrice</li>
<li>MaxQuantity</li>
<li>MinBids</li>
<li>MinPrice</li>
<li>MinQuantity</li>
<li>ModTimeFrom</li>
<li>ReturnsAcceptedOnly</li>
<li>Seller</li>
<li>SellerBusinessType</li>
<li>TopRatedSellerOnly</li>
<li>ValueBoxInventory</li>
</ul>
SoldItemsOnly
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
No
types/ItemFilterType.html
ItemFilterType
more information about the allowed values, usage rules, and
dependencies
findItemsIneBayStores.html#Samples
findItemsIneBayStores Call Sample: Using itemFilters to define a price range
findItemsAdvanced.html#sampleaspectHist
findItemsAdvanced Call Sample: Using itemFilters to search for used Buy It Now items
The value associated with the respective item filter name. Allowed values
and datatypes vary for a given filter name.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
No
types/ItemFilterType.html
ItemFilterType
information about the allowed values, usage rules, and
dependencies
Container for condition histograms.
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.
<br>
<br>
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.<br>
<br>
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.
findItemsAdvanced
findItemsByCategory
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
outputSelector: ConditionHistogram
Conditionally
getHistograms
Conditionally
Container for histogram fields.
The name and unique ID of the item condition for which the count is being displayed.
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: ConditionHistogram
Conditionally
getHistograms
Conditionally
The number of items found that match the condition.
Only counts items where the seller specified the
condition by using item.conditionId.
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
outputSelector: ConditionHistogram
Conditionally
getHistograms
Conditionally
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
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>
<strong>domain values:</strong>
</dt>
<dt>
Marketplace
</dt>
<dd>
A business or validation error occurred in the 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.
<br><br>
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.
<br><br>
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.
<br><br>
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>
<strong>subdomain values:</strong>
</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
1
100
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
<br><br>
If entriesPerPage is set to a number greater than 100, the default value,
100, will be used.
100
1
100
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
<br> <br>
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.
<br> <br>
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.
0
100
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
<br> <br>
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.
1
100
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
0
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
0
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
Values that can be used for the itemFilter.name field.
FeaturedOnly, GetItFastOnly, OutletSellerOnly, PaymentMethod, WorldOfGoodOnly
This item condition filter allows a user to filter items based on item condition. Multiple item condition filters may be used. The <code>Condition</code> enum value is specified in the <b>itemfilter.name</b> field, and either the condition ID or the condition name can be specified in the <b>itemfilter.value</b> field. The condition ID is actually recommended, because these identifiers are consistent across eBay categories, whereas condition names can vary slightly between eBay categories, such as 'New', 'New in Box', or 'New with Tags'.
<br><br>
See the <a href="https://developer.ebay.com/Devzone/finding/CallRef/Enums/conditionIdList.html">Item Condition IDs and Names</a> page to view a table that maps condition IDs to condition names.
<a name="Currency"></a>
Limits results to items listed with the specified currency only.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
For a list of allowed currency values, see <a
href="../Enums/currencyIdList.html">currencyId Values</a>.
<br><br>
<a name="EndTimeFrom"></a>
Limits the results to items ending on or after the specified time.
Specify a time in the future.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#dateTime">dateTime</a>):</b>
<br>
Specify the time in GMT.
<br><br>
<a name="ModTimeFrom"></a>
Limits the results to active items whose status has changed since the
specified time. Specify a time in the past. Time must be in GMT.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#dateTime">dateTime</a>):</b>
<br>
Specify the time in GMT.
<br><br>
<a name="EndTimeTo"></a>
Limits the results to items ending on or before the specified time.
Specify a time in the future.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#dateTime">dateTime</a>):</b>
<br>
Specify the time in GMT.
<br><br>
<a name="ExcludeAutoPay"></a>
If true, excludes all items requiring immediate payment. Default is
false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="BestOfferOnly"></a>
If true, the search results are limited to only items that
have Best Offer enabled. Default is false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="FeaturedOnly"></a>
If true, the search results are limited to featured item listings only.
Default is false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="FeedbackScoreMax"></a>
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.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 0.
<br><br>
<a name="FeedbackScoreMin"></a>
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.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 0.
<br><br>
<a name="FreeShippingOnly"></a>
If true, the search results are limited to only items with free shipping
to the site specified in the request (see <a
href="../Enums/GlobalIdList.html">Global ID Values</a>). Default is
false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="GetItFastOnly"></a>
If true, the search results are limited to only Get It Fast listings.
Default is false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="HideDuplicateItems"></a>
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.<br>
Item listings are considered duplicates when all of the ollowing
conditions are met:<br>
1. Items are listed by the same seller<br>
2. Items have exactly the same item title<br>
3. Items have similar listing formats: <br>
- Auctions (Auction Items and Auction BIN items)<br>
- Fixed Price (Fixed Price, Multi-quantity Fixed Price, Fixed
Price with Best Offer, and Store Inventory Format items)<br>
- Classified Ads<br>
<br>
For Auctions, items must also have the same price and number of bids to
be considered duplicates.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="AvailableTo"></a>
Limits items to those available to the specified country only.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
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:
<br> <a href="https://www.iso.org/iso-3166-country-codes.html"> ISO 3166 COUNTRY CODES</a>.
<br><br>
<a name="LocatedIn"></a>
Limits the result set to just those items located in the specified
country.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
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:
<br>
<a href="https://www.iso.org/iso-3166-country-codes.html"> ISO 3166 COUNTRY CODES</a>.
<br><br>
<b>Note: </b>Multiple values are allowed. Up to 25 countries
can be specified.
<br><br>
<a name="LocalPickupOnly"></a>
If true, the search results are limited to only items which have local
pickup available. Default is false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="LocalSearchOnly"></a>
If true, the search results are limited to only matching items with the
Local Inventory Listing Options (LILO). Must be used together with the
<b class="con"> MaxDistance</b> item filter, and the request
must also specify <b class="con">buyerPostalCode</b>.
Currently, this is only available for the Motors site (global ID EBAY-
MOTOR).
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="ListingType"></a>
Filters items based listing type information. Default behavior is to
return all matching items, except Store Inventory format listings.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
<blockquote>
<dl>
<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 with Buy It Now
available. Excludes auction listings without Buy It Now. An auction
listed with Buy It Now will not be returned if a valid bid has been
placed on the auction.
</dd>
<dt>Classified</dt>
<dd>Retrieves Classified Ad format (i.e., Classified and AdFormat
listing type) 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>
<br>
<b>Note: </b>Multiple listing type values can be specified
for this filter.
<br><br>
<b>Example:</b>
<br>
<pre>
...<br>
&itemFilter(0).name=ListingType<br>
&itemFilter(0).value(0)=AuctionWithBIN<br>
&itemFilter(0).value(1)=FixedPrice<br>
&itemFilter(0).value(2)=StoreInventory<br>
...
</pre>
<br>
<a name="LotsOnly"></a>
If true, the search results are limited to only matching listings for
which the lot size is 2 or more. Default is false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="MaxBids"></a>
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.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 0.
<br><br>
<a name="MinBids"></a>
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.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 0.
<br><br>
<a name="MaxPrice"></a>
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
<b class="con">paramName</b> and <b class="con">
paramValue</b> fields (e.g.,
<code>¶mName=Currency¶mValue=EUR</code>). If
using with MinPrice to specify a price range, the MaxPrice value must be
greater than or equal to MinPrice.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#decimal">decimal</a>):</b>
<br>
Decimal values greater than or equal to 0.0.
<br><br>
<a name="MinPrice"></a>
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
<b class="con">paramName</b> and <b class="con">
paramValue</b> fields (e.g.,
<code>¶mName=Currency¶mValue=EUR</code>). If
using with MaxPrice to specify a price range, the MaxPrice value must be
greater than or equal to MinPrice.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#decimal">decimal</a>):</b>
<br>
Decimal values greater than or equal to 0.0.
<br><br>
<a name="PaymentMethod"></a>
Limits results to items that accept the specified payment method.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):
</b><br>
Payment method
<br>
<a name="MaxQuantity"></a>
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.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 1.
<br><br>
<a name="MinQuantity"></a>
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.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 1.
<br><br>
<a name="Seller"></a>
Specify one or more seller names. Search results will include items from
the specified sellers only. The Seller item filter cannot be used
together with either the ExcludeSeller or TopRatedSellerOnly item
filters.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
Valid seller names.
<br><br>
<b>Note: </b>Multiple values are allowed. Up to 100 sellers
can be specified.
<br><br>
<b>Example:</b>
<br>
<pre>
...<br>
&itemFilter(0).name=Seller<br>
&itemFilter(0).value(0)=seller01<br>
&itemFilter(0).value(1)=seller02<br>
&itemFilter(0).value(2)=seller03<br>
...
</pre>
<a name="ExcludeSeller"></a>
Specify one or more seller names. Search results will not include items
from the specified sellers. The ExcludeSeller item filter cannot be used
together with either the Seller or TopRatedSellerOnly item filters.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
Valid seller names.
<br><br>
<b>Note: </b>Multiple values are allowed. Up to 100 sellers
can be specified.
<br><br>
<b>Example:</b>
<br>
<pre>
...<br>
&itemFilter(0).name=ExcludeSeller<br>
&itemFilter(0).value(0)=seller01<br>
&itemFilter(0).value(1)=seller02<br>
&itemFilter(0).value(2)=seller03<br>
...
</pre>
<a name="ExcludeCategory"></a>
Specify one or more category IDs. Search results will not include items
from the specified categories or their child categories.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
Valid category IDs.
<br><br>
<b>Note: </b>Multiple values are allowed. Up to 25 categories
can be specified.
<br><br>
<b>Example:</b>
<br>
<pre>
...<br>
&itemFilter(0).name=ExcludeCategory<br>
&itemFilter(0).value(0)=168093<br>
&itemFilter(0).value(1)=56170<br>
&itemFilter(0).value(2)=73834<br>
...
</pre>
<a name="WorldOfGoodOnly"></a>
If true, the search results are limited to only items listed in the World
of Good marketplace. Defaults to false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="MaxDistance"></a>
Specifies the maximum distance from the specified postal code (<b
class="con">buyerPostalCode</b>) to search for items. The
request must also specify <b class="con">buyerPostalCode</b>.
<br><br>
The minimum distance supported is 5 miles or 10 kilometers, depending
upon whether the distance unit supported for the site to which the
request is submitted is miles (mi) or kilometers (km). For example, the
smallest MaxDistance for searches submitted to the US eBay site (global
ID EBAY-US) is 5 (miles). The smallest MaxDistance for searches submitted
to the Germany eBay site (global ID EBAY-DE) is 10 (kilometers).
<br><br>
Values are rounded up to the nearest 5 (mi) or 10 (km) increment. For
example, a value of 21 will be rounded up to 25 (mi) on the eBay US site
and to 30 (km) on the eBay Germany site.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 5.
<br><br>
<a name="SellerBusinessType"></a>
Restricts the items to those that are from sellers whose business type is
the specified value. Only one value can be specified.
<br><br>
Not supported on all sites. Applies only to the following sites, which
support seller business features:
<ul>
<li>Austria (EBAY-AT)</li>
<li>Belgium - Dutch (EBAY-NLBE)</li>
<li>Belgium - French (EBAY-FRBE)</li>
<li>France (EBAY-FR)</li>
<li>Germany (EBAY-DE)</li>
<li>Ireland (EBAY-IE)</li>
<li>Italy (EBAY-IT)</li>
<li>Poland (EBAY-PL)</li>
<li>Spain (EBAY-ES)</li>
<li>Switzerland (EBAY-CH)</li>
<li>UK (EBAY-GB)</li>
</ul>
<br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):
</b><br>
<blockquote>
<dl>
<dt>
Business
</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>
<br>
<a name="TopRatedSellerOnly"></a>
If true, the search results are limited to only matching items where the
seller qualifies as a top-rated seller on the specified site. Site is
specified with the <a
href="../../Concepts/MakingACall.html#StandardURLParameters">global ID
header or URL parameter</a>. The default <a
href="../Enums/GlobalIdList.html ">global ID value</a> is EBAY-
US (the eBay US site). Default for this filter is false.
<br><br>
The TopRatedSellerOnly item filter cannot be used together with either
the Seller or ExcludeSeller item filters.
<br><br>
The TopRatedSellerOnly item filter is supported for the following sites
only: US (EBAY-US), Motors (EBAY-MOTOR), UK (EBAY-GB), IE (EBAY-IE), DE
(EBAY-DE), AT (EBAY-AT), and CH (EBAY-CH).
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="SoldItemsOnly"></a>
Reserved for future use.
If true, excludes all completed items which are not ended by being sold.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="CharityOnly"></a>
If true, the search results are limited to items for which all or part of
the proceeds are given to a charity. Each item in the search results will
include the ID of the given charity. Default is false.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="ListedIn"></a>
The site on which the items were originally listed. This can be useful
for buyers who wish to
see only items on their domestic site either for delivery cost reasons or
time reasons, such as for gifting
occasions like birthdays or holidays.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../Enums/GlobalIdList.html">Global ID
Values</a>):</b>
<br><br>
GlobalID Value
<br><br>
<a name="ExpeditedShippingType"></a>
Specifies the type of expedited shipping. You can specify
either Expedited or OneDayShipping. Only items that can be shipped
by the specified type are returned.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
Expedited, OneDayShipping
<br><br>
<a name="MaxHandlingTime"></a>
Specifies the maximum number of handling days the seller requires to ship
the item. Only items with a handling time less than or equal to this
number will be returned. (The handling time is the amount of time, in
days, required by the seller to get the item ready to ship and handed off
to the actual carrier who does the delivery. It does not include the time
required by the carrier to deliver the item.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 1.
<br><br>
<a name="ReturnsAcceptedOnly"></a>
If set to true, returns only items where the seller accepts returns.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
<a name="ValueBoxInventory"></a>
<b>Coming Soon: </b>
This filter can be used in conjunction with the sortOrder
PricePlusShippingLowest to return competitively priced items from eBay
top-rated sellers that have a BuyItNow price, with the lowest priced item
at the top of the list. This filter returns items from categories that
are catalog-enabled; items from non catalog-enabled categories are not
returned. Sellers can use this item filter to determine competitive
pricing; buying applications can use it to obtain competitive items from
top rated sellers that are likely to sell quickly.
<br><br>
If set to 1, the item filter constraints are applied and the items are
returned accordingly. If set to 0 (zero) the item filter is not applied.
Defaults to 0.
<br><br>
<b>Allowed values (<a
class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
1, 0
<br><br>
<a name="OutletSellerOnly"></a>
If set to true, returns only items listed by outlet sellers.
If set to true, returns only items listed by authorized sellers
<a name="StartTimeFrom"></a>
Limits the results to items started on or after the specified time.
Specify a time in the future.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#dateTime">dateTime</a>):</b>
<br>
Specify the time in GMT.
<br><br>
<a name="StartTimeTo"></a>
Limits the results to items started on or before the specified time.
Specify a time in the future.
<br><br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#dateTime">dateTime</a>):</b>
<br>
Specify the time in GMT.
<br><br>
This type contains the type (e.g kg,lb) and quantity of the unit.
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.
Include a ConditionHistogram container with the number of
items found per condition (e.g., 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).
Include the GalleryInfoContainer, which contains URLs for three thumbnail
images of the item in different sizes: large, medium, and small.
Include item's picture url with size 800x800
URL for item's picture url with size 400x400
Unit price type and quantity
Monetary amount.
Currency in which the monetary amount is specified.
Always
Enums/currencyIdList.html
currencyId Values
a list of currencyId enumeration values
Contains details about a category.
The unique ID of a category on the specified eBay site.
10
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
searchResult.item.primaryCategory
outputSelector: none
Always
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
searchResult.item.secondaryCategory
outputSelector: none
Conditionally
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsIneBayStores
categoryHistogramContainer.categoryHistogram
categoryHistogramContainer.categoryHistogram.childCategoryHistogram
outputSelector: CategoryHistogram
Conditionally
getHistograms
Conditionally
Display name of a category as it appears on the eBay Web site.
30
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
searchResult.item.primaryCategory
outputSelector: none
Always
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
searchResult.item.secondaryCategory
outputSelector: none
Conditionally
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsIneBayStores
categoryHistogramContainer.categoryHistogram
categoryHistogramContainer.categoryHistogram.childCategoryHistogram
outputSelector: CategoryHistogram
Conditionally
getHistograms
Conditionally
Information that describes an item's condition.
The numeric ID (e.g., 1000) for the item condition.<br>
<br>
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
(e.g., most Antiques categories don't). <br>
<br>
If you Condition as a <strong>itemFilter</strong>, the response returns items
with the correctly matching condition(s), even if <strong>conditionId</strong> is
not returned.
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsByImage
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none, ConditionHistogram
Conditionally
getHistograms
Conditionally
Item Condition IDs and Names
Enums/conditionIdList.html
a list of display names and the typical meaning of each condition
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).<br>
<br>
In item results, this is only returned when the seller specified the item's condition
using a structured format eBay recognizes.<br>
<br>
<b>When conditionId is also present:</b>
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.<br>
<br>
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.<br>
<br>
<b>In condition histograms:</b> 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.
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.<br>
<br>
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.
50
findItemsByCategory
findItemsAdvanced
findItemsByImage
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none
Conditionally
getHistograms
Conditionally
Item Condition IDs and Names
Enums/conditionIdList.html
a list of display names and the typical meaning of each condition
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
Conditionally
Container for URLs of thumbnail images for an item.
URL for a single item image thumbnail of a specific size.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Always
Values that can be used to describe relative sizes of item thumbnail images.
Small sized thumbnail image. Small images are up to 80 pixels on the longest side.
Medium sized thumbnail image Medium images are up to 96 pixels on the longest side.
Large sized thumbnail image. Large images are up to 140 pixels on the longest side.
Defines the image URL returned in galleryInfoContainer.
Relative size (Large, Medium, or Small) of the image thumbnail for the
item.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
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).
<br><br>
buyItNowAvailable will return "false" if the listing type is anything but
"AuctionWithBIN". Please ignore buyItNowAvailable for fixed-price
listings.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
<br><br>
For Basic Fixed-Price (FixedPrice), Store Inventory (StoreInventory), Ad
Format (AdFormat), and Classified Ad (Classified) listings, currentPrice
is the current fixed price.
<br><br>
Only returned if an item was listed with Buy It Now.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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).
<br><br>
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.
<br><br>
Only returned if an item was listed with Buy It Now.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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).
</span>
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
The format of the listing, such as online auction, fixed price, or
advertisement.
<dl>
<dt>
<strong>listingType values:</strong>
</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>
</dl>
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
If true, a generic gift icon displays next the listing's title in search
and browse pages.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
The number of users that have added the item to their watch list.
0
findItemsAdvanced
outputSelector: none
Conditionally
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)
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Always
Name of the item as it appears in the listing title, or in search and
browse results.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Always
Enums/GlobalIdList.html
Global ID Values
a list of possible enumeration values and how they map to eBay
sites
Subtitle of the item. Only returned if the seller included a subtitle for
the listing.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: GalleryInfo
Conditionally
The URL to view this specific listing on eBay.
<br><br>
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.
<br><br>
If you enabled affiliate tracking in the call, viewItemURL contains a
string that includes affiliate tracking information.
<br><br>
<span class="tablenote"><strong>Note:</strong>
eBay URLs returned in fields, such as <b
class="con">viewItemURL</b>, 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.
</span>
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
https://www.ebaypartnernetwork.com
eBay Partner Network
more information
A unique identification number assigned by eBay to a registered
non-profit charity organization.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
../../XML/docs/Reference/eBay/GetCharities.html
GetCharities in the Trading API
information to retrieve details on a specific charity
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.
<br><br>
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.
<br><br>
This productId value can be used as input with findItemsByProduct to
retrieve items that were listed with the specified eBay catalog product.
<br><br>
This field is only returned when a product was used to list the item.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
Identifies the payment method (or methods) available to the buyer to purchase the item.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
../../shopping/docs/CallRef/types/BuyerPaymentMethodCodeType.html
BuyerPaymentMethodCodeType in the Shopping API
a complete list of possible paymentMethod response values
If true, the seller requires immediate payment for the item. If false (or
not specified), immediate payment is not requested.
<br><br>
Immediate payment does not apply to classified listings nor to auction listings that end with a winning bidder.
<br><br>
<span class="tablenote"><strong>Note:</strong>
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.
</span>
<br>
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Always
The postal code where the listed item is located. This field is returned
only if a postal code has been specified by the seller. Sellers set a postal code
(or zip code in US) for items when they are listed. The postal code is used for
calculating proximity searches. It is anonymized when returned via the API.
<br><br>eBay proximity and local search behavior can use the combination of buyerPostalCode and postalCode values.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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).
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
Two-letter ISO 3166 country code to indicate the country where the item
is located (e.g., "US" for the United States or "GB" for the United
Kingdom).
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
https://www.iso.org/iso-3166-country-codes.html
English country names and code elements
country names and corresponding ISO 3166 codes
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: StoreInfo
Conditionally
Information about the item's seller. Only returned if SellerInfo is
specified in the outputSelector field in the request.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: SellerInfo
Conditionally
Container for data about a listing's shipping details.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
Specifies the item's selling status with regards to eBay's processing
workflow.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
The format type of the listing, such as online auction, fixed price, or
advertisement.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
This is set to true if the seller accepts return of the item.
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
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 magifying glass
icon. This field is only returned when the seller has opted for
the Gallery Plus option for the given item.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
Starting in March 2010, parts compatibility will be supported in limited
Parts & Accessories categories for eBay Motors in the Production
environment. For these categories, a compatible application will always
be a vehicle, which is specified by a combination of make, model, and
year. Optionally, trim and engine data may also be specifed for a
vehicle.
<br><br>
This field returns terms from the keywords in the request that match
values in one of the item's compatible applications (vehicles). If the
keywords match more than one compatible application for an item, the
field returns "Two or more of your vehicles" to indicate multiple
matches.
<br><br>
For example, keyword queries that contain vehicle details, such as make
and model (e.g., Honda Accord), in addition to keywords for the part or
accessory, will search through structured parts compatibility information
for matching listings. If an item has a 2007 Honda Accord (any trim or
engine) specified as a compatible application, and the item matches the
part or accessory terms in the query, this field will return the matching
terms from the query (i.e., Honda Accord).
<br><br>
Parts compatibility is an eBay feature that uses structured data to
associate compatible assemblies with parts and accessories listed on
eBay. For example, parts compatibility enables sellers to specify
accurately and comprehensively the vehicles on which a side mirror or a
rim fit. Parts compatibility improves search relevancy and frees up item
titles and descriptions for more useful descriptions of the part.
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
outputSelector: none
Conditionally
Listing Items with Parts Compatibility
http://developer.ebay.com/DevZone/guides/features-guide/Development/CompatibleParts.html
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.
<br><br>
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
This container shows the name and unique ID of the item's condition. This container will generally get returned unless the item is in an eBay category that does not require an item condition. Supported item conditions vary by category.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
return true if the item is a multi-variation listing
The format type of the listing, such as online auction, fixed price, or
advertisement.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
URL for item's picture url with size 800x800
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none
Conditionally
URL for item's picture url with size 400x400
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none
Conditionally
Unit price information of the item
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none
Conditionally
item attribute
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none
Conditionally
Indicates whether the item is Top Rated Plus item. A top rated plus
item:
<ul>
<li> is listed by experienced sellers with highest buyer ratings;/li>
<li>Sellers commit to shipping your items in a business day with tracking provided and offer at least a 14-day, money-back return policy;/li>
This field is returned for the following sites only: US (EBAY-US)
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none
Conditionally
https://pages.ebay.com/topratedplus/index.html
Top Rated Plus item page
eek status of the item
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none
Conditionally
Indicates whether the item is ebayPlus item. This field is returned for the following sites only: DE (EBAY-DE), AU (EBAY-AU)
findItemsByCategory
findItemsAdvanced
findItemsByKeywords
findItemsIneBayStores
findItemsByProduct
findCompletedItems
outputSelector: none
Conditionally
Container for information about this listing's seller.
The seller's eBay user name; a unique value.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: SellerInfo
Conditionally
The percentage value of a user's positive feedback (their positive
feedbackScore divided by their total positive plus negative feedback).
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: SellerInfo
Conditionally
Visual indicator of user's feedback score.
<dl>
<dt>
<strong>feedbackRatingStar values:</strong>
</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>
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: SellerInfo
Conditionally
Indicates whether the seller of the item is top-rated. A top-rated
seller:
<ul>
<li>Consistently receives highest buyers' ratings</li>
<li>Ships items quickly</li>
<li>Has earned a track record of excellent service</li>
</ul>
eBay regularly reviews the performance of these sellers to confirm
they continue to meet the program's requirements.
<br><br>
This field is returned for the following sites only: US (EBAY-US), Motors
(EBAY-MOTOR), DE (EBAY-DE), AT (EBAY-AT), and CH (EBAY-CH).
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: SellerInfo
Conditionally
https://pages.ebay.com/topratedplus/index.html
Top-rated Sellers page
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.
<br><br>
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.
<br><br>
For Basic Fixed-Price (FixedPrice), Store Inventory (StoreInventory), Ad
Format (AdFormat), and Classified Ad (Classified) listings, currentPrice
is the current fixed price.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
The listing's current price converted to the currency of the site
specified in the find request (globalId).
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
The number of bids that have been placed on the item.
0
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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>
<strong>sellingState values:</strong>
</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>
<dt>
EndedWithSales
</dt>
<dd>
The listing has been ended with sales.
</dd>
<dt>
EndedWithoutSales
</dt>
<dd>
The listing has been ended without sales.
</dd>
</dl>
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
Container holding the item's shipping details.
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).
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
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>
<strong>shippingType values:</strong>
</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>
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
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.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
Enums/shipToLocationList.html
shipToLocations
a complete list of shipping locations
This is returned set to true if expedited shipping is available for the item.
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
This is returned set to true if one-day shipping is available for the item.
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
The number of days it will take the seller to ship this item.
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: none
Conditionally
Denotes whether the item is a storefront listing.
The name of the seller's eBay Store.
200
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: StoreInfo
Conditionally
The URL of the seller's eBay Store page.
findCompletedItems
findItemsAdvanced
findItemsByCategory
findItemsByImage
findItemsByKeywords
findItemsByProduct
findItemsIneBayStores
outputSelector: StoreInfo
Conditionally
This type contains the item attribute name and value.
1.13.0