eBay BestMatchItemDetails API
|
|
Deprecation Notice Beginning January 1, 2013, the Best Match Item Details API will no longer be available. eBay sellers will continue to have access to information about listing performance via the eBay Listing Analytics tool. If your application currently supports the Best Match Item Details API, please direct your users to eBay's Listing Analytics tool instead. |
You can find links to the BestMatchItemDetails API documentation in the top navigation bar. Information about the schema location is in the Schema Location section of the "Making an API Call" topic.
Are you just getting started with the BestMatchItemDetails API? The following describes how to join the eBay Developers Program:
| Version | Release Date | |
|---|---|---|
| 1.5.0 | 2010-04-14 | |
| 1.3.0 | 2010-01-20 | |
| 1.2.0 | 2009-11-11 | |
| 1.1.0 | 2009-10-23 | |
| 1.0.1 | 2009-09-30 |
Index of Changed Calls - 1.5.0
Documentation Changes and Errata - 1.5.0
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
Condition |
Complex type | New. Reserved for future use. |
ItemFilterType.BestOfferOnly |
Enum | New |
ItemFilterType.ExcludeCategory |
Enum | New |
ItemFilterType.ModTimeFrom |
Enum | New |
SearchItem.compatibility |
Element | New. Reserved for future use. |
SearchItem.condition |
Element | New. Reserved for future use. |
See the System Announcements for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1.5.0.
New item filters have been added to provide better refinement of search results:
See the ItemFilterType type documentation for more information about the allowed values, usage rules, and dependencies.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1.5.0 and Changed Functionality - 1.5.0.
The documentation has been updated to show that the entriesPerPage input field is not available for the findBestMatchItemDetailsByProduct call.
Index of Changed Calls - 1.3.0
Documentation Changes and Errata - 1.3.0
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
searchResult.searchItemGroup.item.compatibility |
Element | New |
See the System Announcements for bug fixes related to this release.
Note: This section includes configuration information where specific setup steps are needed.
As of January 15, 2010, eBay evaluates the CONTENT-TYPE header against the request payload format. If the CONTENT-TYPE value is incorrect for the payload, the request will fail. Previously, eBay did not validate the CONTENT-TYPE header in requests.
This HTTP header is optional. If you do not submit the CONTENT-TYPE header with your request, eBay will determine the content type from the payload.
The following table lists the correct CONTENT-TYPE header values for HTTP POST request formats. Also see Making An API Call.
| Request Payload Format | CONTENT-TYPE Value |
|---|---|
| XML | text/xml |
| SOAP11 | text/xml (together with the SOAPAction header, for which the value can be anything) |
| SOAP12 | application/soap+xml |
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1.3.0.
Parts compatibility is an eBay feature that uses structured data to associate assemblies (compatible applications) with parts and accessories listed on eBay. 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 a specific combination of make, model, and year. Optionally, trim and engine data may also be specifed for a compatible application. 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. Listings with parts compatibility information also get a Best Match boost in search results.
Parts compatibility can be specified by application or by specification. With parts compatibility by application, the seller specifies the application (e.g., year, make, and model of a specific vehicle) with which the part or accessory is compatible. With parts compatibility by specification, the seller specifies the dimensions and characteristics of the part or accessory (e.g., Section Width, Aspect Ratio, Rim Diammeter, Load Index, and Speed Rating values for a tire).
When parts compatibility (sometimes called fitment) data is available for items, keywords queries in the BestMatchItemDetails API will search this structured data, in addition to other listing information.
To search for items listed with compatibility information by application, include vehicle details, such as make and model (e.g., Honda Accord), in the keywords in addition to terms for the part or accessory. When there are matches, and the item was listed with compatibility information by application, the compatibility field in the response returns terms from the query that match values in one of the item's compatible applications (vehicles). If the query matches more than one compatible application for an item, the compatibility field returns "Two or more of your vehicles" to indicate multiple matches.
For example, if the query contains "Honda Accord" and a matching item has a 2007 Honda Accord (any trim or engine) specified as a compatible application, the compatibility field will return the matching terms from the query (i.e., Honda Accord).
To search for items listed with compatibility information by specification, include the part specifications, such as a tire's section width and aspect ratio (e.g., 225 45), in the keywords in addition to other terms for the part or accessory. The compatibility field is not returned for items listed with compatibility by specification.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1.3.0 and Changed Functionality - 1.3.0.
None for this release.
Index of Changed Calls - 1.2.0
Documentation Changes and Errata - 1.2.0
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
searchResult.searchItemGroup.item.galleryPlusPictureURL |
Element | New |
See the System Announcements for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1.2.0.
The search calls now return galleryPlusPictureURL for matching items that have been upgraded to use the Gallery Plus feature. Gallery Plus images are larger than 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 section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1.2.0 and Changed Functionality - 1.2.0.
The documentation for the SellerBusinessType item filter has been updated to list the correct filter value, Business, for sellers registered as a business on eBay.
The documentation for the Condition item filter has been updated to include the filter value, Unspecified, for restricting search results to listings for which item condition was not specified.
Index of Changed Calls - 1.1.0
Documentation Changes and Errata - 1.1.0
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
getVersionRequest |
Element | New |
GetVersionRequest |
Complex type | New |
None for this release.
None for this release.
A request element as been added for getVersion. This change is not backwards compatible.
None for this release.
This is the first release of the eBay BestMatchItemDetails API. For introductory information about this API, see the Users Guide and BestMatchItemDetails API product page.
Note: Watch these release notes for changes.
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls are included in the initial release of the eBay BestMatchItemDetails API.
This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.
© 2009–2010 eBay Inc. All rights reserved.
eBay and the eBay logo are registered trademarks of eBay Inc.
All other brands are the property of their respective owners.