Returns Best Match information about items in eBay stores based on a specified
set of keywords, a category ID, or both.
Returns Best Match information about items in eBay stores based on a specified
set of keywords, a category ID, or both.
Specify one or more words to use as a search query for finding Best Match
information about items in eBay stores. By default, keyword queries search item
titles only. If you repeat this field in the request, the BestMatchItemDetails
Service only recognizes the last keywords field.
<br> <br>
The words "and" and "or" are treated like any other words; use "and", "or",
or "the" only if you are searching for listings that contain these words.
<br> <br>
You can incorporate wildcards into a multi-word search, such as "ap*%20ip*".
In this case, the response can contain results for "apple ipod", among other
matches. For a list of valid wildcard characters, see <a href=
"../Concepts/BestMatchItemDetailsAPIGuide.html#usekeywords"
>Searching by Keywords</a>.
<br> <br>
If you are using a URL request and your keyword query consists of multiple
words, use "%20" separate the words. For example, use Harry%20Potter to search
for items containing those words, in any order.
<br> <br>
While you must specify keywords with a findBestMatchItemDetailsAcrossStore call,
you can combine keywords with a categoryId.
findBestMatchItemDetailsAcrossStores
Yes
The category from which you want to retrieve Best Match
information. Also returns information on all children of the
specified category. If you repeat this field in the request, the
BestMatchItemDetails Service only recognizes the last categoryId
field.
<br> <br>
If the specified category ID doesn't match an existing site
category, the service returns an invalid-category error message.
<br> <br>
While you must specify keywords with a
findBestMatchItemDetailsAcrossStore call, you can combine keywords
with a categoryId in a request.
findBestMatchItemDetailsAcrossStores
Conditionally
The response container for the findBestMatchItemDetailsAcrossStores call.
Analysis of the Best Match items that appear on the first page of the result
set.
findBestMatchItemDetailsAcrossStores
outputSelector: FirstPageSummary
Always
Returns Best Match information about items based on a specified set of keywords,
a category ID, or both.
Returns Best Match information about items based on a specified set of keywords,
a category ID, or both.
Specify one or more words to use as a search query for finding Best Match
information. By default, keyword queries search item titles only. If you repeat
this field in the request, the BestMatchItemDetails Service only recognizes the
last keywords field.
<br> <br>
The words "and" and "or" are treated like any other words; use "and", "or",
or "the" only if you are searching for listings that contain these words.
<br> <br>
You can incorporate wildcards into a multi-word search, such as "ap*%20ip*".
In this case, the response can contain results for "apple ipod", among other
matches. For a list of valid wildcard characters, see <a href=
"../Concepts/BestMatchItemDetailsAPIGuide.html#usekeywords"
>Searching by Keywords</a>.
<br> <br>
If you are using a URL request and your keyword query consists of multiple words,
use "%20" separate the words. For example, use Harry%20Potter to search for items
containing those words, in any order.
<br> <br>
findBestMatchItemDetailsAdvanced queries require that you specify keywords,
a category ID, or both.
findBestMatchItemDetailsAdvanced
Conditionally
The category from which you want to retrieve Best Match
information. Also returns information on all children of the
specified category. If you repeat this field in the request, the
BestMatchItemDetails Service only recognizes the last categoryId
field.
<br> <br>
You must specify either keywords, a category ID, or both with a
findBestMatchItemDetailsAdvanced call.
<br> <br>
If the specified category ID doesn't match an existing site
category, the service returns an invalid-category error message.
findBestMatchItemDetailsAdvanced
Conditionally
Response container for the findBestMatchItemDetailsAdvanced call.
Analysis of the Best Match items that appear on the first page of the result
set.
findBestMatchItemDetailsAdvanced
outputSelector: FirstPageSummary
Always
Returns Best Match information about items based on a specified category ID.
Returns Best Match information about items based on a specified category ID.
The category from which you want to retrieve Best Match
information. Also returns information on all children of the
specified category. If you repeat this field in the request, the
BestMatchItemDetails Service only recognizes the last categoryId
field.
<br> <br>
If the specified category ID doesn't match an existing site
category, the service returns an invalid-category error message.
findBestMatchItemDetailsByCategory
Yes
Response container for the findBestMatchItemDetailsByCategory call.
Analysis of the Best Match items that appear on the first page of the result
set.
findBestMatchItemDetailsByCategory
outputSelector: FirstPageSummary
Always
Returns Best Match information about items based on a specified set of keywords.
Returns Best Match information about items based on a specified set of keywords.
Specify one or more words to use as a search query for finding Best Match
information. By default, keyword queries search item titles only. If you repeat
this field in the request, the BestMatchItemDetails Service only recognizes the
last keywords field.
<br> <br>
The words "and" and "or" are treated like any other words; use "and", "or",
or "the" only if you are searching for listings that contain these words.
<br> <br>
You can incorporate wildcards into a multi-word search, such as "ap*%20ip*".
In this case, the response can contain results for "apple ipod", among other
matches. For a list of valid wildcard characters, see <a href=
"../Concepts/BestMatchItemDetailsAPIGuide.html#usekeywords"
>Searching by Keywords</a>.
<br> <br>
If you are using a URL request and your keyword query consists of multiple
words, use "%20" separate the words. For example, use Harry%20Potter to search
for items containing those words, in any order.
findBestMatchItemDetailsByKeywords
Yes
Response container for the findBestMatchItemDetailsByKeywords call.
Analysis of the Best Match items that appear on the first page of the result
set.
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Returns Best Match information about items based on a specified product ID.
Returns Best Match information about items based on a specified product ID.
Specify the Product Type and Product ID for the items on which you want to find
Best Match information. If you repeat this field in the request, the
BestMatchItemDetails Service only recognizes the last productId field.
findBestMatchItemDetailsByProduct
Yes
Response container for the findBestMatchItemDetailsByProduct call.
FirstPageSummary information is not currently returned for products.
Returns Best Match information about items associated with the authorized caller.
Returns Best Match information about items associated with the authorized caller.
User name of the seller whose item listings you want to review. If
sellerUserName equals the name of the authorized caller of the function, the
Service also returns Best Match information about the items returned.
findBestMatchItemDetailsBySeller
Yes
The category from which you want to retrieve Best Match
information. Also returns information on all children of the
specified category. If you repeat this field in the request, the
BestMatchItemDetails Service only recognizes the last categoryId
field.
<br> <br>
If the specified category ID doesn't match an existing site
category, the service returns an invalid-category error message.
findBestMatchItemDetailsBySeller
Yes
Controls the pagination of the result set. Elements of this type 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 number of pages allowed (100) and the maximum number of
entries per page (100).
</span>
<br>
findBestMatchItemDetailsBySeller
No
Reduces the number of items returned in the response according to the
filters you specify.
findBestMatchItemDetailsBySeller
No
Specifies whether or not to include Featured items in the response.
The value is false by default (Featured items are included in
the response).
false
findBestMatchItemDetailsBySeller
No
Response container for the findBestMatchItemDetailsBySeller call.
Indicates the pagination of the result set. Child elements
indicate the page number that is returned, the maximum number of
items returned in the page (as specified), the total number of pages
that can be returned, and the total number of listings that match
the search criteria.
findBestMatchItemDetailsBySeller
Always
Returns Best Match information about items matching specified item ID values.
Returns Best Match information about items matching specified item ID values.
Specifies the item for which you want inspect the Best Match details.
Repeat this element to review more than a single item. Incorrect and/or
duplicate item IDs are ignored.
<br> <br>
Enter up to 50 itemId values in the call.
getBestMatchItemDetails
Yes
Response container for the getBestMatchItemDetails call.
Container for the details of an item returned from the search query.
getBestMatchItemDetails
Always
Returns the version of the current BestMatchItemDetails Service.
<br>
You can also use this call as a ping to ensure you have a connection to the
server.
Returns the version of the eBay BestMatchItemDetails server.
Base request container for the BestMatchItemDetails Service.
Base request container for the BestMatchItemDetails Service.
This value corresponds to the "Items Per Page" selector on the eBay site
where you can select to view 25, 50, 100, or 200 items on a results page.
<br> <br>
siteResultsPerPage does not specify how many items to return from your
BestMatchItemDetails queries. Instead, the value specifies how many entries
to assess in the FirstPageSummary report.
<br> <br>
Because FirstPageSummary takes into account only Best Match items (the
report does not include Featured items), siteResultsPerPage takes effect
when the number of Best Match items returned in a query is greater than the
value set for siteResultsPerPage. In this case,
firstPageSummary.searchResultsSampleSize is trimmed to the value set in
siteResultsPerPage.
<br> <br>
To best correlate your FirstPageSummary results with what appears on the
eBay site, mimic the values available on the site and set the value of
siteResultsPerPage to 25, 50, 100, or 200.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
Yes
Specifies the total number of unique items returned per page in the
result set. Because a single item can be listed in both the
Featured and Best Match groups, and because items can be listed
with different variations, it is possible for a single item to be
returned in multiple item containers. This can result in more item
containers returned than the number you specify in entriesPerPage.
<br> <br>
If you do not specify an entriedPerPage value, the service returns
all items matching your query. Maximum value is 1000.
1000
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
No
Specifies whether or not to include Featured items in the response.
The value is false by default (Featured items are included in
the response).
false
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
No
Reduces the number of items returned in the response according to the
filters you specify.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
No
Specifies fields that you want returned in the response. The fields returned
by the specified output selector are returned in addition to the default set
of response fields.
Yes
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
No
Return only the items that match the specified itemId values.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
No
Return only items matching the specified sellerUserName values.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
No
Base response container for all Search flow operations.
Container for the list of returned items. The items are sorted
according to where they appear on search page: in the Featured
or Search Result (BestMatch) group, or under Condition.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
Contains the returned item group listing along with total count.
Container for items that match the associated itemGroupName parameter.
For search and non-media PDP, it contains featured and mixed result-set
groups. For media PDP, it contains item condition groups: Brand New,
Like New, Very Good, Good and Acceptable.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
Total number of items in all item groups that match the query.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Conditionally
Total number of items returned. Not returned if no items match
the search query (totalEntries=0). This value is usually equal to
the input value for entriesPerPage, unless the query matches fewer
items than the value specified for entriesPerPage.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
Conditionally
Container for items that match the associated itemGroupName parameter. For
search and non-media PDP items, it contains featured and mixed result-set
groups. For media PDP items, it contains item condition groups.
Container for the details pertaining to a single item listing.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
Criteria according to which the items in the container are grouped. Within
searchItemGroup elements, the possible values are Placement (which means
placement in the result set, under the Featured results or under
the Best Match results) and Condition (for media products).
Within itemGroupSummary elements, the value is always Format.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
Name of the group to which the group of items belongs. Possible values are BestMatch
and featured. Also, for Media products, the itemGroupName can be the product
condition: Brand New, Like New, Very Good, Good, and Acceptable.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
Number of items in the group.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
Container for data describing an item listing.
Absolute rank of the item, across the groups, in relation to
all returned items.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
Rank of the item in relation to the other returned items in the
same group. Item groups are Featured and Best Match. For media items,
groups can be Brand New, Like New, Very Good, Good, and Acceptable.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
Quantity of available items in the listing.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
Number of listing items sold.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
Container for the best match data for the item. This data is
returned only for items that belong to the authorized caller; the
service does not return Best Match data for items that were not
listed by the caller of the function.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Container for an item's BestMatch data.
If true, the item is considered a free shipping item by BestMatch.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Total number of times the item surfaced on a search results page. The
impression count is returned as a range.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Number of item sales. Note that a single sale can include one or more
items.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Number of unique item views.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Number of watches placed on the item.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Ratio of sale transactions to the mid-point (between the minimum and maximum
number) of the impression range. Note that the number of items sold can exceed
the number of transactions (sales) if a single sale has an item quantity
greater than one. An "impression" is any time a buyer sees a search results
page that includes the listing. Impression counts can be greater than unique
item views.
<br> <br>
Note that salesPerImpression impacts Best Match results for only Fixed Price
items.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Ratio of sales to unique views of the item.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Ratio of unique item-views to the mid-point of the impression range.
An "impression" is any time a buyer sees a search results page that
includes the listing whereas "unique views" counts each user only once.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Container for information on each item group format.
Number of items included in the FirstPageSummary analysis.
<br> <br>
The First Page Summary includes only Best Match items (it does not include Featured
items). With this, searchResultSampleSize equals whichever is less: the number of
Best Match items returned in the response or the number set in siteResultsPerPage.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Minimum and maximum current prices for the items on first page.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Shipping price range (minimum and maximum costs) for the items on the first page.
Minimum and maximum ending times for the items on the first page.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Number of catalog items on the first page.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Number of items on the first page that belong to a Top-Rated Seller.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Number of free shipping items for the current format (group).
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Format (group) for which the data is being returned.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Name of the group. Current group values are Auction and FixedPrice.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Number of items in the sample belonging to this group.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Used to specify minimum/maximum Amount ranges (for example, a price range).
Minimum amount value.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Maximum amount value.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Used to specify minimum/maximum specify Duration ranges (for example,
Begin and End times).
Minimum time duration value.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Maximum time duration value.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Container for an analysis about the Best Match items that appear on the first page
of the query response.
Container for one of the listing formats covered in the FirstPageSummary
analysis. The listing formats are Auction and Fixed Price, and the analysis
of each includes information such as price, shipping costs, and so on.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
outputSelector: FirstPageSummary
Always
Output Selector values that you can use to retrieve information in addition to
the default set of response fields in the search result.
Includes seller information for each item in the response.
<br>
See <a href="#detailControls">Detail Controls</a> for more
information on the information returned with this Output Selector.
Includes an analysis of the Best Match items that appear on the first page of
the result set. The analysis is presented at the bottom of the query response
and sorts items into two listing-format groups: Auction and Fixed Price. In this
analysis, AuctionWithBIN items are grouped with Auction items and StoreInventory
items are grouped with Fixed Price items.
<br>
See <a href="#detailControls">Detail Controls</a> for more information
on the information returned with this Output Selector.
<br> <br>
<span class="tablenote"><strong>Note:</strong>
FirstPageSummary is not currently supported with
findBestMatchItemDetailsByProduct.
</span>
<br>
Distance value used for proximity searches.
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 the 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.
<br> <br>
Not supported by the BestMatchItemDetails Service.
Container for 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). Buyers must
use the eBay Web site to make a Best Offer.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
Used with competitive-bid auctions, the associated item includes a Buy It
Now option if this value returns true. Buy It Now lets a user purchase
the item at a fixed price, effectively ending the auction. On most sites,
the Buy It Now option is removed (and this value returns false) once a
valid bid is made on the associated item (a valid bid could be a bid
above the reserve price).
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
The Buy It Now Price of the item (if any), in the currency of the site on
which the item was listed. You can use this field to determine if the
item was originally listed with Buy It Now, even if the Buy It Now option
is no longer available for the item.
<br/> <br>
Only returned if an item was listed with Buy It Now.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
The listing's Buy It Now Price (if any), converted into the currency of
the site to which you sent your search request. For active items, refresh
this value every 24 hours to pick up possible changes in conversion rates.
<br> <br>
Price fields are returned as doubles, and 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.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
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.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
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>
<br>
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
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 the 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 AdFormat listings.
</dd>
<dt>Auction</dt>
<dd>
Competitive-bidding 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 enabled. On
some sites, this auction format is also known as "Buy It Now Only"
(do not confuse this with the Buy It Now option available on
competitive-bidding auctions). Fixed-price listings appear on
eBay.com and they can be listed in a seller's eBay Store (if the
seller is a Store owner).
</dd>
<dt>StoreInventory</dt>
<dd>
A fixed-price format for eBay Store sellers. Store Inventory
listings appear after other listings in regular search and browse
pages on eBay. Store items have a lower Insertion Fee and longer
listing durations. This selling type can only be specified by
sellers who have an eBay Store. Store Inventory listings are listed
on eBay.com as well as in the seller's eBay Store.
</dd>
</dl>
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
If true, a small gift icon displays next the listing's title in search
and browse pages.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
An item in a catalogue. Products can be one of four types:
ISBN, UPC, EAN, or eBay Product Reference ID (ePID).
An item in a catalogue. Products can be one of four types: ISBN, UPC,
EAN, or eBay Product Reference ID (ePID). When searching by product, use
filters to further restrict and refine results.
Specifies or returns the product type and product ID.
<dl>
<dt>
<strong>productId types:</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>
<br>
For example:
<ul>
<li>To search using an ISBN, specify productID.type=ISBN and set
productID.value to an ISBN value.</li>
<li>To search using an eBay Product Reference ID, specify
productID.type=ReferenceID and set productID.value to an eBay
Product Reference ID (ePID) value. If you do not know the eBay
Product Reference ID of a product, use the Shopping FindProducts
call to retrieve the desired ePID value.</li>
</ul>
findBestMatchItemDetailsByProduct
Yes
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Container for information pertaining to an item listing.
An identification number that uniquely identifies a listed item. eBay
generates this ID when an item is listed and the ID is unique across
all eBay sites.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
Name of the item listing as it appears in search and browse results.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
A token that represents the eBay site on which the item was originally
listed. For example, if the item was listed on the eBay US site, the
value is US. If item was listed on the eBay Germany site, the value is
DE. For a list of possible enumeration values and how they map to eBay
sites, see <a href="Enums/GlobalIdList.html">Global ID Values<
/a>.
<br> <br>
Where the item was listed can affect the values of converted
(localized) prices. This occurs when the site from which your request
is sent is different from the site on which the item was listed.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
Subtitle of the item. Only returned if the seller included a subtitle with
the listing.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
Conditionally
getBestMatchItemDetails
item
Conditionally
Container for the numeric ID and name of the first (or only) category in which the
item is listed. Note that listings can appear in more than a single category.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
Container for the numeric ID and name of the second category in which the
item is listed, if the seller listed in a secondary category.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
Conditionally
getBestMatchItemDetails
item
Conditionally
URL for the picture used for the Gallery thumbnail, if any. The image uses one of the
following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose
to show a gallery image.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
Conditionally
getBestMatchItemDetails
item
Conditionally
The URL to view this listing on eBay. This URL is optimized to support
natural search. That is, this URL is designed to make items on eBay
easier to find via popular Internet search engines.
<br> <br>
Specifically, the URL specifies the item title and it is optimized for
natural search: " _W0QQ" is like "?" (question mark), "QQ" is like
"&" (ampersand), and "Z" is like "=" (equals sign). Do not modify
the returned URL syntax in your application. For example, eBay won't
recognize the URL if you change QQ to ?. In the Sandbox environment and
on the Hong Kong site (site ID 201), the data returned in this field is
a standard ViewItem URL, rather than the ViewItem URL for Natural
Search that is normally returned in the Production environment.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
A unique identification number assigned by eBay to registered nonprofit
charity organizations. Not returned if the item is not listed as a
charity item.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
Conditionally
getBestMatchItemDetails
item
Conditionally
Product ID type and product ID code if the item is a catalogue item.
Not returned if the item is not listed as a product.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
Conditionally
getBestMatchItemDetails
item
Conditionally
Identifies the payment method(s) the seller will accept from the buyer.
An example is PayPal.
<br> <br>
<strong>Note:</strong>
If the seller accepts only PayPal, the buyer can still pay with a
credit card. PayPal supports major credit cards.
<br> <br>
Payment methods are not applicable to eBay Real Estate advertisement
listings or other Classified Ad format listings.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
If true, the seller requests immediate payment for the item. If false
(or not specified), immediate payment is not requested. If true, it
does not indicate that the item is still a candidate for purchase via
immediate payment, however it does indicate the original status of the
item listing.
<br> <br>
Only applicable to items listed on PayPal-enabled sites and in
categories that support immediate payment (see AutoPayEnabled in
<a href=
"http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html"
>GetCategories</a>). In addition, the seller must have a Premier
or Business PayPal account (see PayPalAccountType in <a href=
"http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetUser.html"
>GetUser</a>) and they must accept PayPal as a payment method
(see item.paymentMethod).
<br> <br>
See the eBay Web Services guide section on <a href=
"http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AutoPay"
>Requiring Immediate Payment</a> for additional requirements
and dependencies. Also see the section on working with the eBay Motors
site for additional rules. Not applicable to Half.com.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
The postal code of where the item is located. Not returned if seller
did not specify their postal code.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
Conditionally
getBestMatchItemDetails
item
Conditionally
Physical location of the item, as specified by the seller. (This gives
a general indication of from where the item will be shipped or delivered.)
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
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=
"http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">
http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html</a>.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
Container for information about the eBay store in which the item was
listed. Not returned if the item is not listed in an eBay store.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
Conditionally
getBestMatchItemDetails
item
Conditionally
Container for information about the listing's seller. Returned if
outputSelector is set to SellerInfo.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: SellerInfo
Always
Container for information about the listing's shipping details.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
Signifies the listing's selling status in eBay's processing workflow.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
Container for listing information related to the item. The information
includes the item's listing format (online auction, fixed price,
and so on), if Buy It Now is enabled, and more.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
Always
getBestMatchItemDetails
item
Always
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 the 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.
<br> <br>
Not supported by the BestMatchItemDetails Service.
Contains details about a category (name and category ID).
The unique ID of a category on the specified eBay site.
primaryCategory
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
secondaryCategory
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
primaryCategory
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
secondaryCategory
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Display name of a category as it appears on the eBay Web site. This
is a fully qualified category breadcrumb (e.g., Computers &
Networking:Laptops, Notebooks).
primaryCategory
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
secondaryCategory
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
primaryCategory
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
secondaryCategory
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Container for information about the item's seller.
The seller's eBay user name; a unique value.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: SellerInfo
Always
findBestMatchItemDetailsBySeller
Always
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.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: SellerInfo
Always
The percentage value of a user's positive feedback (their positive
feedbackScore divided by their total positive plus negative feedback,
based on the past twelve-months).
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: SellerInfo
Always
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>
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: SellerInfo
Always
Indicates whether or not the seller is a Top-Rated Seller.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: SellerInfo
Always
Information about the current status of the 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),
and Ad Format (AdFormat) listings, currentPrice is the current fixed
price.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
The listing's current price converted to the currency of the site from
which the request is sent (the request's globalId value).
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
The number of bids that have been placed on the item. Returned only if
the selling format is an auction.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
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>
</dl>
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
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.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
Container for the item's shipping information.
The basic shipping cost of the item. Not returned if the shipping
method is calculated or free.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
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>
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
An international location or region to which the seller is willing to
ship the item. Returned only for items that have shipToLocations
specified. For a complete list of shipping locations, see <a href=
"Enums/shipToLocationList.html">shipToLocations</a>.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Returned if the item is listed in an eBay store.
The name of the seller's eBay Store.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
The URL of the eBay Store page.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Reduce the number of items returned by a find request using itemFilters.
Use the itemFilter container to specify itemFilter Name/Value pairs. You
can include multiple itemFilters in a single request to refine your
searches and to target specific items.
In addition to itemFilter 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.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
findBestMatchItemDetailsBySeller
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. For a list of
possible currency enumeration values, see <a
href="Enums/currencyIdList.html">currencyId Values</a>.
<br> <br>
Note that for MaxPrice and MinPrice itemFilters, the default value for
paramValue is USD.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
findBestMatchItemDetailsBySeller
No
Specify the name of the item filter you want to use. The itemFilter
name must have a corresponding value. You can apply multiple itemFilter
Name/Value pairs in a single request. See the <a
href="types/ItemFilterType.html">ItemFilterType</a> type
documentation for more information about the allowed values, usage
rules, and dependencies.
<br> <br>
Refer to the following samples to see itemFilters in action:
<br>
<a href=
"./findBestMatchItemDetailsAcrossStores.html#Samples"
>Using itemFilters to define a price range</a>
<br>
<a href=
"./findBestMatchItemDetailsByKeywords.html#Samples"
>Using itemFilters to search for used Buy It Now items</a>
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
findBestMatchItemDetailsBySeller
No
The value associated with the respective itemFilter Name.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
findBestMatchItemDetailsBySeller
No
Values that can be used for the itemFilter.name field.
Limits items to those that have the matching item condition. Only one
value can be specified.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
<blockquote>
<dl>
<dt>New</dt>
<dd>
The seller specified the Item Condition as New, or did not
specify a condition. (Excludes items that the seller listed as
Used.)
</dd>
<dt>Used</dt>
<dd>
The seller specified the Item Condition as Used, or did not
specify a condition. (Excludes items that the seller listed as
New.)
</dd>
</dl>
</blockquote>
<br> <br>
Limits results to items listed with the specified currency only.
<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="currencyIdList.html">currencyId Values</a>.
<br> <br>
Limits the results to items ending on or after the specified time.
Specify a time in the past. Item filter EndTimeFrom cannot be used
together with item filter EndTimeTo.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#dateTime">dateTime</a>):</b>
<br>
Specify the time in GMT.
<br><br>
Limits the results to items ending on or before the specified time.
Specify a time in the future. Item filter EndTimeFrom cannot be used
together with item filter EndTimeTo.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#dateTime">dateTime</a>):</b>
<br>
Specify the time in GMT.
<br><br>
If true, excludes all items requiring immediate payment. Default is
false.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
If true, search results will Return featured item listings only.
Default is false.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
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>
<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>
Specifies the minimum 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>
<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>
If true, the search results are limited to only items with free
shipping to the site specified in the request (see <a href=
"GlobalIdList.html">Global ID Values</a>). Default is false.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
If true, the search results are limited to only Get It Fast listings.
Default is false.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
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><br>
Item listings are considered duplicates when all of the following
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, Auction BIN items, Multi-Quantity
Auctions, and Multi-Quantity Auctions 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. Filtering of duplicate item listings is not
supported on all sites.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
Limits items to those available to the specified country only. Item
filter LocatedIn cannot be used together with item filter AvailableTo.
<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="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">
http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html</a>.
<br><br>
Limits the result set to just those items located in the specified
country. Item filter AvailableTo cannot be used together with item
filter LocatedIn.
<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="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">
http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html</a>.
<br><br>
If true, the search results are limited to only items which have local
pickup available. Default is false.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
If true, returns 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>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
Filters items based listing type information. Default behavior is to
return all matching items, except Store Inventory format listings.
<br><br>
Multiple listing type values can be specified for this filter.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
<blockquote>
<dl>
<dt>AdFormat</dt>
<dd>
Retrieve matching Ad Format listings only.
</dd>
<dt>Auction</dt>
<dd>
Retrieve matching auction listings (i.e., listings eligible for
competitive bidding at auction) only. Excludes auction items with
Buy It Now.
</dd>
<dt>AuctionWithBIN</dt>
<dd>
Retrieve all matching auction listings, including auction items
with Buy It Now.
</dd>
<dt>Classified</dt>
<dd>
Retrieves Classified Ad format listings only.
</dd>
<dt>FixedPrice</dt>
<dd>
Retrieve matching fixed price items only. Excludes Store
Inventory format items.
</dd>
<dt>StoreInventory</dt>
<dd>
Retrieve Store Inventory format items only.
</dd>
<dt>All</dt>
<dd>
Retrieve matching items for any listing type.
</dd>
</dl>
</blockquote>
<br><br>
If true, returns only matching listings for which the lot size is 2 or
more. Default is false.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
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>
<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>
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>
<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>
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>
<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>
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>
<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>
Limits results to items that accept specified payment methods.
<br><br>
Multiple values are allowed.
<br>
The item filter <b class="con">name</b> field can be
repeated ([0..3] for the PaymentMethod value. To limit results to items
that accept two payment methods, specify to separate item filters. To
limit results to items that accept one of two payment methods, specify
both payment method values in the same item filter.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
<blockquote>
<dl>
<dt>PayPal</dt>
<dd>
PayPal payment method.
</dd>
<dt>PaisaPay</dt>
<dd>
PaisaPay payment method. The PaisaPay payment method is only
for the India site (global ID EBAY-IN).
</dd>
<dt>PaisaPayEMI</dt>
<dd>
PaisaPayEscrow EMI (Equal Monthly Installment) payment method.
The PaisaPayEscrowEMI payment method is only for the India site
(global ID EBAY-IN).
</dd>
</dl>
</blockquote>
<br><br>
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>
<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>
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>
<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>
Specify one or more seller names. Search results will include items
only from the specified sellers.
<br>
Multiple values are allowed. Up to 100 sellers can be specified.
<br>
Item filter ExcludeSeller cannot be used together with item filter
Seller.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
Valid seller names.
<br><br>
Specify one or more seller names. Search results will not include items
from the specified sellers.
<br>
Multiple values are allowed. Up to 100 sellers can be specified.
<br>
Item filter ExcludeSeller cannot be used together with item filter
Seller.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
Valid seller names.
<br><br>
If true, returns only items listed in the World of Good marketplace.
Defaults to false.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#boolean">boolean</a>):</b>
<br>
true, false
<br><br>
Specifies the maximum distance from the specified postal code (<b
class="con">buyerPostalCode</b>) to search for items. Must be
used together with the <b class="con">LocalSearchOnly</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>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#int">int</a>):</b>
<br>
Integer greater than or equal to 0 and less than 3000.
<br><br>
Restricts the items returned to those that are from sellers whose business type is the
specified value Limits items to those that have the matching item condition. Only one
value can be specified.
<br>
This filter is applicable to UK, France, and Germany only. If the
filter is used for any other site, an error is returned.
<br>
<b>Allowed values (<a class="defn_type"
href="../types/simpleTypes.html#string">string</a>):</b>
<br>
<blockquote>
<dl>
<dt>Commercial</dt>
<dd>
The seller is registered as a business on eBay.
</dd>
<dt>Private</dt>
<dd>
The seller is registered as an individual on eBay.
</dd>
</dl>
</blockquote>
<br><br>
Restricts the items returned to those that are Top-Rated Sellers.
A minimum/maximum set of numeric values used to specify a range, such
as an impression count.
Minimum impression range value.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Maximum impression range value.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Conditionally
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Conditionally
Post process the search results to fetch only the item specified by the
item identification number(s).
The item identification number of the item you want to inspect. Repeat
the element if you want to inspect more than a single item. If this
element is not present, item filtering does not occur.
<br> <br>
The filter is applied after the search has completed--the Best
Match data associated with the returned items is not changed as a
result of the filtering.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
No
Post process the search results to fetch only items from the specified
seller(s).
User name of the seller whose items you want to inspect. Repeat the
element if you want to inspect items from more than a single seller.
If this element is not present, seller filtering does not occur.
<br> <br>
The filter is applied after the search has completed--the Best
Match data associated with the returned items is not changed as a
result of the filtering.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
No
Monetary amount of the transaction.
Currency in which the monetary amount is specified.
<br><br>
For a list of currencyId enumeration values, see
<a href="Enums/currencyIdList.html">currencyId Values</a>.
findBestMatchItemDetailsAcrossStores
findBestMatchItemDetailsAdvanced
findBestMatchItemDetailsByCategory
findBestMatchItemDetailsByKeywords
findBestMatchItemDetailsByProduct
outputSelector: none
Always
findBestMatchItemDetailsBySeller
getBestMatchItemDetails
Always
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
findBestMatchItemDetailsBySeller
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 of 100 is used.
100
findBestMatchItemDetailsBySeller
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.
findBestMatchItemDetailsBySeller
Always
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.
findBestMatchItemDetailsBySeller
Always
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.
findBestMatchItemDetailsBySeller
Always
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.
findBestMatchItemDetailsBySeller
Always
This is the base class container for all service operation requests.
Base response container for all service operations.
Contains error information associated with the request.
Indicates whether or not the request was successful, or if errors
or warnings were generated during the processing of the request.
Always
Description of an error or warning that occurred when eBay processed
the request. Not returned if the ack value is Success.
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>
<br>
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.
Always
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.
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.
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.
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 Merchandising
Service.
</dd>
<dt>SOA</dt>
<dd>
An exception occurred in the Service Oriented Architecture (SOA)
framework.
</dd>
</dl>
Conditionally
Name of the subdomain in which the error occurred.
<dl>
<dt><strong>subdomain values:</strong></dt>
<dt>Search</dt>
<dd>
The error is specific to the search services.
</dd>
<dt>MarketplaceCommon</dt>
<dd>
The error is common to all Marketplace services.
</dd>
</dl>
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.
Conditionally
There are three categories of errors: Request errors, Application
errors, and System errors.
Conditionally
A detailed description of the condition that caused in the error.
Conditionally
Unique identifier for an exception associated with an error.
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.
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 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.
Operation used to find items by Keywords only. The output will be a items grouped
into two groups: Featured and BestMatch. BestMatchGroup represents the items
sorted by BestMatch and will contain a maximum of 1000 items.
Used to find items by category ID only. The output will be a items
grouped into two groups: Featured and BestMatch. BestMatchGroup represents the
items sorted by BestMatch and will contain a maximum of 1000 items.
Used to find items by Keywords and/or CategoryId. The output will be a
items grouped into two groups: Featured and BestMatch. BestMatchGroup represents
the items sorted by BestMatch and will contain a maximum of 1000 items.
Used to find items by ProductId only. Supports the current Product Id types
(ISBN, UPC, EAN and ReferenceID). The output for media PDP pages is
grouped according to condition, with a maximum of 10 items per group (the
input value for entriesPerPage is not considered). For non-media PDP, output
is the same as that for search pages.
Used to find items across stores based on Keyword and/or category ID.
Used to return items for a seller based on a specific category ID.
Used to return Best Match details for the specified ItemIDs. The output contains
the list of item details. Ignores invalid ItemID values.
Used to get the version of the service.
This service is used to retrieve Best Match information about
the items for various Search flows.
1.1.0