You can find links to the Merchandising 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 Merchandising API? The following pages contain information that describes how to join the eBay Developers Program:
Index of Changed Calls - 1.1.0
Documentation Changes and Errata - 1.1.0
For a current list of known issues, see the eBay Shopping and Merchandising API Production 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.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
| Name | Part of Schema | Type of Change |
|---|---|---|
GetSimilarItemsRequest |
Complex type | New |
BaseServiceResponse.timestamp |
Element | New |
BaseServiceResponse.version |
Element | New |
The getDeals call is not returning any item recommendations. Refer to the getDeals call not returning results thread in the eBay Shopping and Merchandising API Production System Announcements board for more information, including an ETA for when this problem will be resolved.
The getMostWatchedItems call does not work properly for EBAY-FRCA (eBay Canada, French). Refer to the getMostWatchedItems returns no results for IN, CAFR, CA thread in the eBay Shopping and Merchandising API Production System Announcements board for more information, including an ETA for when this problem will be resolved.
The getTopSellingProducts call does not work for the following global IDs (eBay sites): EBAY-FRBE (eBay Belgium, French), EBAY-NLBE (eBay Belgium, Dutch), or EBAY-AU (eBay Australia). Refer to the getTopSellingProducts not returning results for NLBE, FRBE, AU thread in the eBay Shopping and Merchandising API Production System Announcements board for more information, including an ETA for when this problem will be resolved.
In some cases, the item recommendations returned by getRelatedCategoryItems are not closely related to the item specified in the request. Refer to the getRelatedCategoryItems does not return related items thread in the eBay Shopping and Merchandising API Production System Announcements board for more information, including an ETA for when this problem will be resolved.
See the eBay Shopping and Merchandising API Production System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
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.
The new getSimilarItems call allows you to retrieve a list of recommended items that are similar to the specified item. This call can be used to recommend items to buyers who have lost items they were bidding on, or to recommend items as alternatives for watched items that have ended.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1.1.0.
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.
The response for each Merchandising call now includes the following fields:
In the initial release of the Merchandising API, calls returned data for the eBay US site only. Calls are for the eBay US site by default, but the GLOBAL-ID URL parameter (or X-EBAY-SOA-GLOBAL-ID HTTP Header) can be used to get results from other eBay sites. In Version 1.1.0, the global ID can be specified (e.g., GLOBAL-ID=EBAY-GB) to retrieve data from international eBay sites.
Refer to Global ID Values for a list of global IDs and eBay Site ID to Global ID Mapping to see the list sorted by the corresponding site ID.
Note: At the time of release, some calls do not work with all global IDs. For example, getTopSellingProducts does not work for the following global IDs (eBay sites): EBAY-FRBE (eBay Belgium, French), EBAY-NLBE (eBay Belgium, Dutch), or EBAY-AU (eBay Australia). getMostWatchedItems does not work for EBAY-FRCA (eBay Canada, French).
The product reference ID returned by getTopSellingProducts call in the initial release of the Merchandising API was in the long format referred to as the ProductMementoString parameter. The long format has limited application. In Version 1.1.0, getTopSellingProducts returns the shorter product reference ID, which can be used to search for products, listings, and reviews in the Shopping API. Refer to FindItemsAdvanced, FindProducts, and FindReviewsAndGuides pages in the Shopping API Call Reference for information on using the product reference ID for searches.
Long product reference ID returned by getTopSellingProducts in version 1.0.0:
<productRecommendations>
<product>
<productId type="Reference">
98398:2:1051:4055955490:143584350:f7ddef8d65bb5c3fc858bcf11ed7bc4e:1:1:1:1375474706
</productId>
<title>Grand Theft Auto IV (Playstation 3)</title>
...
Short product reference ID returned by getTopSellingProducts in version 1.1.0:
<productRecommendations>
<product>
<productId type="Reference">53683360</productId>
<title>Grand Theft Auto IV (Playstation 3)</title>
...
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1.1.0 and Changed Functionality - 1.1.0.
The getDeals call is not returning data. Until this problem is corrected, getDeals has been removed from the Call Reference. The getDeals schema remains in the WSDL. Refer to the getDeals call not returning results thread in the eBay Shopping and Merchandising API Production System Announcements board for more information, including an ETA for when this problem will be resolved.
This is the first release of the eBay Merchandising API.
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 Merchandising API.
© 2008 eBay Inc. All rights reserved.