This archive document contains information about releases that go back longer than four quarters ago. For more recent releases, see the current Release Notes.
If you are getting started with the API, the following locations have information about joining the eBay Developers Program, creating test users, and other steps to getting your application certified to go live against the eBay production servers:
| Q3 2007 | Q2 2007 | Q1 2007 | Q4 2006 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Version | Release Date | Version | Release Date | Version | Release Date | Version | Release Date | ||||
| 531 | 2007-9-19 | 519 | 2007-6-27 | 505 | 2007-3-21 | 493 | 2006-12-27 | ||||
| 529 | 2007-9-5 | 517 | 2007-6-13 | 503 | 2007-3-7 | 491 | 2006-12-13 | ||||
| 527 | 2006-8-22 | 515 | 2007-5-30 | 501 | 2007-2-21 | 489 | 2006-11-29 | ||||
| 525 | 2007-8-8 | 513 | 2007-5-16 | 499 | 2007-2-7 | 487 | 2006-11-15 | ||||
| 523 | 2007-7-25 | 511 | 2007-5-2 | 497 | 2007-1-24 | 485 | 2006-11-1 | ||||
| 521 | 2007-7-11 | 509 | 2007-4-18 | 495 | 2007-1-10 | 483 | 2006-10-18 | ||||
| 507 | 2007-4-4 | 481 | 2006-10-4 | ||||||||
These releases go back longer than four quarters ago. For more recent releases, see the current Release Notes.
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.
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 |
|---|---|---|
| No changes 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 - 531.
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 - 531 and Changed Functionality - 531.
The documentation has been updated to state that you must use HTTP version 1.0 for the UploadSiteHostedPictures call.
For the GetSearchResults call, the documentation has been updated to state that if you use UserIdFilter.IncludeSellers or UserIdFilter.ExcludeSellers, the maximum number of sellers you can specify is 100.
The documentation for the GetItem and GetFeedback calls has been updated to state that if a listing ended more than 90 days ago, item information such as the title is not returned.
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.
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 |
|---|---|---|
FetchTokenRequestType.IncludeRESTToken |
Element | New |
FetchTokenResponseType.RESTToken |
Element | New |
SellingManagerProductDetailsType.CustomLabel |
Element | Reserved for future use |
SellingManagerProductDetailsType.ProductID |
Element | Reserved for future use |
SellingManagerProductDetailsType.QuantityAvailable |
Element | Reserved for future use |
SellingManagerProductDetailsType.UnitCost |
Element | Reserved for future use |
In Q4 2007, we plan to stop supporting two earlier styles of schema documentation in the Trading API: the WSDLdoc and the Visual Schema.
As announced in May 2007, the Type documentation is easier to access and browse than the WSDLdoc. The Type documentation is part of the Input/Output Reference.
If you still use the early-style schema documentation and cannot find needed information in the Type documentation, please drop us a note in the Documentation Forum. The Type documentation is highly integrated into the Input/Output Reference. Additionally, the Type documentation contains call-specific, "where used" information that is not in the WSDLdoc.
At the top of any Input/Output Reference page is a link to the Type Index, enabling you to quickly access documentation for a particular type.
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.
You can use the FetchToken call to retrieve a REST token for a user.
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.
The samples for AddSecondChanceItem and VerifyAddSecondChanceItem have been corrected. The updates were required for removal of the Fees container from the sample output.
The documentation for County has been updated to note that it is only used by the eBay UK site.
The maximum length for Street1 and Street2 is 100 characters, not 64.
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.
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 |
|---|---|---|
ShippingServiceCodeType enums (various) |
Enum | 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.
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.
The "Local Delivery/Pickup" shipping service has been deprecated. Two new shipping services have been created as a replacement: "Local Pickup" and "Local Delivery". These behave just like any other shipping service.
Any use of the old shipping service named "Local Delivery/Pickup" will be replaced with "Local Pickup" and a warning will be issued.
In addition, several eBay sites that did not previously support "Local Pickup" as a shipping service now support it.
Local Pickup is available for these sites: US, CA, CAFR, AU, IT, NL, ES.
Local Delivery is available for these sites: US, SG.
New enumeration values in ShippingServiceCodeType: AU_Pickup, CA_Pickup, Delivery, ES_Pickup, FR_Pickup, IT_Pickup, NL_Pickup, Pickup, SG_Delivery.
Instead of "Bidder 1", "Bidder 2", etc., anonymized UserIDs (like HighBidder) will show masked IDs like a****b on the US site (The "Bidder 1", "Bidder 2" format is still used for the UK or AU sites.)
There are no API changes for this. eBay is adding 5 new local market subscription types on 527, but those types will be mapped to the existing LocalMarketRegular value in GetUser (like it is for the rest of the eBay site). In other words, developers won't see any difference in behavior. (But if sellers are aware of their subscription level and they ask why they're not seeing these subscriptions called out, this detail is documented in LocalMarketRegularSubscriptionDefinitionType.)
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.
A new maximum length for transaction IDs was announced in May 2006 in the Release Notes and in the weblog. The documentation has been corrected to contain this maximum length for transaction IDs.
The GetCategoryListings documentation has been corrected to no longer list the following fields as possible output fields for this call: PictureURL and PhotoDisplay.
Documentation 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.
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 |
|---|---|---|
MotorsLocalMarketEnabledDefinitionType |
Complex type | New |
AuthTokenTypeCodeType |
Enumerated type | Reserved for future use |
AdFormatEnabledCodeType.LocalMarketBestOfferOnly |
Enum | New |
CountryCodeType.GG |
Enum | New |
CountryCodeType.JE |
Enum | New |
CountryCodeType.ZZ |
Enum | New |
CurrencyCodeType.ATS |
Enum | New |
ShippingPackageCodeType enums (various) |
Enum | New |
None for this release. (See New Features for important changes in 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.
Effective the week of August 6, when sellers list vehicles for the eBay Motors Local Market only, Item.ListingType must be set to LeadGeneration. FixedPriceItem will no longer be allowed. Additional contact details, Item.ExtendedSellerContactDetails and Item.SellerContactDetails, will be supported for Local Market Listings. New types have been added to the Trading API to support this functionality.
When you list an item, you can use the GalleryPlus feature for self-hosted pictures.
Formerly, the GalleryPlus feature required that a picture was hosted through eBay Picture Services (EPS).
Shopping.com merchants can set the existing SetUserPreferences Request flag value to "All" to make their listings show up on eBay Express if they meet the necessary Express criteria. They can set the flag to "optout" if they don't want their listings to show up on eBay Express.
As previously announced, with release 525 (this release), the lowest supported version has changed from 415 to 447. This means we no longer support objects that were deprecated prior to version 447. See eBay's Tech Support Alert for a list of the fields that are no longer supported. (These fields are no longer listed in eBay's deprecated objects list in this documentation.)
In February and August of each year, eBay increments the lowest supported schema version. In February 2008, the lowest supported version will change to 473. (See eBay's Version Support Schedule.)
As previously announced, IDs used for eBay Stores may reach 64-bit values soon. When these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. We will no longer be including biweekly reminders of this expected change in these release notes.
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.
Documentation 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.
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 |
|---|---|---|
CategoryItemSpecificsType |
Complex type | New |
GetCategorySpecificsRequestType |
Complex type | New |
GetCategorySpecificsResponseType |
Complex type | New |
GetItemRequestType.IncludeItemSpecifics |
Element | New |
GetItemTransactionsRequestType.Platform |
Element | New |
GetOrderTransactionsRequestType.Platform |
Element | New |
GetSellerTransactionsRequestType.Platform |
Element | New |
ShippingServiceCodeType enums (various) |
Enums | New |
TransactionType.CartID |
Element | New |
TransactionType.SellerContactBuyerByEmail |
Element | New |
As previously announced, in August (release 525), the lowest supported version will change from 415 to 447. This means we will stop supporting objects that were deprecated prior to version 447. For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
As previously announced, IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). When these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
Effective the week of August 6, when sellers list vehicles for the eBay Motors Local Market only, Item.ListingType must be set to LeadGeneration. FixedPriceItem will no longer be allowed. Additional contact details, Item.ExtendedSellerContactDetails and Item.SellerContactDetails, will be supported for Local Market Listings.
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.
A handful of shipping carriers have been added for eBay Spain and eBay France.
In early August, eBay US and international sites will enable sellers to create custom Item Specifics in certain categories.
With custom Item Specifics, you enter name/value pairs as strings in AddItem and related calls. GetItem retrieves these strings as-is, in the order in which the seller specified them.
Unlike the current Attributes system, there are no IDs to look up. However, we do give you an option to download names and values that are popular in each category.
Initially, we are releasing this functionality in categories that don't already support Item Specifics (that is, categories that don't support the existing ID-based attributes model). At launch, only a few categories will support custom Item Specifics, but many more categories will support this feature over the next few months. See the Knowledge Base for a list of categories that initially support this feature:
https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1109
For an overview and XML samples, see Working with Custom Item Specifics in the eBay Trading Web Services guide.
Use these calls to list with custom Item Specifics:
In addition, the following calls provide optional functionality for more advanced use cases:
Shopping.com merchants can retrieve transaction information for items sold on Shopping.com via the Shopping.com shopping cart. Shopping.com transactions include the shopping cart identifier, CartID, and SellerContactBuyerByEmail, which indicates whether the buyer has opted to accept emails from all the seller(s) in the Shopping.com shopping cart.
To retrieve transactions made on Shopping.com, set Platform to Shopping in the request for GetItemTransactions, GetOrderTransactions, or GetSellerTransactions.
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.
The documentation has been corrected with the addition of the MemberMessage.Subject field to the required input for Transaction.AddMemberMessageAAQToPartner.
The documentation has been updated with the following: If you use GeteBayDetails in preparation for listing in the US Motors Parts & Accessories categories, use site ID 0 (which is the site ID of the US site) when you call GeteBayDetails.
Documentation 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.
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 |
|---|---|---|
CategoryFeatureType.ItemSpecificsEnabled |
Element | New |
CategoryFinanceOfferArrayType |
Complex type | Removed |
CategoryFinanceOfferType |
Complex type | Removed |
CategoryListingsOrderCodeType.PricePlusShippingAsc |
Enum | New |
CategoryListingsOrderCodeType.PricePlusShippingDesc |
Enum | New |
DetailNameCodeType.ItemSpecificDetails |
Enum | New |
DetailNameCodeType.UnitOfMeasurementDetails |
Enum | New |
FeatureDefinitionsType.ItemSpecificsEnabled |
Element | New |
FeatureIDCodeType.ItemSpecificsEnabled |
Enum | New |
FinanceOfferArrayType |
Complex type | Removed |
FinanceOfferType |
Complex type | Removed |
GetCategory2FinanceOffer |
Request/Response | Removed |
GeteBayDetailsResponseType.ItemSpecificDetails |
Element | New |
GeteBayDetailsResponseType.UnitOfMeasurementDetails |
Element | New |
GetFinanceOffers |
Request/Response | Removed |
GetRecommendationsResponseContainerType.ItemSpecificsRecommendations |
Element | New |
ItemSpecificDetailsType |
Complex type | New |
ItemSpecificsEnabledCodeType |
Simple type | New |
ItemSpecificsEnabledDefinitionType |
Complex type | New |
ItemSpecificSourceCodeType |
Simple type | New |
ItemSpecificsRecommendationsType |
Complex type | New |
ItemType.FinanceOfferID |
Element | Removed |
NameValueListType.Source |
Element | New |
NotificationEventTypeCodeType.ItemRevisedAddCharity |
Enum | New |
OrderType.FinanceOfferID |
Element | Removed |
PromotionRuleType.PromotedItem |
Element | Removed (not used) |
PromotionRuleType.SiteID |
Element | Removed (not used) |
RecommendationEngineCodeType.ItemSpecifics |
Enum | New |
SearchSortOrderCodeType.PricePlusShippingAsc |
Enum | New |
SearchSortOrderCodeType.PricePlusShippingDesc |
Enum | New |
ShippingServiceDetailsType.DimensionsRequired |
Element | New |
ShippingServiceDetailsType.ServiceType |
Element | New |
ShippingServiceDetailsType.ShippingPackage |
Element | New |
ShippingServiceDetailsType.SurchargeApplicable |
Element | New |
ShippingServiceDetailsType.ValidForSellingFlow |
Element | New |
SiteDefaultsType.ItemSpecificsEnabled |
Element | New |
UnitOfMeasurementDetailsType |
Complex type | New |
UnitOfMeasurementType |
Complex type | New |
In a few weeks, eBay will be releasing new functionality that enables sellers to create their own Item Specifics in certain categories, and to choose from popular Item Specifics that other sellers have created.
Initially, we will release this functionality in categories that don't already support Item Specifics. At launch, only a few categories will support this feature, but many more categories will enable custom Item Specifics over the next few months.
With custom Item Specifics, you enter name/value pairs as strings in AddItem and related calls. GetItem retrieves these strings as-is, in the order in which the seller specified them. There are no IDs to look up, but we do provide you with recommended names and values based on popular usage.
In release 521, we are providing a preview of the API changes.
Although this feature is not yet functional, all of the following changes are included in the schema as of release 521, except where noted. A few additional fields may be added when the feature is released.
For an overview and XML samples, see Working with Custom Item Specifics in the eBay Trading Web Services guide.
Starting in mid-August, Trading API calls must use SSL 3.0 to make the HTTPS connection. HTTPS connections to the API using SSL 2.0 will no longer be allowed. Support for SSL 2.0 has already been dropped from the Sandbox.
Please refer to this Knowledge Base article for further detail and check status of the switch over to SSL 3.0 requirement using this System Announcement.
As previously announced, in August (release 525), the lowest supported version will change from 415 to 447. This means we will stop supporting objects that were deprecated prior to version 447. For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
As previously announced, IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). When these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
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.
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.
Values applicable to GetSearchResults and GetCategoryListings have been added to the schema for the Price Plus Shipping Sort feature. This feature is planned to be enabled by the end of September 2007 for the following sites: US (site ID 0), Germany (77), Canada (2), and Australia (15). This feature causes item sorting to consider shipping costs. For additional information, see the Order field of GetSearchResults.
When you revise a item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. See "Identifying Listings that Benefit Nonprofits" in the Describing Items in a Listing section of the eBay Web Services Guide.
The following new elements are returned under ShippingServiceDetails: DimensionsRequired, ServiceType, ShippingPackage, SurchargeApplicable, ValidForSellingFlow. See ShippingServiceDetails in the Input/Output Reference.
Now the eBay partner can receive notification when an item has been revised to include their charity. (See 'Working with Platform Notifications' in the eBay Web Service Guides for more information.)
Paypal promotional financing is no longer supported in eBay listings. Therefore, GetCategory2FinanceOffer and GetFinanceOffers calls have been deprecated and are no longer functional.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 521 and Changed Functionality - 521.
The documentation is updated with policies and guidelines for using PlaceOffer in the Production environment.
Before using PlaceOffer, please carefully review the PlaceOffer Policies and Guidelines. The PlaceOffer Policies are required for use of PlaceOffer in the production environment. Please carefully write your application to follow all the PlaceOffer Policies.
PlaceOffer enables a user to submit a bid (make an offer) on an item. For competitive-bidding listings (Chinese and Dutch auctions), the call makes a bid. For fixed-price listings (Basic Fixed-Price and eBay Stores Inventory listings), the call purchases the item.
Back to topDocumentation Changes and Errata - 519
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 |
|---|---|---|
AbstractRequestType.BotBlock |
Element | New |
AbstractResponseType.BotBlock |
Element | New |
BotBlockRequestType |
Complex type | New |
BotBlockResponseType |
Complex type | New |
OperationTypeCodeType |
Simple type | Removed |
PlaceOfferRequestType.AffiliateTrackingDetails |
Element | New |
SetPromotionRules |
Request/Response | Removed |
As previously announced, in August (release 525), the lowest supported version will change from 415 to 447. This means we will stop supporting objects that were deprecated prior to version 447. For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
As previously announced, IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). When these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
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 - 519.
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.
Information about affiliate commissions from PlaceOffer, and about the botblock challenge that can be returned, has been added to the documentation. PlaceOffer is available for evaluation by all in the Sandbox (test) environment. For information about becoming authorized to use PlaceOffer in the Production environment, please contact Developer Relations, developer-relations@ebay.com.
PlaceOffer enables a user to submit a bid (make an offer) on an item. For competitive-bidding listings (Chinese and Dutch auctions), the call makes a bid. For fixed-price listings (Basic Fixed-Price and eBay Stores Inventory listings), the call purchases the item.
For more information about PlaceOffer, see PlaceOffer.
As of June 2007, SetPromotionRules is no longer functional, regardless of your request version. (This call has not been widely used, so we don't expect third-party applications to be significantly affected by this change.)
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 519 and Changed Functionality - 519.
None for this release.
Back to topDocumentation Changes and Errata - 517
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 |
|---|---|---|
AbstractRequestType.EndUserIP |
Element | New |
TransactionPlatformCodeType |
Simple type | New |
TransactionType.Platform |
Element | New |
As previously announced, in August (release 525), the lowest supported version will change from 415 to 447. This means we will stop supporting objects that were deprecated prior to version 447.
For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
As previously announced, IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). When these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
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 - 517.
To streamline the process of getting access to the production environment, you can get production keys on the My Account page after you join the eBay Developers Program.
Additionally, based on a general terminology change, references to "Application Certification" and "Certification" have been changed to Compatible Application Check.
PlaceOffer is available for evaluation by all in the Sandbox (test) environment. For information about becoming authorized to use PlaceOffer in the Production environment, please contact Developer Relations, developer-relations@ebay.com.
PlaceOffer enables a user to submit a bid (make an offer) on an item. For competitive-bidding listings (Chinese and Dutch auctions), this call makes a bid. For fixed-price listings (Basic Fixed-Price and eBay Stores Inventory listings), this call purchases the item.
For more information about PlaceOffer, see PlaceOffer.
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 a Chinese or Dutch auction or for a Fixed Price format listing, a seller can extend the duration of the listing only if it has been less than two hours since the listing was created (or since the listing started, if it was set to start in the future), and a seller can reduce the duration of the listing only if that would not result in less than 12 hours remaining for the listing. (All other existing restrictions on listing revisions remain in effect. See "Restrictions on Changing Item Properties During a Revision" in Revising Items.)
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 517 and Changed Functionality - 517.
A detail level has been added to GetBestOffers.
If you specify ReturnAll in the DetailLevel field, the response can include the BuyerMessage field in the BestOffer container. For more information, see GetBestOffers.
The documentation formerly stated that in the case of Local Market Listings, sellers could not use the AddToItemDescription call to add to an item description if there were active best offers. This restriction has been removed from the documentation.
The documentation has been updated to indicate that SearchResultItemArray.SearchResultItem.Item.GiftIcon is returned by GetSearchResults. One/zero is returned instead of true/false. If one ("1") is returned, a generic gift icon is displayed next the listing's title in search and browse pages.
Back to topDocumentation Changes and Errata - 515
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 |
|---|---|---|
GetStoreRequestType.UserID |
Element | New |
TransactionPlatformCodeType |
Simple type | Removed (unused) |
TransactionType.TransactionCobrandID |
Element | Removed (unused) |
In February and August of each year, eBay increments the lowest supported schema version. (See eBay's Version Support Schedule.)
In August (release 525), the lowest supported version will change from 415 to 447. This means we will stop supporting objects that were deprecated prior to version 447. For example, these deprecated fields will no longer be supported:
For a complete list of deprecated objects (and which objects to use instead), see Deprecated Objects.
As recently announced in the news blog, we've added some exciting enhancements you've been asking for in our documentation and developer.ebay.com site.
For example, we've simplified the Developer Documentation Center. We now provide shared links to these Release Notes, the eBay Web Services Guide, the Input/Output Reference, and related schema/WSDL docs. It doesn't matter if you're using XML or SOAP, you can use the same docs!
Are you looking for other SDK-specific docs? Just go to your Developer Center. You can find links to the Developer Centers on the left side of the developer.ebay.com site and at the top of the doc page.
It's great when we see your questions and corrections in the Documentation Forum. Now, you can also contribute your own content and corrections at the bottom of any given doc page! Try out the User-Contributed Notes at the bottom of this page!
IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). To help you prepare for this in advance, we recently changed the data types of store ID elements to xs:long (see Store ID Type Changes).
Please note that when these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
In a future release, the TransactionPlatform element in TransactionType will be deprecated. We will delete TransactionPlatform from the schema at the same time. Your application(s) should not be affected by this deletion until you upgrade to the version upon which TransactionPlatform is deprecated, or a later version.
Please see the eBay Schema Versioning Strategy for more information about the deprecation process.
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 - 515.
The GetStore call now accepts UserID as input. Previously, users could only retrieve information about their own stores. Now, you can use this call whether or not you are a store owner.
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 preparation for the scheduled shutdown of the eBay China site, the site will no longer accept new listings. This affects the AddItem family of calls. The SetStore call has already been disabled for the China site. Other API calls and features, however, are not affected.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 515 and Changed Functionality - 515.
See Announcements above.
Back to topDocumentation Changes and Errata - 513
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 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 |
|---|---|---|
Base64BinaryType |
Complex type | New |
BuyerProtectionDetailsType |
Complex type | New |
BuyerProtectionSourceCodeType |
Simple type | New |
ItemType.ApplyBuyerProtectionType |
Element | New |
PictureFormatCodeType |
Simple type | New |
PictureSetCodeType |
Simple type | New |
PictureSetMemberType |
Complex type | New |
SiteHostedPictureDetailsType |
Complex type | New |
TransactionPlatformCodeType |
Simple type | Will not be implemented |
TransactionType.TransactionCobrandID |
Element | Will not be implemented |
TransactionType.TransactionSiteID |
Element | Reserved for future use |
UploadSiteHostedPictures |
Request/Response | New |
We have deleted all deprecated calls and fields from the schema as of the 499 release. Please see the announcement we provided previously for version 499.
IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). To help you prepare for this in advance, we recently changed the data types of store ID elements to xs:long (see Store ID Type Changes).
Please note that when these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
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 - 513.
In the XML API, you can use the UploadSiteHostedPictures call to upload pictures for listings. Availability of this call in the SOAP API is planned for a future date, to be announced.
The UploadSiteHostedPictures call enables you to upload files in image formats such as JPG by including a binary attachment after the XML input, as part of the request.
The call returns SiteHostedPictureDetails.FullURL, which must be stored by your application (for associating the picture using the Item.PictureDetails.PictureURL field of AddItem, ReviseItem, or RelistItem).
For more information, please see the following:
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 - 513 and Changed Functionality - 513.
None for this release.
Back to topDocumentation Changes and Errata - 511
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 |
|---|---|---|
BidAssistantListType |
Complex type | New |
BiddingDetailsType.BidAssistant |
Element | New |
BidGroupArrayType |
Complex type | New |
BidGroupItemStatusCodeType |
Simple type | New |
BidGroupItemType |
Complex type | New |
BidGroupStatusCodeType |
Simple type | New |
BidGroupType |
Complex type | New |
GetMyeBayBuyingRequestType.BidAssistantList |
Element | New |
GetMyeBayBuyingResponseType.BidAssistantList |
Element | New |
ItemType.BidGroupItem |
Element | New |
RequestCategoriesType.DemandData |
Element | New |
StoreCustomListingHeaderType.BreadCrumb | Element | Removed (deprecated) |
We have deleted all deprecated calls and fields from the schema as of the 499 release. Please see the announcement we provided previously for version 499.
IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). To help you prepare for this in advance, we recently changed the data types of store ID elements to xs:long (see Store ID Type Changes).
Please note that when these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
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 - 511.
The Bid Assistant feature allows you to create a bid group with similar items and then place a single maximum bid for the entire group of items. Your bid would be placed on the item ending soonest, up to your maximum bid. Once your maximum has been surpassed, the Bid Assistant would place a bid for you on the item ending next in your group, up to your maximum bid. Once you have won an item in the bid group, the bidding for this group will stop.
To create a bid group on the eBay website, a buyer needs to add items to their watch list, select each item they want to include in a bid group, and click the 'Bid with Bid Assistance' button. Then the buyer needs to enter a bid group name and a bidding price.
A new element, BidAssistantList, has been added to GetMyeBayBuying. BiddingDetails includes a new BidAssistant boolean that returns true when the Bid Assistant is used. If the BidAssistant boolean is true, BidList, LostList, WatchList, and/or WonList will be returned when applicable. All of the new types and elements associated with Bid Assistant are described in more detail in GetMyeBayBuying in the Input/Output Reference.
In GetSearchResults, you can use Categories.DemandData to specify that the categories returned are sorted based on Best Match. The most relevant categories will be returned first.
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.
eBay no longer supports setting the option to display a breadcrumb above the listing header. Regardless of your request version, the Breadcrumb boolean is ignored in SetStore, and it is no longer returned in GetStore.
Additional logic changes have been implemented to help protect bidder identities and reduce unwanted commercial and malicious spam, such as phishing, spoof, and fake Second Chance Offers. Note the following changes:
For more information on the fields effected, see Working with Anonymous User Information. See the FAQs for the Safeguarding Member IDs project for more information about what eBay is doing to protect the privacy of members.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 511 and Changed Functionality - 511.
Although the field names are UserID, ItemID, SecretID, etc. (all with capital ID), when they are used in a URL for third party checkout, such as http://www.yoururl.com/yourpage?ItemId=xxx&TransId=yyy&OrderId=zzz..., they need to be UserId, ItemId, SecretId, etc. Further, the TransactionID field becomes TransId in the context of a URL for third party checkout. These details have been corrected and clarified in the section on Third Party Checkout.
The following clarification was also added to the same section: "If the item that is purchased is an item with a ListingType of Chinese, the transaction ID is 0."
The EndItem documentation has been updated to reflect the current behavior. For competitive-bidding listings that have bids on them, you must specify an EndingReason value. If you specify SellToHighBidder, the listing ends as a successful auction with winning bidder(s). Otherwise, all bids are cancelled before the item is ended.
There are two restrictions for ending items early in the last 12 hours of a listing. If there is a qualified bid (i.e., current high bid that, when applicable, meets the minimum reserve price) in the last 12 hours of a listing, the seller cannot end the item early. If the seller has cancelled a bid in the last 12 hours of the listing, the seller cannot end the item early.
Back to topDocumentation Changes and Errata - 509
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 |
|---|---|---|
ShippingServiceCodeType.USPSExpressMailInternational |
Enum | New |
ShippingServiceCodeType.USPSFirstClassMailInternational |
Enum | New |
ShippingServiceCodeType.USPSPriorityMailInternational |
Enum | New |
USPS rate changes are coming, and API developers will be impacted. Developers of listing applications should be aware of new warning messages returned by the AddItem family of calls. They should also be aware of the new and eliminated Shipping Services indicated via GeteBayDetails. Before June, developers should make changes to listing templates to stop using old Shipping Services.
For the latest details on the USPS rate change and the eBay API, see the following document: USPS Rate Changes
We have deleted all deprecated calls and fields from the schema as of the 499 release. Please see the announcement we provided previously for version 499.
IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). To help you prepare for this in advance, we recently changed the data types of store ID elements to xs:long (see Store ID Type Changes).
Please note that when these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
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 - 509.
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 - 509 and Changed Functionality - 509.
The CombinedPaymentPreferences option within the GetUserPreferences and SetUserPreferences calls has been superceded by a newer option within the GetShippingDiscountsProfile call. This newer option returns all of the data that was in the CombinedPaymentPreferences option, and it returns additional data that was not in the previous call.
The schema documentation for the CombinedPaymentPreferences option has been modified to let developers know that they should use the newer GetShippingDiscountsProfile call instead of CombinedPaymentPreferences.
If you use GetUserPreferences.CombinedPaymentPreferences, no payment preference data will be returned.
Back to topDocumentation Changes and Errata - 507
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 |
|---|---|---|
None for this release. |
N/A | N/A |
USPS rate changes are coming, and API developers will be impacted. Please see the overall API timeline below and take advantage of the early access available soon in the Sandbox. We will be publishing more details by mid April, so stay tuned!
Developer Impact: Developers of listing applications should be aware of the new warning messages returned by the AddItem family of calls. They should also be aware of the new and eliminated Shipping Services indicated via GeteBayDetails. Before June, developers should make changes to listing templates to stop using old Shipping Services.
Summary of USPS Changes (See USPS Site for details)
API Changes
Pre-Rate Change: Mid April
- AddItem, ReviseItem, and RelistItem will begin emitting warning messages for services that will soon be eliminated.
Date of Rate Change: Mid May (May 14, 2007)
- New International Services will become active, and some current International Services will be eliminated.
- AddItem, ReviseItem, and RelistItem will continue to accept eliminated services for a 30 day API grace period, returning a warning message to alert the end user.
Post Rate Change: Mid-June (after API grace period)
- AddItem and RelistItem will block listings containing eliminated services.
- GeteBayDetails will stop returning eliminated services, and ShippingServicesCodeType will no longer contain the old values.
Sandbox Support: Changes for USPS will be made early in the Sandbox to enable developers to test their applications and make necesary modifications prior to the actual USPS rate changes. Changes in the Sandbox should be expected the week of April 23 and will combine the "Pre Rate Change" and "Rate Change" behavior.
We have deleted all deprecated calls and fields from the schema as of the 499 release. Please see the announcement we provided previously for version 499.
IDs used for eBay Stores may reach 64-bit values by July 2007 (or later). To help you prepare for this in advance, we recently changed the data types of store ID elements to xs:long (see Store ID Type Changes).
Please note that when these IDs eventually reach 64-bit values, eBay will return the actual values regardless of your request version. Also note that July 2007 is the earliest we expect to see these IDs reach 64-bit values, but the changes could occur later than this.
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 - 507.
You can now find and purchase Half.com listings on eBay Express US.
In general, Half.com items are treated like any other item on Express. Here's how this feature affects the API:
GetSearchResultsExpress, GetCart, and SetCart support Half.com listings like any other listings on Express.
GetItemTransactions, GetSellerTransactions, GetOrderTransactions, GetMyeBaySelling, and GetMyeBayBuying do not support Half.com transactions, even for items sold on Express.
GetItem now retrieves Half.com listings (ListingType=Half). This is mainly useful for buying use cases in combination with GetSearchResultsExpress. As Half.com categories and Item Specifics are different from eBay's, we have implemented some workarounds to map the data. Here are the differences, in case this affects your application:
The way you list Half.com items with AddItem, VerifyAddItem, and ReviseItem is the same as before. For Half.com listings, be sure to always specify ListingType as Half, even in ReviseItem.
By default, if the seller and listing are eligible for Express, the Half.com item will appear on Express. Optionally, you can choose to exclude all your Half.com listings through a preference on the Half.com Web site, or you can use the existing ExpressOptOut flag in AddItem to exclude a specific listing. (To exclude all your eBay.com and Half.com listings from Express, use SetUserPreferences or the My eBay UI page, as usual.)
Beginning in upcoming months, the pay-per-lead feature will enable you to use pay-per-lead functionality in classified ads. The feature will affect AddItem, GetMyeBaySelling, and related calls.
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 - 507 and Changed Functionality - 507.
The documentation has been updated to indicate that use of GetContextualKeywords requires approval from the eBay Developers Program.
The documentation has been updated to indicate that, in GetSearchResults, the name of the eBay Store that is specified in StoreSearchFilter.StoreName is case sensitive.
The documentation has been updated to indicate that, in GetSearchResults, the SortByPayPalDesc input value is longer functional.
Back to topDocumentation Changes and Errata - 505
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 i
