The latest version of the Trading API has rolled out to all the API machines and is now available! Be sure to check out all the new features and known issues.
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:
|
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
These release notes go back four quarters. For older release notes, see the
Release Notes archive.
*Release 647
was delayed until the beginning of January in 2010, instead of being released
at the beginning of December, 2009.
Documentation Changes and Errata - 685
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
RateTableDetailsType |
Complex type | New |
AccountEntryType.ConversionRate |
Element | New |
GetAccountRequestType.IncludeConversionRate |
Element | New |
GetUserPreferencesResponseType.SellerThirdPartyCheckoutDisabled |
Element | New |
SellerType.DomesticRateTable |
Element | New |
SellerType.InternationalRateTable |
Element | New |
SetUserPreferencesRequestType.SellerThirdPartyCheckoutDisabled |
Element | New |
ShippingDetailsType.RateTableDetails |
Element | New |
DetailNameCodeType.ShippingCategoryDetails |
Enum | New |
ShippingServiceCodeType.DE_ExpressversandAusDemAusland |
Enum | New |
ShippingServiceCodeType.DE_SparversandAusDemAusland |
Enum | New |
ShippingServiceCodeType.DE_StandardversandAusDemAusland |
Enum | New |
ShippingServiceCodeType.EconomyShippingFromOutsideUS |
Enum | New |
ShippingServiceCodeType.ExpeditedShippingFromOutsideUS |
Enum | New |
ShippingServiceCodeType.StandardShippingFromOutsideUS |
Enum | New |
ShippingServiceCodeType.UK_EconomyShippingFromOutside |
Enum | New |
ShippingServiceCodeType.UK_ExpeditedShippingFromOutside |
Enum | New |
ShippingServiceCodeType.UK_StandardShippingFromOutside |
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 - 685.
For DE, UK, and US, a seller can set up a new domestic shipping rate table in eBay Site Preferences in the eBay UI, to be used with flat rate shipping. The domestic shipping rate table specifies supported levels of service (shipping categories) for special domestic locations and their associated rates. This allows the seller, for example, to specify a flat rate for the contiguous 48 states and other rates for the special US domestic locations: Alaska and Hawaii, US Protectorates, and APO/FPO addresses. The seller specifies the use of the shipping rate table for an item using the new container ShippingDetails.RateTableDetails. Buyers in a special domestic location sees only the shipping costs for the buyers location.
You can now also exclude special domestic locations for an item using ShippingDetails.ExcludeShipToLocation to prevent buyers in the excluded area from purchasing or bidding on your items. For more information see Using Shipping Rate Tables.
Starting in mid-September 2010, the integrated merchant credit card payment method (sometimes referred to as "IMCC") can be used not just for PayPal's Payflow Gateway but also for additional payment gateways, to be made available in My eBay. For information about the upcoming expansion in credit/debit card processing (through merchant accounts), see the FAQs about merchant accounts for sellers.
In AddItem and related calls, you will be able to use the
IntegratedMerchantCreditCard payment method
if the seller has signed up for a payment gateway that will be available in the My eBay preferences.
In a GetUser response, the
User.SellerInfo.IntegratedMerchantCreditCardInfo.SupportedSite field
indicates the sites on which a seller has a payment gateway account.
For information about using payment methods such as IntegratedMerchantCreditCard, see Payment Method Differences.
As previewed in the Sandbox beginning in 661, changes to My Messages allow you to retrieve high-priority messages along with other messages, restrict your message retrieval to high-priority messages, and get counts of your high-priority messages. Text-only versions of message content are now returned in GetMyMessages, in Messages.Message.Content.
Messages returned by GetMyMessages now include HighPriority message information. The field HighPriority is added as output in MyMessagesMessageType. Summary, returned by GetMyMessages, now includes NewHighPriorityCount and TotalHighPriorityCount. RepliedTo and Read booleans are now returned in the Message folder for GetMyMessages.
SetNotificationPreferences and GetNotificationPreferences, which used to support MyMessagesAlert and MyMessagesAlertHeader event types, will now support MyMessagesHighPriorityMessage and MyMessagesHighPriorityMessageHeader. Alerts are deprecated, affecting the following APIs: GetMyMessages, ReviseMyMessages, DeleteMyMessages, SetNotificationPreferences, and GetNotificationPreferences. Existing alert preferences (MyMessagesAlert and MyMessagesAlertHeader) will automatically migrate to the new high priority preferences (MyMessagesHighPriorityMessage and MyMessagesHighPriorityMessageHeader).
Other changes to GetMyMessages:
These changes are in effect for all versions of the affected APIs, including previous ones.
The GetAccount call can optionally return the rate used for the currency conversion for a transaction.
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.
Some eBay sites designate certain product-enabled categories (such as iPod & MP3 Players; Global Positioning Systems (GPS); and DVDs, HD DVDs & Blu-ray) as "value categories" where you can find great deals. Starting in mid-September, one or more of the following eBay sites will only support creating new listings in one category when you use a value category: eBay US, Canada, UK, Ireland, Germany, and Austria.
This change will only affect sellers who attempt to list in two categories. If the PrimaryCategory or SecondaryCategory is a value category, then eBay will drop the SecondaryCategory and list the item successfully with only the PrimaryCategory that was specified in the request.
Also, if the listing request includes item specifics (in ItemSpecifics or AttributeSetArray) associated with the SecondaryCategory, eBay will drop them at the same time.
The same logic will be used if you revise an existing listing to add a secondary category or to change one of the categories: If either the primary or secondary category is a value category, eBay will drop the secondary category from your request.
Existing listings that already have two categories will not be affected if you revise other data (even if one category is a value category). GTC listings with two categories will not be affected when they are auto-renewed by eBay.
We do not anticipate any listing failures as a result of this change. However, sellers who are not aware of this change may be surprised when they see that their listing only appears in one category. Therefore, it may be useful provide a message to your sellers to clarify that this is the expected behavior.
In an upcoming release, we will update GetCategoryFeatures to flag the value categories on these sites. It is possible that not all of these sites and categories will adopt this change, and it is possible that additional sites or categories will adopt this change in the future. Therefore, if you wish to prevent sellers from choosing two categories before submitting a listing in a value category. you should check GetCategoryFeatures.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 685 and Changed Functionality - 685.
Not all shipping services returned in GeteBayDetails can be used in new listings. Be sure to examine the rules provided in ShippingServiceDetails to determine which services can be used in the AddItem family of calls.
Documentation Changes and Errata - 681
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
GetUserPreferencesRequestType.ShowUnpaidItemAssistanceExclusionList |
Element | New |
UnpaidItemAssistancePreferencesType.AutoRelist |
Element | New |
UnpaidItemAssistancePreferencesType.ExcludedUser |
Element | New |
UnpaidItemAssistancePreferencesType.RemoveAllExcludedUsers |
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 - 681.
Starting in September, Unpaid Item Assistance will be turned on automatically for all PowerSellers and above. This mechanism will automatically open unpaid item cases 16 days after a buyer has not paid (a duration which the seller can change).
For details on the UPI Assistance mechanism, see Unpaid Item Assistance.
If disputes are being created and handled automatically via Unpaid Item Assistance, the seller can choose whether the items associated with the disputes are automatically relisted or the seller manually relists such items.
The value of UnpaidItemAssistancePreferencesType.AutoRelist reflects the seller's preference whether relisting (of auction or single-item fixed price items) is automatic within the Unpaid Item Assistance mechanism. (For a multi- quantity listing, if AutoRelist is true, no relisting is done; eBay merely adjusts the quantity.) This flag is set via SetUserPreferences.
A seller, for whatever reason, may wish for automatic dispute handling to not occur for certain buyers. The seller can use SetUserPreferences to identify each such buyer with UnpaidItemAssistancePreferencesType.ExcludedUser.
The seller can use SetUserPreferences to clear the entire list of excluded buyers with UnpaidItemAssistancePreferencesType.RemoveAllExcludedUsers, and GetUserPreferences to retrieve the exclusion list by setting the ShowUnpaidItemAssistanceExclusionList field to true.
For details on the UPI Assistance mechanism, see Unpaid Item Assistance.
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.
GetAccount now correctly returns Discount in AccountDetailsEntryType. Discount indicates that a PowerSeller, PowerSeller shipping, Top-rated seller, eBay Stores subscription, or other subscription discount was applied against the final value fee, insertion fee, subscription fee, late payment fee, or other fee. When Discount is returned, AccountEntry.Title returns an explanation of the discount and the percentage that was applied.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 681 and Changed Functionality - 681.
Prior documentation on Unpaid Item Disputes omitted the fact that the buyer must have paid via PayPal for eBay to automatically close the dispute. Here is the correct statement: "If the dispute was opened by UPI Assistance and if the buyer paid via PayPal, eBay closes the dispute."
You should URL-encode SessID when you included it in sign-in URLs for your users. Some session IDs returned by GetSessionID contain non-alphanumerical characters which, unless they are URL-encoded, cause failures for sign-in URLs that contain them.
Documentation Changes and Errata - 679
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
ShippingCategoryDetailsType |
Complex type | New |
QuantityAvailableHintCodeType |
Enumerated type | New |
GeteBayDetailsResponseType.ShippingCategoryDetails |
Element | New |
ItemType.QuantityAvailableHint |
Element | New |
ItemType.QuantityThreshold |
Element | New |
ShippingServiceDetailsType.ShippingCategory |
Element | New |
AccountDetailEntryCodeType.Discount |
Enum | Reserved for future use |
As of July 27, 2010, several categories are requiring that you specify the new, more granular ConditionID field in new and revised listings.
Call GetCategoryFeatures for your category and site to determine if the new condition values are required for your category, and which values the category supports.
See the Item Condition Settings XML sample for an example of how to interpret the GetCategoryFeatures response for conditions.
For revise, relist, and sell similar use cases only (including GTC renewal): In a few categories where the new condition names are identical to the condition names that were used in Attributes or Custom Item Specifics, eBay will map a listing's existing condition from item specifics to the new ConditionID format. eBay will do this automatically when the seller revises or relists or when GTC auto-renewal occurs for items in those categories. However, this mapping will not occur for new listings.
See the Item Condition Lookup table on your site for details about which categories support this type of mapping.
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 - 679.
For versions beginning with 679, you can now conceal the available quantity of fixed price listings using a new element, ItemType.QuantityThreshold.
For Daily Deal and flash sales, the tag QuantityAvailableHint with the value "Limited" will be returned by GetItem, GetItems, and GetSellerList.
For other multiple-item listings, you can set a QuantityThreshold of 10. When this is set, GetItem, GetItems, and GetSellerList will return the tag QuantityAvailableHint with a value of "MoreThan" and the tag QuantityThreshold with the value of the quantity threshold, as long as the actual quantity of available items is greater than the threshold. Currently, 10 is the only available value for QuantityThreshold.
ReviseInventoryStatus returns a warning message and does not update the item if you request a price or quantity that is identical to the existing price or quantity of the item. For example, if the StartPrice included in the request is identical to the existing StartPrice, the error will consist of the short message, "Requested StartPrice revision is redundant," and the long message, "The existing price value is identical to the price specified in the request and, therefore, is not modified."
For the US, UK and DE sites, shipping services are now assigned to shipping categories.
GeteBayDetails now returns the classification of each shipping service, such as Standard, Expedited, Economy, and so on. See ShippingCategoryDetails.
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 - 679 and Changed Functionality - 679.
The API calls that are used to interact with Half.com are a subset of the calls in the Trading API. A page that lists the calls applicable to Half.com is provided in the Trading API Guide.
Currently, in addition to the standard Trading Call Reference, a separate, "small" reference contains calls applicable to Half.com. That "small" reference contains the exact same information for each call as the standard call reference. The only difference is that in the "small" call reference, the Table of Contents only lists the calls applicable to Half.com.
For your Trading API needs, please bookmark the standard call reference, instead of bookmarking the "small" reference. In a future documentation release, the "small" reference will no longer be provided. However, the page that lists the calls applicable to Half.com will continue to be provided.
Documentation Changes and Errata - 677
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
GetMyMessagesRequestType.IncludeHighPriorityMessageOnly |
Element | New |
GetMyMessagesRequestType.Pagination |
Element | New |
MyMessagesFolderSummaryType.NewHighPriorityCount |
Element | New |
MyMessagesFolderSummaryType.TotalHighPriorityCount |
Element | New |
MyMessagesMessageType.HighPriority |
Element | New |
MyMessagesMessageType.ItemEndTime |
Element | New |
MyMessagesMessageType.ItemTitle |
Element | New |
MyMessagesMessageType.Replied |
Element | New |
MyMessagesSummaryType.NewHighPriorityCount |
Element | New |
MyMessagesSummaryType.TotalHighPriorityCount |
Element | New |
NotificationEventTypeCodeType.MyMessagesHighPriorityMessage |
Enum | New |
NotificationEventTypeCodeType.MyMessagesHighPriorityMessageHeader |
Enum | New |
ShippingServiceCodeType.AU_PrePaidExpressPostSatchel5kg |
Enum | New |
ShippingServiceCodeType.AU_RegularParcelWithTracking |
Enum | New |
ShippingServiceCodeType.AU_RegularParcelWithTrackingAndSignature |
Enum | New |
ShippingServiceCodeType.AU_SmallParcelWithTracking |
Enum | New |
ShippingServiceCodeType.AU_SmallParcelWithTrackingAndSignature |
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 - 677.
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.
ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)
Several shipping services have been added for Australia. You can retrieve these values with GeteBayDetails.
Newly available only in the Sandbox, a preview version of upcoming changes to MyMessages allows you retrieve high priority messages along with other messages, restrict your message retrieval to high priority messages, and get counts of your high priority messages.
In the sandbox, SetNotificationPreferences and GetNotificationPreferences, which used to support MyMessagesAlert and MyMessagesAlertHeader event types, will now support MyMessagesHighPriorityMessage and MyMessagesHighPriorityMessageHeader. Alerts are deprecated in the sandbox, affecting the following APIs: GetMyMessages, ReviseMyMessages, DeleteMyMessages, SetNotificationPreferences, and GetNotificationPreferences.
In the sandbox, existing alert preferences (MyMessagesAlert and MyMessagesAlertHeader) will automatically migrate to the new high priority preferences (MyMessagesHighPriorityMessage and MyMessagesHighPriorityMessageHeader).
If an explicit date filter is not specified in a GetMyMessages request, only the last three month's messages will be returned.
These sandbox-only changes are in effect for all versions of the affected APIs, including previous ones.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 677 and Changed Functionality - 677.
Sellers who subscribe to FixedPriceTransaction and FixedPriceEndOfTransaction should be aware that FixedPriceTransaction is returned for items of listing types FixedPrice and StoreFixedPrice, but FixedPriceEndOfTransaction is returned for items of StoreFixedPrice listing type only.
Documentation Changes and Errata - 675
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
TaxDetailsType |
Complex type | New |
TaxesType |
Complex type | New |
TaxDescriptionCodeType |
Enumerated type | New |
TaxTypeCodeType |
Enumerated type | New |
TransactionType.Taxes |
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 - 675.
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 release 669, GetSellerEvents was modified to return a maximum of 1000 items. That limit has been removed.
As a best practice, use time filters that retrieve fewer than 3000 items. If exactly 3000 items (or in rare cases, more than 3000) are returned, it usually means more items exist that match the requested time range, but they cannot be returned. To make sure you don't miss items, use a shorter time range so that fewer than 3000 are returned in each response.
See Best Practices for GetSellerEvents and GetSellerTransactions in the Knowledge Base for additional best practices.
US eBay Motors no longer offers a free 1 month/1,000 mile Short-Term Service Agreement (also referred to as eBay's limited warranty). The LimitedWarrantyEligible flag is now ignored in AddItem and related calls, and it will be removed from the schema soon.
The corresponding read-only Limited Warranty attribute (26738) only returns -14 ( No ) in GetItem. (GetAttributesCS still returns this attribute's other values for reference, as before.)
Please note that this change does not affect the Vehicle Condition Guarantee by Seller (attribute 214, "Seller Guarantee") or the ability to specify the manufacturer's existing warranty (attribute 10242, "Existing Warranty").
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 675 and Changed Functionality - 675.
The documentation for getting approval to use PlaceOffer in production has been updated. For more information, see Applying for Approval of the eBay Partner Network.
Documentation Changes and Errata - 673
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
| Name | Part of Schema | Type of Change |
|---|---|---|
PurchaseReminderEmailPreferencesType |
Complex type | New |
GetUserPreferencesRequestType.ShowPurchaseReminderEmailPreferences |
Element | New |
GetUserPreferencesResponseType.PurchaseReminderEmailPreferences |
Element | New |
SetUserPreferencesRequestType.PurchaseReminderEmailPreferences |
Element | New |
UserType.StaticAlias |
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 - 673.
Schema changes are available for static email functionality, which was announced in a previous Release Notes entry. Each eBay member will be assigned a static alias to be used in a static email address, and this affects several Trading API calls. For information about the changes and timing, please see the initial Release Notes entry.
Schema changes are available related to a new preference for sellers, which was announced in a previous Release Notes entry. The preference soon will be added to My eBay, and is called "Send eBay Payment Reminder Email to My Buyers." This affects two Trading API calls. For information about the changes and timing, please see the initial Release Notes entry.
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.
After June 29, 2010, Featured First (a listing upgrade for eBay top-rated sellers) will be unavailable on the US site (and in the eBay Motors Parts and Accessories category). For the details about this change, including the effect on existing listings, see the April 2010 announcement. If an AddItem call includes Featured First, the item will be listed, but Featured First will be dropped and a warning will be returned.
Please continue to use GeteBayDetails to retrieve the available meta-data for a specified eBay site.
On the US site (site ID 0), and on the US eBay Motors site (site ID 100),
the GeteBayDetails response will contain a value of Disabled
in ListingFeatureDetails.FeaturedFirst.
Good 'Til Cancelled listings will continue to have Featured First, until their first renewal after June 29. For example, if Featured First is added to a 30-day or GTC listing on June 26, Featured First will be dropped upon renewal of the listing on July 26.
In conjunction with the above changes, the ProPack listing upgrade will be removed from the eBay Motors Parts and Accessories category.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 673 and Changed Functionality - 673.
None for this release.
No 671 schema was released.
No new calls in this release.
No changed calls in this release.
None for this release.
Documentation Changes and Errata - 669
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
AddressUsageCodeType |
Enumerated type | Reserved for future use |
AddressType.AddressUsage |
Element | Reserved for future use |
GetSellerEventsRequestType.HideVariations |
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 - 669.
GetSellerEvents now supports a HideVariations field that suppresses variation details in the response. This can help to reduce the response size for applications that use other calls, alerts, notifications, or reports to keep track of changes to variation details.
Also, GetSellerEvents supports a maximum of 1000 items. If more than 1000 items are found, you may need to reduce the requested time range to retrieve all the available items.
Most sites and categories now support listing with the new item condition values and ConditionID in the Sandbox and Production. The Malaysia and Philippines sites will support the new item conditions soon. Vehicle categories on the US eBay Motors site will support the new item conditions later this year. Keep an eye on the eBay Developers Program newsletter for updates.
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.
If a seller is delinquent on their Resolutions Center balance, then when a PlaceOffer call is made for the seller, an error may be returned. The error states that the seller's account is on hold, due to an unpaid balance related to the Resolutions Center. A seller can pay the delinquent fees using a link on the Account tab of My eBay.
Note that the error is returned only if the account is on hold due to non-payment of the resolution balance. (If the account is delinquent, but not yet on hold, then the error is not returned.)
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 669 and Changed Functionality - 669.
None for this release.
Documentation Changes and Errata - 667
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
VeROReportItemType.Country |
Element | New |
VeROReportItemType.DetailedMessage |
Element | New |
VeROReportItemType.Patent |
Element | New |
VeROReportItemType.Region |
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 - 667.
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.
Four conditionally required fields are added to VeroReportItemType to make reports about alleged infringements of copyright, specifically patent and parallel import, more complete. The fields are Patent, Region, Country, and DetailedReason. These fields become conditionally required in the current release, and after this release will be conditionally required regardless of the version of the request. In addition, the Notice of Claimed Infringement document has been updated and the reason codes have been consolidated, eliminating reason codes 1.1, 3.2, 3.4, and 3.5.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 667 and Changed Functionality - 667.
None for this release.
Documentation Changes and Errata - 665
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.
Please see the recent announcements for sellers on the eBay Developers Program blog and Announcement Board.
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 - 665.
Changes are scheduled for messaging between members. Each member will be assigned a static alias to be used in a static email address, and the email address will end in @members.ebay.<SiteDomain>. The <SiteDomain> value will be based on the user's registered site, e.g. @members.ebay.de. The <SiteDomain> value will identify the user's language. If the user changes the registered site, then the value of <SiteDomain> will change accordingly.
The modifications to the API include replacing the email address returned by GetMemberMessages with a static email address, in the following field: MemberMessage.MemberMessageExchange.Question.SenderEmail. Additionally, the conversation ID will be in the body of the email returned by GetMemberMessages. The conversation ID also is referred to as the email reference ID. Starting in June 2010, all messages must contain a conversation ID, so eBay can validate them.
The following calls also will be updated. The current email address that is returned will be supplemented by a static email address, as follows:
For general information about changes that are scheduled for messaging, see the links at the eBay Announcement Board. A few sellers (who have been notified) will see the GetMemberMessages changes in a controlled, mid-April beta release. But most sellers will see the changes in June 2010.
The static alias will be used in the "reply to" address in emails from other members. Sellers may have to change their systems to be able to identify the buyer with the new email address. Please note that the "reply to" address will have the user ID and alias address. For details, see the links provided at the eBay Announcement Board (above). This step of making emails anonymous is becoming an industry standard.
Users will be able to test the new functionality. To do so, they will click "Preview how email intermediation works" in the Notification Preference Page (under Account in My eBay). After a user clicks the link, a test email will be sent to the user's personal email inbox.
A new preference for sellers will soon be added to My eBay. The preference is called "Send eBay Payment Reminder Email to My Buyers." The preference controls whether eBay sends a reminder to buyers to pay for a purchase.
Currently, eBay sends the email by default, and this functionality cannot be changed by a seller. But starting in June 2010, in My eBay, sellers can specify that the email should not be sent. The corresponding changes will be made in the Trading API.
When the Trading WSDL is updated in June 2010, it will include functionality for 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.
| Summary of change | Request version lower than 665 | Request version of 665 or higher |
|---|---|---|
| A. Promotional shipping savings is reflected in the total shipping cost. | Promotional shipping is not considered, period. |
If promotional shipping could apply to this listing:
|
| B: Shipping services are filtered for the buyer, as needed. | The shipping services offered by the seller were presented to the buyer even if such services were not available to the buyer in the buyer's region. In the event that no services remain, ShippingCostSummary (Shopping API) is returned empty. No warning is returned. | The shipping services are filtered before being returned to the buyer so that the buyer is not presented with shipping services not applicable to the buyer's region. |
| C: The total shipping cost now includes any surcharge, and surcharge is no longer returned as an individual tag. | The total shipping cost does not include surcharge. If there is a surcharge, it is returned in its own tag. | The total shipping cost includes surcharge. Surcharge is not returned as its own tag. |
In AddItem and related calls, if you pass a ConditionID value that is not valid for the category:
Disabled (or it's not applicable) for the category, the item is listed with no condition.Enabled or Required for the category, the listing request fails.As before, if you pass ConditionID and an item condition attribute in the same request, the item condition attribute is dropped. In addition, the entire AttributeSetArray is removed if the item condition was the only attribute. Similarly, for listings with catalog products, the default "-" value (for an unspecified condition) is dropped (i.e., no longer pre-filled).
To reduce the response size, GetCategoryFeatures no longer returns ConditionValues when ConditionEnabled=Disabled for a category.
As previously documented, GetCategory2CS does not return site-wide condition category mappings in the sandbox with request version 665 and higher (667 and higher in production).
Please note that if a category is mapped to a characteristic set with a "local" condition attribute instead (which is common on the eBay US site), the request version has no effect. If your application automatically displays attributes plus the new ConditionID options, this means you could end up showing both item condition options (possibly with different values) to your users. See Suppressing a Duplicate Item Condition in Attributes for more information.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 665 and Changed Functionality - 665.
None for this release.
Documentation Changes and Errata - 663
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 |
|---|---|---|
PaymentHoldStatusCodeType.NewSellerHold |
Enum | New |
Parts compatibility APIs were introduced in the 653 release. Initially, parts compatibility was supported in the Sandbox environment only. Parts compatibility is being released in Production for selected eBay Motors > Parts & Accessories > Car & Truck Parts categories starting in March:
See the Introducing a New Way to List Products that Fit Multiple Vehicles post in the Developers Program News Blog for more information.
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 - 663.
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.
Your application's Display Title, which you specify when you set your RuName in the Application Settings tab, now appears correctly in MyeBay for your users. Before this fix, users saw only your company name, and not the display title, in some MyeBay flows. For example, if the display title you entered in the Manage Your RuNames form is "MyApplication," and your company name is "MyCompany," your application's users will now also see "MyApplication" in their MyeBay.
You can now omit both ItemID and BestOfferID when calling GetBestOffers. In such case, it returns a list of up to 1,000 IDs for best offers submitted by the user (as a bidder) and up to 10,000 IDs for best offers received by the user (as a seller).
When the filter "All" is used in this case (when both ItemID and BestOfferID are omitted), its behavior is not "all" but is instead "active best offers only" (i.e. the same as Active).
The UploadSiteHostedPictures call now accepts an image size of 7MB. The previous size limit was 4MB.
Under the "new seller hold" feature, PayPal may hold the payments to new sellers for up to 21 days. Money may be released faster if tracking information or delivery confirmation is provided, or if the buyer leaves positive feedback.
If a "new seller hold" applies to an item, GetItemTransactions
returns the NewSellerHold value in the following field: TransactionArray.Transaction.Status.PaymentHoldStatus. Several other
calls return the same status. For more information about this feature, and the list of calls that
return the payment hold status, see Holds on PayPal Payments.
eBay defines a new seller account as one with less than 90 days since the first successful sale of an item.
This field in ItemType and ShippingDetailsType is no longer being used. It will be officially deprecated later in 2010.
Affected calls: AddFixedPriceItem, AddItem, AddItems, AddSellingManagerTemplate, GetBidderList, GetBidderList, GetItem, GetItemRecommendations, GetSellerList, GetSellerTransactions, GetSellingManagerTemplates, RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem, ReviseItem, ReviseSellingManagerTemplate, VerifyAddItem, VerifyRelistItem.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 663 and Changed Functionality - 663.
Documentation Changes and Errata - 661
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.
None for this release.
As of this release, the eBay User Interface will display 'Limited Quantity' to Buyers for US Daily Deal items. Sellers will still see the exact quantity when looking at their listings. Likewise, the eBay User Interface will display 'More than 10 available' to Buyers instead of the exact quantity, if Sellers have set this as a preference in their My eBay Account -> Site Preferences -> Selling Preferences -> Sell Your Item form and listings -> Quantity Preference Display.
There are no corresponding API changes for these options.
As of this release, restrictions based on buyer feedback and length of registration will no longer apply to registered sellers listing single and multiple items as fixed price on some sites.
The following sites are affected: US, CA, CAFR, Motors, HK, SG, MY, PH, IE, AT, CH, DE, and IN.
For listing single fixed price items on the US, CA, CAFR, Motors, HK, SG, MY, PH, IE, AT, CH, DE, and IN sites: if a registered seller's feedback is greater than or equal to zero, the seller can use fixed price listing.
Listing multiple fixed price items on the US, CA, CAFR, Motors, HK, SG, MY, PH, IE, AT, CH, and DE sites: if a registered seller's feedback is greater than or equal to zero, the seller can use fixed price listing.
Listing multiple fixed price items on the IN site: if the seller has been registered for at least 14 days and has feedback greater than or equal to zero, the seller can use fixed price listing.
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 - 661.
The StoresFixedPrice listing type is being retired on all sites. Included in this change is the following: For the US, Canada (CA), French Canadian (CAFR), and US Motors sites, the FixedPriceItem listing type will replace the StoresFixedPrice listing type. The StoresFixedPrice listing type is being retired worldwide. The StoresFixedPrice listing type will be deprecated in early 2011. As of March 30, 2010, a migration phase is occurring; AddItem and AddFixedPriceItem accept either FixedPriceItem or StoresFixedPrice as listing types, but the item is displayed as FixedPriceItem on the site and in search results. GetItem and other 'Get' calls return the listing type you originally used in the request. Therefore, the preferred format is FixedPriceItem.
In additon to the changes mentioned above, items added as StoresFixedPrice listing type will be treated as FixedPriceItem listing type on the site. Items will immediately get the higher FixedPriceItem exposure, and will renew or relist at the FixedPriceItem price.
Any listing enhancements (e.g., bold, subtitle, etc.) will also renew or relist at FixedPriceItem (higher) rates.
To list a product for a store, you can simply substitute FixedPriceItem as the listing type where the StoresFixedPrice listing type used to be within your AddItem call. Like StoresFixedPrice, the FixedPriceItem listing type has permitted durations of 30 days and GTC for store and non-store subscribers (in addition to the previously permitted durations of 3, 5, 7, and 10 days).
See the Developer's Blog entry, Developer Impact: Spring 2010 for more information on developer impact.
As part of the merge of StoresFixedPrice and FixedPriceItem listing types, the start price of all new FixedPriceItems must be 99 cents or greater. This change will also go into effect on March 30, 2010.
Conversely, for Auction format listings with large (more than 100 items) lots, sellers are encouraged to price the items between 1 cent and 99 cents. Special incentives for sellers may be offered at a later date. Watch the eBay Developer's Blog for more details.
We are releasing a new way of specifying Item Condition with the API. Previously you used AttributeSetArray, LookupAttributeArray, or ItemSpecifics to specify the condition of an item. Now you can use a new field, ConditionID, to specify the condition. The AddItem family of calls and GetItem support this new field, and GetItem also supports a human-readable label in ConditionDisplayName.
Unlike ID-based attributes, all categories and sites now use consistent IDs for each condition, although the list of conditions that are supported can vary for each category and site. For example, 1000 is always used for brand new items in their original retail packaging (or equivalent).
See Specifying an Item's Condition in the Trading API Guide for more details, including information about categories that are enabled in the Sandbox, the new list of condition IDs that are supported across all sites, rules for GTC (Good 'Til Canceled) listings, and considerations if you currently use ID-based attributes or custom item specifics to specify an item's condition.
Here is an example of the new field in AddItem:
<Item>
<Title>Apple MacBook Pro MB990LL/A 13.3 in. Notebook NEW</Title>
<Description>Brand New Apple MacBook Pro MB990LL/A 13.3 in. Notebook!</Description>
<PrimaryCategory>
<CategoryID>111422</CategoryID>
</PrimaryCategory>
<ConditionID>1000</ConditionID>
Here is an example of the new fields in GetItem:
<Item>
<Title>Apple MacBook Pro MB990LL/A 13.3 in. Notebook NEW</Title>
<Description>Brand New Apple MacBook Pro MB990LL/A 13.3 in. Notebook!</Description>
<PrimaryCategory>
<CategoryID>111422</CategoryID>
</PrimaryCategory>
<ConditionID>1000</ConditionID>
<ConditionDisplayName>New</ConditionDisplayName>
Please note the following timing:
The new condition fields were added to the schema in release 655, but they were not yet functional in any calls. In order to maintain backward-compatibility for applications that have already adopted a more recent version of the schema, version control related to these changes is not tied to release 655.
GetCategorySpecifics and GetItemRecommendations will suppress item condition recommendations for categories that have ConditionID enabled when you pass request version 661 or higher in the Sandbox and request version 667 or higher in production. In an upcoming release, similar logic will be added to GetCategory2CS for site-wide conditions, and the version control for that call will be tied to that functional release. However, GetAttributesCS will continue to return condition attributes for all versions.
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.
Regarding size increase (for some calls) of the MemberMessage.Body input field (which was announced in the 657 Release Notes), the documentation has been updated to state that if the API version is less than 653, the limit remains at 2000 for AddMemberMessageRTQ and at 1000 for AddMemberMessageAAQToPartner.
These elements are not returned for all sites. Beginning at the end of 2009, eBay stopped returning them for sellers registered on several large sites, including the US, German, and UK sites.
In the GetMyMessages call, Alerts are now treated as flagged messages. Data formerly in the Alerts container now is returned in the Messages container, and the Alerts container is empty.
This change also affects ReviseMyMessages and DeleteMyMessages.
The documentation for the affected calls has been updated with this change.
In the GetMyMessages call, for each high priority message, the Flagged field has a value of true. When the Flagged field is true, it means the message is displayed with a flag in the seller's My Messages mailbox on eBay. It is strongly recommended that the seller act on the message by the specified date (or within 60 days, if not specified).
In upcoming months, schema changes will include:
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 661 and Changed Functionality - 661.
In ItemType, the definitions of AutoPay and ThirdPartyCheckout claimed incorrect requirements for ThirdPartyCheckout. Please see the corrected definitions: AutoPay, ThirdPartyCheckout.
As of Release 605, ItemID is not a required field within the AddMemberMessageRTQ request. This is correct in the Call Reference, but was not called out in the Release Notes for Release 605.
Documentation Changes and Errata - 659
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 |
|---|---|---|
| ItemType.TaxCategory | Element | Reserved for future use |
The StoresFixedPrice listing type is being retired on all sites. For the US, Canada (CA), French Canadian (CAFR), and US Motors sites, the FixedPriceItem listing format will be replacing the StoresFixedPrice listing format, and the StoresFixedPrice format will be deprecated in early 2011. Therefore, at the end of March 2010, we will start a migration phase where AddItem will accept either FixedPriceItem or StoresFixedPrice as listing formats, but the item will be displayed as FixedPriceItem on the site and in search results. GetItem and other 'Get' calls will return the format you originally used in the request. Therefore, the preferred format will be FixedPriceItem.
See the Developer's Blog entry, Developer Impact: Spring 2010 for more information on developer impact and how to migrate your code.
At the beginning of March, sellers registered on Hong Kong, Malaysia, Philippines, and Singapore sites who engage in cross-border trade on sites that require a recoupment agreement (currently US, UK, and US Motors), must agree to the recoupment terms before adding a cross-border listing. The seller must click the 'I Agree' button on the site where the trade will take place.
For instance, the eBay Developer Site now includes links to the cross-border recoupment agreement, that will be visible to sellers from Hong Kong, Malaysia, Philippines, and Singapore until they have agree to the recoupment terms. If they choose not to agree, they will not be able to list on that site. For developers with cross-border items listed on the US and Motors sites, the agreement is located here: https://scgi.ebay.com/ws/eBayISAPI.dll?CBTRecoupAgreement. The UK site will have their own agreement, which is located at: https://scgi.ebay.co.uk/ws/eBayISAPI.dll?CBTRecoupAgreement.
Third-party developers who need to know which sellers have agreements in place can look at the sites listed in the RecoupmentPolicyConsent container of the GetUser response, and developers who need to know which sites require a cross-border recoupment agreement can look at the EnforcedOnListingSite field in the RecoupmentPolicyDetails container of the GeteBayDetails response.
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 - 659.
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 - 659 and Changed Functionality - 659.
None for this release.
Documentation Changes and Errata - 657
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 |
|---|---|---|
ExtendSiteHostedPictures |
New Call | Available for authorized customers in early March. |
RecoupmentPolicyConsentType |
Complex type | New |
GalleryStatusCodeType |
Enumerated type | New |
PictureWatermarkCodeType |
Enumerated type | New |
PictureDetailsType.GalleryErrorInfo |
Element | New |
PictureDetailsType.GalleryStatus |
Element | New |
SellerType.RecoupmentPolicyConsent |
Element | New |
UploadSiteHostedPicturesRequestType.ExtensionInDays |
Element | New |
UploadSiteHostedPicturesRequestType.PictureWatermark |
Element | New |
In the API, the FixedPriceItem listing format will be replacing the StoresFixedPrice listing format, and the StoresFixedPrice format will be deprecated in early 2011. Therefore, in March 2010, we will start a migration phase where AddItem will accept either FixedPriceItem or StoresFixedPrice as listing formats, but the item will be displayed as FixedPriceItem on the site and in search results. GetItem and other 'Get' calls will return the format you originally used in the request. Therefore, the preferred format will be FixedPriceItem.
See the Developer's Blog entry, Developer Impact: Spring 2010 for more information on developer impact and how to migrate your code.
As of February 2010, the lowest supported Trading API version is 577. (Version 577 was released in August 2008.) Objects that were deprecated prior to version 577 no longer work, or may stop working at any time without notice. We recommend that you remove deprecated objects from your applications as soon as possible.
Here are examples of objects that were deprecated 18-24 months ago:
For information about how Trading API versioning works and a more complete list of the objects that have been deprecated, see:
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 - 657.
At the beginning of March, Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the recoupment terms before adding a cross-border listing to the site.
This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. The US site is a recoupment site. This change will affect the AddItem, VerifyAddItem, GetUser, and GeteBayDetails calls.
The eBay Developer Site will include links to the cross-border recoupment agreement links that will be live at the beginning of March. For developers with cross-border items listed on the US site, the agreement will be located here:https://scgi.ebay.com/ws/eBayISAPI.dll?CBTRecoupAgreement. The UK site will have their own agreement, which will be located at: https://scgi.ebay.co.uk/ws/eBayISAPI.dll?CBTRecoupAgreement.
The eBay Picture Services (also known as EPS) now includes support for watermarks. Sellers can specify whether they want to include their SellerId or an icon as the watermark. If gallery photos are not able to be uploaded, specific error messages, such as 'InvalidUrl' or 'ServerDown' are returned.
Two new code types, GalleryStatusCodeType and PictureWatermarkCodeType have been added to the schema as part of this feature, as well as two new PictureDetailsType options - GalleryErrorInfo and GalleryStatus.
A restricted call, ExtendSiteHostedPictures has also been added as part of this feature. This call gives sellers the ability to extend the default and ongoing lifetime of pictures uploaded to eBay. This call was added to support applications that need to manage pictures for eBay listings persistently, independently of whether the pictures are extended automatically via use in an eBay listing.
eBay considers the following criteria when deciding whether to allow a vendor to manage picture lifetime in this way.
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.
Sellers who have less then 50 feedback and want to list on the German site, are now required to provide PayPal as one of the payment options. The PayPal option is not required for Cars or Real Estate listings.
Due to ongoing work on some messaging calls, the size of a field in four calls has increased.
AddMemberMessageRTQ and AddMemberMessageAAQToPartner. For both calls, the content of the following input field has increased to 4000 characters in size: MemberMessage.Body. However, if the API version is less than 653, the limit remains at 2000 for AddMemberMessageRTQ and at 1000 for AddMemberMessageAAQToPartner.
GetMemberMessages. If you use an API version of 653 or higher, then the content of the following field can be up to 4000 characters in size: MemberMessage.MemberMessageExchange.Question.Body. However, if the API version is less than 653, the limit is 2000, so if the actual message had more than 2000 characters, a warning message is returned and the message is truncated. It is recommended that you upgrade to a later API version to avoid truncated messages.
GetMyMessages. In recent months, the Messages.Message.Text field limit increased, due to threaded messages. The field can contain up to 2 MB of data, no matter what API version you use. For example, if a user's text content is 1.5 MB, then the data in the field could be 1.5 MB.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 657 and Changed Functionality - 657.
Disputes created by buyers via the eBay Dispute Resolution for Buyer Claims process are not returned in the GetUserDisputes response. Sellers must use the Dispute Resolution Center to handle these particular disputes.
Documentation Changes and Errata - 655
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 |
|---|---|---|
ConditionEnabledDefinitionType |
Complex type | New. Reserved for future use. |
ConditionType |
Complex type | New. Reserved for future use. |
ConditionValuesDefinitionType |
Complex type | New. Reserved for future use. |
ConditionValuesType |
Complex type | New. Reserved for future use. |
RecoupmentPolicyDetailsType |
Complex type | New |
ConditionEnabledCodeType |
Enumerated type | New. Reserved for future use. |
CategoryFeatureType.ConditionEnabled |
Element | New. Reserved for future use. |
CategoryFeatureType.ConditionValues |
Element | New. Reserved for future use. |
FeatureDefinitionsType.ConditionEnabled |
Element | New. Reserved for future use. |
FeatureDefinitionsType.ConditionValues |
Element | New. Reserved for future use. |
GeteBayDetailsResponseType.RecoupmentPolicyDetails |
Element | New |
ItemType.ConditionDisplayName |
Element | New. Reserved for future use. |
ItemType.ConditionID |
Element | New. Reserved for future use. |
SiteDefaultsType.ConditionEnabled |
Element | New. Reserved for future use. |
SiteDefaultsType.ConditionValues |
Element | New. Reserved for future use. |
DetailNameCodeType.RecoupmentPolicyDetails |
Element | New |
FeatureIDCodeType.ConditionEnabled |
Enum | New. Reserved for future use. |
FeatureIDCodeType.ConditionValues |
Enum | New. Reserved for future use. |
In the API, the FixedPriceItem listing format will be replacing the StoresFixedPrice listing format, and the StoresFixedPrice format will be deprecated in early 2011. Therefore, in March 2010, we will start a migration phase where AddItem will accept either FixedPriceItem or StoresFixedPrice as listing formats, but the item will be displayed as FixedPriceItem on the site and in search results. GetItem and other 'Get' calls will return the format you originally used in the request. Therefore, the preferred format will be FixedPriceItem.
See the Developer's Blog entry, Developer Impact: Spring 2010 for more information on developer impact and how to migrate your code.
At the end of February, sellers who have less then 50 feedback and want to list on the German site, will be required to provide PayPal as one of the payment options. The PayPal option will not be required for Cars or Real Estate listings.
Also near the end of February, sellers who list on sites that require a recoupment agreement, must sign an agreement before adding a listing to the site. This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. The US site will be a recoupment site. This change will affect the AddItem, VerifyAddItem, GetUser, and GeteBayDetails calls.
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 - 655.
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.
It is possible for an order to contain one or more transactions that the buyer should not have to pay for. For example, a bidder bids on ten items and then, because only nine are available in stock, the buyer and seller agree to cancel one items.
With a request version lower than 655, the buyer is asked to pay for all items in the order, including any canceled transactions.
With a request version of 655 or higher, eBay removes the canceled transaction from the order (and thus the buyer can pay for the rest of the order without having to pay for the canceled transaction).
With version 637, eBay introduced changes in the Unpaid Item process. Unfortunately, the SellerOpenedDispute and SellerClosedDispute platform notifications ceased to be sent with the newer process. This has been corrected with version 655--the notifications are now sent with the updated process.
Logic has been improved for Unpaid Item Assistance. Prior to version 655, a seller who has opted into Unpaid Item Assistance could only disable further automated handling of a particular dispute after that dispute was automatically created (or "opened") by the Unpaid Item Assistance mechanism.
With a request version of 655 or higher, that seller can prevent automatic handling for a specific item before any dispute has been created. To do so, the calls DisableUnpaidItemAssistance with the itemID/transactionID pair.
AddFixedPriceItem is now enabled for all sites except Canada (site ID 2) and the Canada French site (site ID 210). This resolves an issue previously noted in the Developer Forums.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 655 and Changed Functionality - 655.
None for this release.
Documentation Changes and Errata - 653
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 |
|---|---|---|
VerifyRelistItemRequestType |
Complex type | New |
VerifyRelistItemResponseType |
Complex type | New |
OrderStatusFilterCodeType |
Enumerated type | New |
GetPromotionalSaleDetailsRequestType.PromotionalSaleStatus |
Element | New |
ItemListCustomizationType.OrderStatusFilter |
Element | New |
ReviseItemRequestType.VerifyOnly |
Element | New |
ReviseItemResponseType.VerifyOnly |
Element | New |
StoreType.TitleWithCompatibility |
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 - 653.
Per your request, these are now returned by GetOrders and GetOrderTransactions for both Trading and Half.com. See ShipmentType.ShipmentTrackingDetails for ShipmentTrackingNumber and ShippingServiceUsed.
The new VerifyRelistItem request allows you to preview the response and fees for an item you want to relist, before you make the actual RelistItem call. This call requests and returns the same data as RelistItem (same inputs, same outputs, and same usage rules), but without actually listing the item to an eBay site.
Applications can use this call to test the definition of an item before actually listing it to eBay with RelistItem, reducing item listing-related errors.
You can use the VerifyOnly boolean field with the flag set to 'true',
if you wnat the response to include the calculated listing price change (if there is an
increase in the BIN/Start price) but you do not want the values to persist in the database.
Including the VerifyOnly field in ReviseItem is similar to using
VerifyAddItem or VerifyRelistIteem.
A new input field, PromotionalSaleStatus, has been added to GetPromotionalSaleDetails call to restrict the promotional sales returned to those that match the specified status only.
| Note: At this time, the API changes for Parts Compatibility are supported in select test categories for eBay Motors (site ID 100) in the Sandbox only. Starting in March, Parts Compatibility will be supported in limited Parts & Accessories categories for eBay Motors in the Production environment. |
Parts Compatibility is an eBay feature that uses structured data to associate compatible assemblies with parts listed on eBay. For example, Parts Compatibility enables sellers to specify accurately and comprehensively the vehicles on which a side mirror or a rim will fit. Parts compatibility improves search relevancy and frees up item titles and descriptions for more useful descriptions of the part.
Parts Compatibility is enabled by category. Use GetCategoryFeatures with the the following feature IDs to determine what categories support parts compatiblity and/or the minimum required and maximum allowed compatible applications to provide when specifying parts compatibility by application:
The AddItem family of calls now allows you to list with parts compatibility in three ways:
| Note: Additional APIs are required to determine which products support parts compatibility. Similarly, additional APIs are required to look up the property names and values for specifying what assembly (vehicle) a part applies. These APIs, the Product API and the Product Metadata API respectively, will be available in February 2010. |
Sellers can use GetItem to confirm the number of compatibilities specified for a given listing (Item.ItemCompatibilityCount) or to retrieve all parts compatibility details for the item (Item.ItemCompatibilityList).
Items listed with parts compatiblity information help connect buyers with parts and accessories for their assembly, such as a car or truck. When a buyer is looking for a part or accessory for his car, he can specify the year, make, and model of his car (sometimes referred to as compatiblity search names) and any details about the part he's trying to find (e.g., 2004 honda accord tires). Listings with parts compatiblity information get a best match boost in search results. Items in the search results with parts compatiblity information that matches terms in your search query display the compatibility match (e.g., Fits: 2004 Honda Accord).
This new search behavior is supported by the Finding API and the Best Match Item Details 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.
As part of the eBay Top-Rated Seller initiative, at the end of January 2010 GetSellerDashboard will begin returning the AboveStandard rating for the UK/IE and DE/AT/CH sites when the call specifies 653 or a later version. Those sites continue to return the TopRated, Standard, and BelowStandard ratings, and the default value for these sites remains the Standard rating.
Previously, Buyers have been able to subscribe to get notified when a seller has closed a listing dispute. Now the Seller can also subscribe to the notification.
Within the next few weeks, the number of categories processed by GetCategorySpecifics will change: GetCategorySpecifics will retrieve recommendations for the first 100 categories passed in the request, and any additional categories after the first 100 will be dropped with a warning.
This change is being made to reduce the number of request failures due to too many recommendations found. (Previously, the limit was approximately 275 categories.)
This change will occur regardless of the version number you pass in the request.
This change does not affect the number of categories returned in the asynchronous GetCategorySpecifics payload returned by the File Transfer Service.
In response to your product feedback, these enhancements have been made to GetMyeBaySelling:
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 653 and Changed Functionality - 653.
GetSellingManagerTemplates uses the following detail levels: ItemReturnDescription, ItemReturnAttributes, and ReturnAll. These detail levels are returned only when the request includes a single TemplateID. Conditionality and other details are being verified and will appear in future documentation of this call.
The ReviseCheckoutStatus documentation incorrectly used the definition of PaymentStatus from GetSellerPayments. The definition has been corrected.
No 651 schema was released.
No new calls in this release.
No changed calls in this release.
No 649 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 647
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.
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 - 647.
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 - 647 and Changed Functionality - 647.
Minor changes were made to the Store Inventory Format information to ensure consistency between the Call Reference and the eBay Trading API Guide. No functionality was changed in these areas.
No 645 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 643
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.
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 - 643.
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 - 643 and Changed Functionality - 643.
Version 639 release notes surveyed various process changes for Unpaid Item Disputes.
Support for the old process will be removed around March 2010, so please migrate your UPI dispute code to work with the new process.
How do you know whether the newer or older process applies to your disputes or not? It is all about the request version. If you created a UPI dispute with a request version lower than 637, the old timelines apply and the various platform notifications for messaging are still supported. But if the request version is 637 or greater, the new timelines apply.
Further, since AddDisputeResponse can no longer be used (for 637 or greater) for buyer or seller communication, these notifications are no longer triggered: BuyerResponseDispute, SellerRespondedToDispute.
See Newer versus Older Unpaid Item Disputes Process - a before/after table of facts.
December 15, 2009: The descriptions of the RelistItem and RelistFixedPriceItem calls have been updated. Formerly, the descriptions incorrectly stated that an item used for a relist had to have ended without bidders or buyers.
We are in the process of consolidating the reference material for the API calls into the Call Reference. This entails moving material from the "API Call Reference Guide" section of the eBay Trading API Guide to the Call Reference. As the material for each of the calls is moved, a forwarding page is placed in the "API Call Reference Guide" indicating that the information for the associated call can now be found in the appropriate section of the Call Reference.
Previously, the documentation mentioned country codes with a link to the page for the ISO 3166 standard.Instead of refering to the ISO 3166 page, use the GeteBayDetails call to see the list of currently supported codes,and the English names associated with each code (e.g., KY="Cayman Islands").
We recommend that you use GeteBayDetails because while most of the country codes that eBay uses conform to the ISO 3166 standard, some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list.
No 641 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 639
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.ShipmentTrackingNumber |
Element | Removed |
ProductType.ProductReferenceID |
Element | New |
ShippingDetailsType.ShipmentTrackingDetails |
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 - 639.
ShippingCarrierUsed and ShipmentTrackingNumber provide details associated with the shipment of a package. These two elements have been placed together in the new ShipmentTrackingDetails container, which is returned as a node within the ShippingDetails container of GetItemTransactions and GetSellerTransactions.
ShipmentTrackingDetails is a repeatable container, allowing sellers to list shipping details for multiple packages shipped for a single item transaction. For example, if the transaction is for a desktop computer, the single item is likely to be shipped in several packages. This feature allows sellers to enter tracking numbers for all packages associated with a single item transaction.
With this refinement, ShipmentTrackingNumber is no longer returned as individual child element of ShippingDetails.
By late October 2009, production use (in the Trading API) of the Selling Manager calls no longer requires that your application is integrated directly into the eBay.com interface. That is, you do not need a Selling Manager application to make Selling Manager calls in the Trading API.
Selling Manager and Selling Manager Pro are tools with advanced functionality for managing listings. The Trading API includes calls that expose these tools' functionality. In the Trading API, each Selling Manager call has "SellingManager" as part of the name of the call.
Times for opening and closing disputes have been shortened for unpaid item disputes where the buyer has not paid. To learn about the many ways in which the Unpaid Item Dispute process has been changed, see Unpaid Item Disputes, and, in particular, these topics:
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 start time for new, scheduled listings is now randomized within 15-minute intervals. With this change, it is possible that the scheduled start time of your listing will be delayed by up to 15 minutes. Listing end times are modified accordingly. This upgrade affects the AddItem family of calls on the following sites:
AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 639 and Changed Functionality - 639.
None for this release.
This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.
© 2005–2010 eBay Inc. All rights reserved.
eBay and the eBay logo are registered trademarks of eBay Inc.
All other brands are the property of their respective owners.