| eBay Shopping Web Services Resources: Getting Started | Samples | Call Structure | Call Reference |
You can find links to the Shopping API documentation in the top Resources bar. Information about the schema location is in the Schema Location section of the Call Structure topic.
Are you just getting started with the Shopping API? The following describes how to join the eBay Developers Program:
| Q1 2008 | Q4 2007 | Q3 2007 | Q2 2007 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Version | Release Date | Version | Release Date | Version | Release Date | Version | Release Date | ||||
| 571 | 2008-6-25 | 557 | 2008-3-19 | 545 | Not Released | 531 | 2007-9-19 | ||||
| 569 | 2008-6-11 | 555 | 2008-3-5 | 543 | 2007-12-18 | 529 | 2007-9-5 | ||||
| 567 | 2008-5-28 | 553 | 2008-2-20 | 541 | Not Released | 527 | 2007-8-22 | ||||
| 565 | 2008-5-14 | 551 | 2008-2-6 | 539 | 2007-11-14 | 525 | 2007-8-8 | ||||
| 563 | 2008-4-30 | 549 | 2008-1-23 | 537 | 2007-10-31 | 523 | 2007-7-25 | ||||
| 561 | 2008-4-16 | 547 | 2008-1-9 | 535 | 2007-10-17 | 521 | 2007-7-11 | ||||
| 559 | 2008-4-2 | 533 | 2007-10-3 | ||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
Documentation Changes and Errata - 563
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.
No changed calls in this release.
No schema changes in this release.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 563.
None for this release.
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.
By the beginning of May 2008, the response for Search related calls will not return an item with a listed price that is less than the Minimum Listing Amount (MLA) threshold on the eBay site where the item was originally listed.
The following calls are affected by this change:
The MLA varies by site ID (e.g. $0.99 on the US site and 1 euro on the UK site) and is an additional transparent filter that will not affect any existing functionality of the affected calls. The MLA filtering will automatically be applied to the following listing formats for items returned in the response of the calls:
However, MLA filtering will not apply to Chinese Auction and Chinese Auction + BIN Format for listings lasting 6 days or more.
Whenever the response of these calls returns items listed on another (international) eBay site, the price of those items is first converted to the local country currency and is then compared to the local MLA threshold.
The MLA will be applied across all eBay sites, including eBay Express and Motors (does not include Half.com).
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 563 and Changed Functionality - 563.
None for this release.
Documentation Changes and Errata - 561
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.
No schema changes in this release.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 561.
The FindHalfProducts call has been updated to return additional data for query searches. When you specify QueryKeywords in the request, the response includes Products.Product.ItemCount and a new fields, Products.Product.MinPrice. Products.Product.MinPrice gives the minimum price for all active items listed under the given product.
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 - 561 and Changed Functionality - 561.
None for this release.
Documentation Changes and Errata - 559
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 |
|---|---|---|
AddressType |
Complex type | New |
BusinessSellerDetailsType |
Complex type | New |
VATDetailsType |
Complex type | New |
SimpleItemType.BusinessSellerDetails |
Element | New |
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 559.
GetSingleItem now returns the seller's information (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. This is only applicable for sites where Business Seller options are supported.
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 - 559 and Changed Functionality - 559.
None for this release.
Documentation Changes and Errata - 557
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.
No changed calls in this release.
No schema changes in this release.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 557.
None for this release.
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.
For eBay, the affiliate tracking URLs of Commission Junction will stop tracking starting May 1st, 2008. For information about affiliate tracking, see Affiliate URL Parameters and HTTP Header Values.
If you are a Commission Junction member, please join the eBay Partner Network. The eBay Partner Network replaces Commission Junction as a service provider for the eBay Affiliate Program. References in the documentation to Commission Junction have been changed to reference eBay Partner Network (https://www.ebaypartnernetwork.com).
Please migrate your affiliate account and all affiliate tracking to eBay Partner Network between April 1st and May 1st. For migration, please see Affiliate Migration to eBay Partner Network.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 557 and Changed Functionality - 557.
None for this release.
Documentation Changes and Errata - 555
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 |
|---|---|---|
ShippingDetailsType.CODCost |
Element | New |
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 555.
None for this release.
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.
By April, on the Italy site (site ID 101), the cost of cash-on-delivery shipping can be returned by the GetShippingCosts call.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 555 and Changed Functionality - 555.
A sample has been added to FindItemsAdvanced illustrating the use of the Value field in the URL request format. The field is not used in the XML request format.
Documentation Changes and Errata - 553
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.
No schema changes in this release.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 553.
You can test Shopping API calls using the Sandbox environment (that is,
using the http://open.api.sandbox.ebay.com/shopping? endpoint).
For more information, see the
Testing Overview section of the Call Structure topic.
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 January 29 announcements included the announcement that Best Match would become the default for search results in March 2008. The documentation for FindItems and FindItemsAdvanced has been updated with this change. For more information, see the eBay General Announcement Board for the announcements of January 29, 2008.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 553 and Changed Functionality - 553.
The documentation has been updated to state that if you specify an output format of JSON or NV (Name-Value pair), then instances of some wrappers of primitive types, such as instances of AmountType and DistanceFromBuyer, will include a Value field.
For example, in the FindItemsAdvanced NV response, here is an example of a possible instance of ShippingServiceCost (which is of type AmountType):
Item(1).ShippingCostSummary.ShippingServiceCost.Value=3.5.
Documentation Changes and Errata - 551
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.
No changed calls in this release.
No schema changes in this release.
Please see the eBay General Announcement Board for the announcements of January 29, 2008, about upcoming changes to feedback, as well as other changes.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 551.
None for this release.
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 - 551 and Changed Functionality - 551.
None for this release.
Documentation Changes and Errata - 549
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.
No changed 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 |
|---|---|---|
FeedbackHistoryType.UniqueNeutralFeedbackCount |
Element | New |
Please see the eBay General Announcement Board for the announcements of January 29, 2008, about upcoming changes to feedback, as well as other changes.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 549.
Starting in early February 2008, the eBay Feedback system will allow buyers and sellers to affect each other's Feedback score by one point each week. This will encourage sellers and buyers to engage in repeat transactions with one another.
Currently, a member can impact another member's Feedback score at most +1 or -1 in their lifetime. After the upcoming changes a member will be able to impact another member's Feedback score at most +1 or -1 in a calendar week. Repeat positive or negative Feedback score in a week will not be counted, even if they have more than one transaction between them in that week.
GetUserProfile call will be changed as following:
For more information, see Upcoming Changes to Feedback.
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 - 549 and Changed Functionality - 549.
The documentation has been revised to state that in cases where a comma can be embedded in a string, an array index must be used to prevent the comma from acting as a delimiter. For more information, see the Specifying Arrays in Requests section of the Call Structure topic.
Documentation Changes and Errata - 547
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.
No schema changes in this release.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 547.
None for this release.
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 - 547 and Changed Functionality - 547.
For the FindItemsAdvanced call, you must specify a QueryKeyword if you set the IncludeSelector value to ItemSpecifics.
No 545 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 543
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.
No changed calls in this release.
No schema changes in this release.
There will not be a 545 schema release. The 547 schema and API documentation will be available by January 14, 2008.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 543.
None for this release.
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 - 543 and Changed Functionality - 543.
None for this release.
No 541 schema was released.
Documentation Changes and Errata - 539
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.
No changed 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 |
|---|---|---|
| No schema changes in this release | Not applicable | Not applicable |
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 539.
None for this release.
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 - 539 and Changed Functionality - 539.
None for this release.
Documentation Changes and Errata - 537
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 | Schema component | Nature of Change |
|---|---|---|
BuyerPaymentMethodCodeType.PaisaPayEscrowEMI |
Enum | New |
PaymentMethodSearchCodeType.PaisaPayEscrowEMI |
Enum | New |
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 537.
None for this release.
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.
In December 2007, the PaisaPayEscrowEMI payment method will be available for the India site (site ID 203).
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 537 and Changed Functionality - 537.
None for this release.
Documentation Changes and Errata - 535
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 | Schema component | Nature of Change |
|---|---|---|
CharityStatusCodeType |
Enumerated type | New |
CharityType.CharityListing |
Element | New |
CharityType.CharityName |
Element | New |
CharityType.CharityNumber |
Element | New |
CharityType.DonationPercent |
Element | New |
CharityType.LogoURL |
Element | New |
CharityType.Mission |
Element | New |
CharityType.Status |
Element | New |
SimpleItemType.MinimumToBid |
Element | New |
SimpleItemType.ProductID |
Element | New |
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 535.
In this release, some useful new fields are returned in the GetSingleItem when you specify the Details in the
IncludeSelector field. Specifically, the call now returns information about the minimum amount required to bid on the item, a product ID for the item, and details
about any nonprofit charity that the seller may have selected to benefit from the sale.
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.
The response for GetItemStatus now includes the HighBidder and ReserveMet fields, as shown below:
<GetItemStatusResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <Timestamp>2007-10-18T03:03:32.015Z</Timestamp> <Ack>Success</Ack> <Build>e535_core_Bundled_5514987_R1</Build> <Version>535</Version> <Item> <ItemID>270000490370</ItemID> <EndTime>2007-10-04T02:05:18.000Z</EndTime> <ConvertedCurrentPrice currencyID="USD">1239.0</ConvertedCurrentPrice> <HighBidder><UserID>1191463482046_buyerx15</UserID></HighBidder> <ListingStatus>Ended</ListingStatus> <ReserveMet>true</ReserveMet> </Item> </GetItemStatusResponse>Note that like many API calls, GetItemStatus only returns fields that are appropriate for the item. For instance, if the item ended with no bids, the HighBidder field would not be included in the response.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 535 and Changed Functionality - 535.
The usage information for the GetItemStatus call has been updated to include the maximum limit of 10 items per call.
The usage information for the GetCategoryInfo call has been updated with a descripton of how to build a full or partial category hierarchy.
Documentation Changes and Errata - 533
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.
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 | Schema component | Nature of Change |
|---|---|---|
GetCategoryInfoRequestType |
Complex type | New |
GetCategoryInfoResponseType |
Complex type | New |
GeteBayTimeRequestType |
Complex type | New |
GeteBayTimeResponseType |
Complex type | New |
ReturnPolicyType |
Complex type | New |
CategoryType.CategoryIDPath |
Element | New |
CategoryType.CategoryNamePath |
Element | New |
CategoryType.LeafCategory |
Element | New |
SimpleItemType.ReturnPolicy |
Element | New |
SimpleUserType.PositiveFeedbackPercent |
Element | New |
SimpleUserType.ReviewRank |
Element | Removed |
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 533.
If you are using URL-style input or Name-Value Pair input, repeatable fields now can be expressed using a comma-separated format. For example, for ItemID in GetItemStatus, you can specify &ItemID=123456789012,223456789012,323456789012. If you are specifying only one value, you can specify, for example, &ItemID=123456789012. For more information, see the samples in the calls with repeatable fields, such as GetItemStatus.
Formerly, when URL-style or Name-Value Pair input included a repeatable field, an array index was required (e.g., for ItemID in GetItemStatus, you had to specify input such as &ItemID(0)=123456789012&ItemID(1)=223456789012). The array index was required even if you passed in only one value. The array index is still supported, but it is recommended that you use the comma-separated format.
If you use the callbackname parameter in a request for data in JSON format, the response data is wrapped in a call to a function. The name of the function is the value you specified for the parameter.
For example, if you use the FindItems call and you specify callbackname=myfunction, then the FindItems response data will be wrapped in a call to a myfunction function.
For more information about the callbackname parameter and the corresponding header value, see the Standard URL Parameters and HTTP Header Values section of the Call Structure topic.
You can use GeteBayTime to obtain the official eBay system time in GMT.
If an item has a return policy, you can use
GetSingleItem to obtain
the details about the policy. If you specify Details in the
IncludeSelector field, a ReturnPolicy container
has fields with information about the policy such as how a refund will be made (e.g., as an exchange)
and how soon an item must be returned for a refund.
You can use GetSingleItem to obtain the percentage value of a sellers's positive feedback.
You can use GetCategoryInfo to retrieve category information for a specific CategoryID (such as which categories it contains, what level each sub-category is within the hierarchy, and whether the sub-categories are leaf categories (bottom-level categories where items can be listed).
Now you can specify that you want the Shopping API to return the values from the latest schema version instead of returning 'CustomCode' for values that are from a newer schema than the one you specified in version (or in X-EBAY-API-VERSION). The Shopping Web Services Call Structure document contains the table that describes URL parameters and HTTP values.
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 - 533 and Changed Functionality - 533.
None for this release.
Documentation Changes and Errata - 531
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.
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 | Schema component | Nature of Change |
|---|---|---|
BuyingGuideDetailsType |
Complex type | New |
BuyingGuideType |
Complex type | New |
FindPopularItemsRequestType |
Complex type | New |
FindPopularItemsResponseType |
Complex type | New |
FindPopularSearchesRequestType |
Complex type | New |
FindPopularSearchesResponseType |
Complex type | New |
FindReviewsAndGuidesRequestType |
Complex type | New |
FindReviewsAndGuidesResponseType |
Complex type | New |
PopularSearchesType |
Complex type | New |
ReviewDetailsType |
Complex type | New |
ReviewType |
Complex type | New |
FindHalfProductsRequestType.SellerID |
Element | New |
SimpleItemType.WatchCount |
Element | New |
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 531.
Buyers and comparison shoppers may be interested in finding popular items by category or keyword. A new call, FindPopularItems, retrieves popular items, based on item watch count and other criteria as determined by eBay.
For specified keywords or categories, FindPopularItems retrieves up to 20 active items. If no keywords or categories are specified, FindPopularItems will retrieve the 20 most popular active items across all categories.
Buyers and comparison shoppers may be interested in finding popular searches by category or keyword. A new call, FindPopularSearches, retrieves popular related and alternative searches, based on frequently used words when searching for listings.
If no keywords or categories are specified, FindPopularSearches will retrieve the 20 most popular search terms across all categories.
Buyers and comparison shoppers may be interested in finding reviews and guides, especially when they do not have a specific product in mind. FindReviewsAndGuides retrieves reviews and guides based on product or user. A buyer may use reviews and guides to make an informed purchasing decision.
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 - 531 and Changed Functionality - 531.
The FindItemsAdvanced documentation has been updated to state that the CategoryID input field cannot be used with the following input fields: EndTimeFrom, EndTimeTo, PriceMin, or PriceMax.
Documentation Changes and Errata - 529
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.
No changed calls in this release.
No schema changes in this release.
See the 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.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 529.
None for this release.
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 - 529 and Changed Functionality - 529.
None for this release.
Documentation Changes and Errata - 527
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.
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 | Schema component | Nature of Change |
|---|---|---|
FindHalfProductsRequestType |
Complex type | New |
FindHalfProductsResponseType |
Complex type | New |
HalfCatalogProductType |
Complex type | New |
HalfProductsType |
Complex type | New |
HalfItemConditionCodeType |
Enumerated type | New |
SimpleItemType.HalfItemCondition |
Element | New |
SimpleItemType.SellerComments |
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 - 527.
Buyers and comparison shoppers may be interested in finding stock product information (Pre-filled Item Information) from Half.com catalogs, such as information about a particular book or DVD. A new call, FindHalfProducts, retrieves basic product information (such as product titles, stock photos, and Item Specifics).
For a given product, FindHalfProducts also retrieves up to 30 active items on Half.com that include the product's stock information.
For Half.com developers who are unfamiliar with the Shopping API, please see the Getting Started Guide -- an introduction to the eBay Shopping API .
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.
In the following calls, the IncludeSelector field need not be used for the ListingType of an item to be returned. That is, the ListingType field, which contains the listing format (Chinese auction, fixed price, etc.), is returned by default:
Additionally, for FindProducts, when you use the IncludeSelector field to specify that items are returned in the response, the ListingType for an item is returned.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 527 and Changed Functionality - 527.
None for this release.
Back to topDocumentation Changes and Errata - 525
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.
| Name | Schema component | Nature of Change |
|---|---|---|
AverageRatingDetailsType |
Complex type | New |
CatalogProductType |
Complex type | New |
CategoryArrayType |
Complex type | New |
CategoryType |
Complex type | New |
CharityType |
Complex type | New |
DistanceType |
Complex type | New |
DomainHistogramType |
Complex type | New |
ExternalProductIDType |
Complex type | New |
FeedbackDetailType |
Complex type | New |
FeedbackHistoryType |
Complex type | New |
FeedbackPeriodType |
Complex type | New |
FindItemsAdvancedRequestType |
Complex type | New |
FindItemsAdvancedResponseType |
Complex type | New |
FindProductsRequestType |
Complex type | New |
FindProductsResponseType |
Complex type | New |
GetMultipleItemsRequestType |
Complex type | New |
GetMultipleItemsResponseType |
Complex type | New |
GetUserProfileRequestType |
Complex type | New |
GetUserProfileResponseType |
Complex type | New |
HistogramEntryType |
Complex type | New |
ProductIDType |
Complex type | New |
SearchResultType |
Complex type | New |
SimpleItemArrayType |
Complex type | New |
StorefrontType |
Complex type | New |
CommentTypeCodeType |
Enumerated type | New |
DigitalDeliveryMethodCodeType |
Enumerated type | New |
ExternalProductCodeType |
Enumerated type | New |
FeedbackRatingDetailCodeType |
Enumerated type | New |
ItemConditionCodeType |
Enumerated type | New |
ItemTypeCodeType |
Enumerated type | New |
PaymentMethodSearchCodeType |
Enumerated type | New |
PreferredLocationCodeType |
Enumerated type | New |
ProductIDCodeType |
Enumerated type | New |
ProductSortCodeType |
Enumerated type | New |
QuantityOperatorCodeType |
Enumerated type | New |
SearchFlagCodeType |
Enumerated type | New |
SellerBusinessCodeType |
Enumerated type | New |
StoreSearchCodeType |
Enumerated type | New |
TradingRoleCodeType |
Enumerated type | New |
UserStatusCodeType |
Enumerated type | New |
SimpleItemType.Charity |
Element | New |
SimpleItemType.Country |
Element | New |
SimpleItemType.DigitalDeliveryMethod |
Element | New |
SimpleItemType.DigitalDeliveryRequirements |
Element | New |
SimpleItemType.DistanceFromBuyer |
Element | New |
SimpleItemType.GermanMotorsSearchable |
Element | New |
SimpleItemType.GetItFast |
Element | New |
SimpleItemType.Gift |
Element | New |
SimpleItemType.HitCount |
Element | New |
SimpleItemType.PictureExists |
Element | New |
SimpleItemType.PrimaryCategoryIDPath |
Element | New |
SimpleItemType.RecentListing |
Element | New |
SimpleItemType.SecondaryCategoryID |
Element | New |
SimpleItemType.SecondaryCategoryIDPath |
Element | New |
SimpleItemType.SecondaryCategoryName |
Element | New |
SimpleItemType.Storefront |
Element | New |
SimpleItemType.Subtitle |
Element | New |
SimpleUserType.AboutMeURL |
Element | New |
SimpleUserType.FeedbackDetailsURL |
Element | New |
SimpleUserType.MyWorldLargeImage |
Element | New |
SimpleUserType.MyWorldSmallImage |
Element | New |
SimpleUserType.MyWorldURL |
Element | New |
SimpleUserType.NewUser |
Element | New |
SimpleUserType.RegistrationDate |
Element | New |
SimpleUserType.RegistrationSite |
Element | New |
SimpleUserType.ReviewRank |
Element | New |
SimpleUserType.ReviewsAndGuidesURL |
Element | New |
SimpleUserType.SellerBusinessType |
Element | New |
SimpleUserType.SellerItemsURL |
Element | New |
SimpleUserType.Status |
Element | New |
SimpleUserType.StoreName |
Element | New |
SimpleUserType.StoreURL |
Element | New |
None for this release.
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 - 525.
The new call GetMultipleItems retrieves publicly available data for one or more listings. Use this call to retrieve most of the information that is visible on a listing's View Item page on the eBay Web site, such as title, description, prices, basic seller and bidder information, and basic shipping costs.
You can use FindItemsAdvanced to search for items on eBay based on many possible input fields and filters. You can use the IncludeSelector input field to specify the output set of the call. Detailed information is returned about items.
You can use GetUserProfile to retrieve information about a user. You specify a user name on input and you can use the IncludeSelector input field to specify the output set of the call.
Buyers and comparison shoppers may be interested in finding stock product information (Pre-filled Item Information) from eBay catalogs, such as information about a particular DVD or camera. A new call, FindProducts, retrieves basic product information (such as product titles, stock photos, and Item Specifics) and provides URLs to help you create links to additional catalog content on eBay.
For a given product, FindProducts also retrieves up to 200 active items on eBay that include the product's stock information. To retrieve more items, or to configure the item results differently, you can pass a product's ID as input to FindItemsAdvanced.
In this release, some additional useful fields are returned in the GetSingleItem response when you set IncludeSelector to Details. Specifically, we now return information about the secondary category (for items that are listed in two categories), as well as the fully qualified category ID breadcrumbs for both the primary and secondary categories. Also, we return the listing subtitle (if specified by the seller), which provides more details about the nature of the item. The item's hit count is also now returned, which indicates the number of times the item's View Item page on eBay has been accessed.
You can use affiliate parameters with more calls. The complete list is the following:
If you use affiliate parameters, a URL is returned in the ViewItemURLForNaturalSearch field that can result in affiliate commissions. For information about commissions, see the eBay Affiliate Program. You can use URL parameters or the corresponding HTTP header values. In most cases it is easier to use the URL parameters rather than the HTTP header values.
For more information about affiliate parameters, see Affiliate URL Parameters and HTTP Header Values; for an example, see Basic Call with Affiliate Tracking.
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 - 525 and Changed Functionality - 525.
None for this release.
Back to topDocumentation Changes and Errata - 523
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.
No changed calls in this release.
No schema changes in this release.
None for 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 - 523.
None for this release.
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 - 523 and Changed Functionality - 523.
None for this release.
Back to topDocumentation Changes and Errata - 521
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.
No schema changes in this release.
None for 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 - 521.
You can use affiliate parameters in the FindItems call. If you use affiliate parameters, a URL is returned in the ViewItemURLForNaturalSearch field that can result in affiliate commissions. In the Shopping API, affiliate parameters currently are only available for FindItems.
For more information about commissions, see the eBay Affiliate Program. You can use URL parameters or the corresponding HTTP header values. In most cases it is easier to use the URL parameters rather than the HTTP header values.
For more information, see Affiliate URL Parameters and HTTP Header Values; for an example, see Basic Call with Affiliate Tracking.
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 Shopping API accepts URL-encoded input. For example, QueryKeywords in the FindItems call handles URL-encoded input, e.g. you can specify toy%20boat in the QueryKeywords parameter. For additional information, see QueryKeywords in the FindItems topic.
This section lists additional documentation changes and corrections that were made with this release that are not already mentioned in New Features - 521 and Changed Functionality - 521.
The Item.Location field has been removed from the Output section of the FindItems topic.
Back to top© 2007 eBay Inc. All rights reserved.