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:
| Q1 2010 | Q4 2009 | Q3 2009 | Q2 2009 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Version | Release Date | Version | Release Date | Version | Release Date | Version | Release Date | ||||
| 663 | 2010-3-31 | 649 | Not Released | 637 | 2009-10-02 | 623 | 2009-6-24 | ||||
| 661 | 2010-3-17 | 647 | 2010-1-6* | 635 | 2009-9-16 | 621 | 2009-6-10 | ||||
| 659 | 2010-3-3 | 645 | Not Released | 633 | Not Released | 619 | 2009-5-27 | ||||
| 657 | 2010-2-17 | 643 | 2009-11-11 | 631 | 2009-8-19 | 617 | 2009-5-13 | ||||
| 655 | 2010-2-3 | 641 | Not released | 629 | 2009-8-5 | 615 | 2009-4-29 | ||||
| 653 | 2010-1-20 | 639 | 2009-10-21 | 627 | 2009-7-22 | 613 | 2009-4-15 | ||||
| 651 | Not Released | 625 | 2009-7-8 | 611 | 2009-4-1 | ||||||
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 - 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.
Documentation Changes and Errata - 637
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 |
|---|---|---|
DisableUnpaidItemAssistanceRequestType |
Complex type | New |
DisableUnpaidItemAssistanceResponseType |
Complex type | New |
ItemBestOffersArrayType |
Complex type | New |
ItemBestOffersType |
Complex type | New |
UnpaidItemAssistancePreferencesType |
Complex type | New |
GetBestOffersRequestType.Pagination |
Element | New |
GetBestOffersResponseType.ItemBestOffersArray |
Element | New |
GetBestOffersResponseType.PageNumber |
Element | New |
GetBestOffersResponseType.PaginationResult |
Element | New |
GetUserPreferencesRequestType.ShowUnpaidItemAssistancePreference |
Element | New |
GetUserPreferencesResponseType.UnpaidItemAssistancePreferences |
Element | New |
OfferType.MyMaxBid |
Element | New |
SetStoreCategoriesResponseType.CustomCategory |
Element | New |
SetUserPreferencesRequestType.UnpaidItemAssistancePreferences |
Element | New |
DisputeExplanationCodeType.BuyerNotPaid |
Enum | New |
DisputeExplanationCodeType.BuyerPaymentNotReceivedOrCleared |
Enum | New |
DisputeExplanationCodeType.SellerDoesntShipToCountry |
Enum | New |
DisputeExplanationCodeType.UPIAssistance |
Enum | New |
DisputeExplanationCodeType.UPIAssistanceDisabled |
Enum | New |
DisputeStatusCodeType.UnpaidItemOpened |
Enum | New |
The 637 version of the Trading API is scheduled to finish rolling to all the API machines by October 9, 2009. This date is later than the date in the change histories for affected API calls, and later than the date in the schedule at the top of this Release Notes document.
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 - 637.
eBay has introduced the Unpaid Item Assistance mechanism. See these topics on the eBay web site: Unpaid Item Assistant, Understanding the New Unpaid Item Process. eBay has provided API support for this mechanism: a new call, DisableUnpaidItemAssistance, enables a seller to override the automated mechanism for a selected item; new enumerations related to Unpaid Item Assistance have been added to DisputeExplanationCodeType (affecting AddDispute); and UnpaidItemAssistancePreferences is a new element in SetUserPreferences and GetUserPreferences.
Though the API now includes these schema changes, the Unpaid Item Assistance mechanism is not functional until mid-October.
You now have the ability to edit multiple-item, fixed-price listings, even after one or more of the items in that listing have been sold (formerly sellers could not change their multiple-quantity fixed-price listings, after it has received at least one purchase).
Sellers or Buyers of a listing can get a snapshot of the listing as it was at the time of a given purchase by invoking GetItem with a Transaction ID as an input. When TransactionID is passed to GetItem, the listing content returned will match the listing as it was at time of purchase (even if the seller has made significant revisions to the listing, following the purchase). Sellers of an item are allowed to view all transactional snapshots of the listing, but buyers can only view the transactional snapshots for which they are the successful buyer. Past transactional views of an item are available for up to 90 days from the date the transaction took place.
Because revisions result in multiple 'versions' or 'states' of that same listing, you can reference data for a specific sale based on the Transaction ID. Therefore, the ability to retrieve this 'snapshot' of the listing (which includes the data for the listing on the date the transaction was created) will slightly change the behavior of the following calls.
As part of the ability to edit fixed-price, multiple-quantity listings after some of the items within that listing have been sold, a new Transaction ID field was added to GetItem on release 627.
For Notifications, you can set the transaction event to trigger your notifications or use an event related to the entire listing. Be aware that if you're using item transaction snapshot data, fields like Listing Status may report an Active status (because the listing was Active on the transaction date), but the listing may actually have ended.
Changes to the GetItemTransactions call may result in the ability to use the transaction data to trigger the following Platform Notifications: EndOfAction, AuctionCheckoutComplete, FixedPriceEndOfTransaction, CheckoutBuyerRequestTotal, FixedPriceTransaction, Checkout, FixedPriceTransactionForSeller, FixedPriceTransactionForBuyer, ItemMarkedAsShipped, and ItemMarkedAsPaid. Each notification will now be based on the state of the item (a 'snapshot' of the item) at the time the transaction was created.
The following Client Alerts may also have the ability to use the transaction data to trigger alerts as a result of this project: EndOfAuction, FixedPriceEndOfTransaction, FixedPriceTransaction, ItemSold, and ItemWon.
You will still have the restriction of not being able to edit the listing within 12 hours of the end of the listing.
Changes to the following calls have been requested by customers and implemented in this release:
| Call Name | Feature | Notes |
|---|---|---|
| GetBestOffers | Can now return all Active Offers associated with a user. | Includes changes to ItemIDType, PaginationType, GetBestOffersResponseType, and addition of ItemBestOffersType. |
| SetStoreCategories | Now returns newly created CategoryID and CategoryNames. | Eliminates the need for a GetStoreCategories call immediately after the SetStoreCategories call. |
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.
Prior to this version, Immediate Payment was not supported on Third party checkout. AutoPay and ThirdPartyCheckout flags could not both be set to true.
With this version, to create a listing with Immediate Payment as well as third party checkout requirement, ThirdPartyCheckout must be true, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and PaymentMethods must be PayPal. For non- Immediate Payment listings, the original behavior remains.
As announced in the 629 Release Notes, SellerInfo.SellerLevel will no longer be returned in the GetUser, GetBidderList, GetSellerList, GetItem, and GetItemTransactions responses for the US, DE/AT/CH, and UK/IE sites, for version 629 and later. If you are using a version older than 629, SellerInfo.SellerLevel will still be returned. Developers should note that SellerInfo.SellerLevel could potentially be removed from other sites as well.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 637 and Changed Functionality - 637.
In the GetCategoryFeatures request, the FeatureID value AttributeConversionEnabled has no effect. Instead, use the ItemSpecificsEnabled value if you want to only retrieve information about which categories support custom Item Specifics, and which categories have also been converted from ID-based attributes to custom Item Specifics.
If your application supports eBay's Item Specifics recommendations as well as ID-based attributes, we recommend that when AttributeConversionEnabled is Enabled or Disabled for a category, you avoid rendering ID-based attributes in that category. This will help you avoid displaying the same Item Specifics twice to end users.
Information about considering Best Match when you revise and relist items has been updated. See Considering Best Match When Revising and Relisting Items. Also see Considering Best Match When Listing Items. For information about the new BestMatchItemDetails API, see the product page for the API.
Documentation Changes and Errata - 635
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 |
|---|---|---|
ShipmentType.ShipmentTrackingNumber |
Element | Removed |
ShipmentType.ShippingCarrierUsed |
Element | Removed |
ExcludeShippingLocationDetailsType |
Complex type | New |
PerformanceDashboardType |
Complex type | New |
SellerExcludeShipToLocationPreferencesType |
Complex type | New |
ShipmentTrackingDetailsType |
Complex type | New |
PerformanceStatusCodeType |
Enumerated type | New |
GetItemTransactionsRequestType.IncludeVariations |
Element | New |
GetSellerDashboardResponseType.Performance |
Element | New |
GetUserPreferencesRequestType.ShowSellerExcludeShipToLocationPreference |
Element | New |
GetUserPreferencesResponseType.SellerExcludeShipToLocationPreferences |
Element | New |
GeteBayDetailsResponseType.ExcludeShippingLocationDetails |
Element | New |
ShipmentType.ShipmentTrackingDetails |
Element | New |
ShippingDetailsType.ExcludeShipToLocation |
Element | New |
ShippingDetailsType.SellerExcludeShipToLocationsPreference |
Element | New |
DetailNameCodeType.ExcludeShippingLocationDetails |
Enum | New |
DisputeResolutionRecordTypeCodeType.RestrictBuyer |
Enum | New |
DisputeResolutionRecordTypeCodeType.UnrestrictBuyer |
Enum | New |
MessageTypeCodeType.ContacteBayMemberViaAnonymousEmail |
Enum | New |
As announced in April, eBay is now consolidating changes that impact your business into two or three major releases a year, with two months advance notice. Changes have begun for the second and final major release of 2009 (also sometimes called SR-2). A few of these changes were added in release 627, some are rolling out with this release, but most of the updates will launch between September 22 and October 1, 2009.
Since feature sets may be slightly different for each site, it is important for you to call GetCategories, GetCategoryFeatures, and GeteBayDetails, to determine which new options are available for your site, and to test your application code (after upgrading to a new schema, but before using it in production) to make sure it is still working as you expect.
See the Developer Impact: Summer 2009 Updates blog entry. Note that you will probably have to make some changes in your application code to accommodate these enhancements for sellers.
One of the upcoming changes includes the ability to edit fixed-price, multiple-quantity listings after some of the items within that listing have been sold.
Another important change is an update to the listing enhancement packages that are available for each site. The Listing Enhancements Table shows the current, available packages.
Other than what has been already discussed in this release note (including and after release 627), upcoming changes for sellers include:
Watch the eBay Developer Program Blog for additional news on new features.
As part of the ability to edit fixed-price, multiple-quantity listings after some of the items within that listing have been sold, a new Transaction ID field was added to GetItem on release 627. Because of this functionality, you will have the option of retrieving a specific snapshot of the listing, that reflects the state of each item field on the date the transaction was created.
Changes to the GetItemTransaction API call may cause a change to the behavior of the following Platform Notifications: EndOfAction, AuctionCheckoutComplete, FixedPriceEndOfTransaction, CheckoutBuyerRequestTotal, FixedPriceTransaction, Checkout, FixedPriceTransactionForSeller, FixedPriceTransactionForBuyer, ItemMarkedAsShipped, and ItemMarkedAsPaid. The following Client Alerts may have a behavior change as a result of this project: EndOfAuction, FixedPriceEndOfTransaction, FixedPriceTransaction, ItemSold, and ItemWon. Each notification will now be based on the state of the item (a 'snapshot' of the item) at the time the transaction was created.
The Listing Enhancement changes are part of the larger ListingFeatureDetails project. Please review the Listing Enhancements Table and call GeteBayDetails for your site before upgrading, to determine whether these options have changed for your site.
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 - 635.
Using My eBay, you can create an Exclude Ship-To List of the locations to where you will not ship items. Once set up, all items that you list on eBay will, by default, use the Exclude Ship-To List. If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on your item. Use GetUserPreferences to review the default set of excluded locations that you have set up in My eBay.
You can override the settings in your Exclude Ship-To List using ExcludeShipToLocation fields in your item-listing calls. Use ExcludeShipToLocation to specify individual locations to where you will not ship and override the default Exclude Ship-To List you might have set up in My eBay--only the sites specifically specified with ExcludeShipToLocation will be excluded. Specify NONE in ExcludeShipToLocation to override the default Exclude Ship-To List and indicate that you do not want to exclude any shipping locations from the respective item listing.
The ExcludeShippingLocationDetails node in the GeteBayDetails response lists the regions and country values that you can exclude for a given eBay site.
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 Shipment container in SetShipmentTrackingInfo, CompleteSale, and GetSellingManagerSaleRecord.
ShipmentTrackingDetails is a repeatable container, allowing you to list shipping details for multiple packages shipped for a single item transaction. For example, if you purchase a desktop computer, the single item is likely to be shipped in several packages. This feature allows sellers to enter the tracking numbers for all packages associated with a single item transaction.
With this refinement, ShippingCarrierUsed and ShipmentTrackingNumber are no longer returned as individual child elements of Shipment.
Your seller performance status is now returned for the following eBay regions: US, UK/Ireland, and Germany/Switzerland/Austria. Your seller status can be either Top-Rated, Above Standard, Standard, or Below Standard. The seller status is returned in a Performance container along with any alerts that might have been issued to the authenticated seller. Alerts can be either a warning or informational in nature.
As announced in July 2009, changes have occurred in the sorting of listings by Best Match. For more information, see the following locations:
GetItemTransactions now supports IncludeVariations, to give you the option to retrieve multi-variation listing details in the Item node. (The call still also returns information about sold variations in the Transaction nodes). You can use the item-level details to help sellers reconcile their local inventory against their eBay listing data (instead of calling GetItem after each sale).
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The GetMyMessages call returns multi-threaded messages in the Messages.Message.Text field. If you have code that parses the messages for data, it is recommended that you retest this code.
The GetMyMessages call returns emails that were sent by an eBay member's email client (to another eBay member).
Under existing functionality, a transactional relationship is required for access to email addresses. By mid-October 2009, some related changes that originally were rolled to some international sites will take effect all eBay sites, including the US, Canada, India, and New Zealand sites. For recent enhancements to communication features on the eBay site, see Managing buyer emails made easy and FAQs about buyer emails.
eBay has found that buyer-paid shipping insurance causes negative experiences for both buyers and sellers alike. Buyers are confused as to why they need to purchase shipping insurance, especially in light of PayPal's Buyer Protection service (which applies whether or not a seller uses shipping insurance). Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands. Offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace.
Beginning with version 635, sellers will no longer be able to list shipping insurance as an optional service for domestic or international items. This restriction affects the following eBay sites:
BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US
If you attempt to add buyer-paid shipping insurance to an item listing on one of the above-mentioned sites, the item listing will succeed. However, the shipping insurance will be removed from the item listing and a warning will be generated. While you do not have to update existing listings, you will be unable to add shipping insurance as a separate cost to new, revised, and renewed listings. In addition, you are required to remove from your item descriptions any references to buyer-paid shipping insurance.
eBay understands that it is in the seller's best interest to insure certain shipments (for example, antiques, fragile items, and so on). If appropriate for the items they sell, and for the business they run, sellers can choose to purchase insurance for the items they ship. While completely optional, sellers can fold any insurance costs into the price of their items, either by adding the cost to the item price or by adding it as a handling charge. In these cases, sellers can include a statement in their item descriptions that clarify the shipping details (for example, "shipping insurance provided").
Sellers may wish to work with bulk shipping insurance providers to achieve low-cost shipping insurance. In addition, 3rd-party listing-tool developers might find additional revenue streams by providing bulk shipping insurance to their customers.
This affects the AddItem family of calls along with GetBidderList, GetItem, GetItemRecommendations, GetItemShipping, GetItemTransactions, GetOrders, GetOrderTransactions, GetSellerList, GetSellerTransactions, GetSellingManagerSaleRecord, GetSellingManagerTemplates, GetShippingDiscountProfiles, GetUserPreferences, SendInvoice, SetShippingDiscountProfiles, and SetUserPreferences.
Actual start times for listings may not precisely match the value of Item.ScheduleTime. To schedule relists or other activities related to precise start and end times of a listing, you should use the StartTime or EndTime in the listing call's response.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 635 and Changed Functionality - 635.
Improvements: the righthand column for codelists now identifies the calls which use its enumerations (instead of erroneously saying "not used by any calls"), and the definition of each type is now included below the type's name.
No 633 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 631
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 |
|---|---|---|
SiteHostedPictureDetailsType.ExternalPictureURL |
Element | New |
SiteHostedPictureDetailsType.UseByDate |
Element | New |
ShippingServiceCodeType.DE_eBayDHLPaket24x7 |
Enum | New |
As of August 2009, the lowest supported Trading API version is 551. (Version 551 was released in February 2008.)
For information about how versioning works and what is (and is not) supported, see:
Starting in mid-September 2009, when Good Til Canceled (GTC) listings are renewed, they will be checked for Return Policy and Handling Time. If these details are not included, the GTC listing renewal will fail.
(As of June 2009, new and relisted items were required to specify Return Policy and Handling Time.)
See the eBay Developers Program Blog for the latest updates on these and other policy changes.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 631.
DE_eBayDHLPaket24x7 has been added to
ShippingServiceCodeType.
Two fields have been added to the UploadSiteHostedPictures response. The UseByDate is the last date that the picture can be associated with an item. The ExternalPictureURL (which was added to the UploadedSiteHostedPictures request on release 605) is now echoed back in the response.
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 - 631 and Changed Functionality - 631.
Did you know... The implementation of Detail Controls is different in the Trading API versus non-Trading APIs and services. The descriptions of the "none" column have been updated in all API Call References in the Detail Controls sections to clarify the differences. And the "none" column has been moved to be the first column.
Documentation Changes and Errata - 629
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 |
|---|---|---|
TopRatedSellerDetailsType |
Complex type | New |
VariationDetailsType |
Complex type | New |
RelistUseCaseCodeType |
Enumerated type | New |
TopRatedProgramCodeType |
Enumerated type | New |
FeatureEligibilityType.QualifiesForVariations |
Element | New |
GetSellerEventsRequestType.IncludeVariationSpecifics |
Element | New |
GeteBayDetailsResponseType.VariationDetails |
Element | New |
RelistFixedPriceItemRequestType.RelistUseCase |
Element | New |
RelistItemRequestType.RelistUseCase |
Element | New |
SellerType.TopRatedSeller |
Element | New |
SellerType.TopRatedSellerDetails |
Element | New |
SetUserNotesRequestType.SKU |
Element | New |
SetUserNotesRequestType.VariationSpecifics |
Element | New |
VariationType.PrivateNotes |
Element | New |
DetailNameCodeType.VariationDetails |
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 - 629.
GetSellerEvents now returns variation details in Item.Variations, including StartPrice, Quantity, and QuantitySold, plus SKU and/or VariationSpecifics. Multiple variations are returned together in the same Variations node (similar to GetItem).
To keep the GetSellerEvents response smaller, the variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then VariationSpecifics are returned. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. (If you set it to false, the behavior is the same as not passing it in at all—the variation specifics are returned if there is no SKU.)
With RelistFixedPriceItem and ReviseFixedPriceItem, you can now use SKU to uniquely identify an existing variation, regardless of whether the listing has inventory tracking set to SKU. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. All other existing rules still apply. For example, to add a new variation, you must still provide variation specifics. To modify an existing SKU value, you must still specify the variation specifics as a unique identifier.
ReviseInventoryStatus now supports modifying variations when InventoryTrackingMethod is set to ItemID.
For the site specified in the request, GeteBayDetails now returns the following information in VariationDetails:
As the limits for different sites may change over time, it is a good idea to use GeteBayDetails to periodically check each site's settings. Note that you still also need to use GetCategoryFeatures to determine which categories support listing with variations.
GetUser now returns QualifiesForVariations (a boolean) to indicate whether the user is eligible to list with variations on the site specified in the request.
In SetUserNotes, you can now set private notes for variations. These notes will be visible to the user for variations that are displayed in My eBay. For sellers, you can pass in SKU or VariationSpecifics as a unique identifier. For buyers, you can pass in VariationSpecifics (as buyers should not know or care about a seller's SKU). (Please note that you cannot currently use SKU to add notes at the item level. It only works for variations.)
For backward compatibility, if you use SetUserNotes to add a note to a listing with variations, but you do not pass a variation identifer (SKU or variation specifics) in the request, the note will be added to the first variation with a non-zero quantity or it will not be added (depending on what else was passed in the request). (The "first" variation is determined based on the order in which variations were added when the item was listed.).
GetMyeBayBuying and GetMyeBaySelling now return PrivateNotes for applicable variations. Depending on how the notes were set (what was specified in the SetUserNotes request), the variations may be returned within Variations or within Item
When Top-Rated Seller details become available in October (see Announcement), GetUser will begin returning fields that identify the seller as a Top-Rated Seller and give details about the Top-Rated Seller program. These fields are already present and documented for GetUser and other calls. They include TopRatedSeller and TopRatedSellerDetails.TopRatedProgram, which identifies the Top-Rated-Seller programs for which the seller is qualified. When the Top-Rated Seller feature becomes active on the US, DE, and UK sites, SellerInfo.SellerLevel will no longer be returned for those sites. Affected calls besides GetUser include GetBidderList, GetSellerList, GetItem, and GetItemTransactions.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
In the LeaveFeedback API call, DSRs left for Shipping Time will be ignored for all Local Pickup transactions. DSRs left for Shipping and Handling Charges will be ignored for Local Pickup transactions where the seller did not add any special handling fees.
This change affects the following eBay sites: AU, Mn-AT, BE-FR, BE-NL, CA, CA-FR, FR, DE, HK, IN, Mn-IE, IT, MY, Motors, NL, PH, PL, SG, ES, Mn-CH, UK, US
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 629 and Changed Functionality - 629.
The Call Reference did not list Pagination.PageNumber as a valid input element due to a typographic error in the WSDL; this has been fixed. In addition, an issue was resolved that prohibited the specification of PageNumber without also specifying EntriesPerPage. You can now specify PageNumber, EntriesPerPage, or both.
Documentation Changes and Errata - 627
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 |
|---|---|---|
IntegratedMerchantCreditCardInfoType.AvailableSite |
Element | Removed |
ListingFeatureDetailsType |
Complex type | New |
BoldTitleCodeType |
Enumerated type | New |
BorderCodeType |
Enumerated type | New |
DiscountReasonCodeType |
Enumerated type | New |
FeaturedFirstCodeType |
Enumerated type | New |
FeaturedPlusCodeType |
Enumerated type | New |
GiftIconCodeType |
Enumerated type | New |
HighlightCodeType |
Enumerated type | New |
HomePageFeaturedCodeType |
Enumerated type | New |
ProPackCodeType |
Enumerated type | New |
AddFixedPriceItemResponseType.DiscountReason |
Element | New |
AddItemResponseContainerType.DiscountReason |
Element | New |
AddItemResponseType.DiscountReason |
Element | New |
GetItemRequestType.TransactionID |
Element | New |
GeteBayDetailsResponseType.ListingFeatureDetails |
Element | New |
GeteBayDetailsResponseType.UpdateTime |
Element | New |
ListingStartPriceDetailsType.MinBuyItNowPricePercent |
Element | New |
RelistFixedPriceItemResponseType.DiscountReason |
Element | New |
RelistItemResponseType.DiscountReason |
Element | New |
ReviseFixedPriceItemResponseType.DiscountReason |
Element | New |
ReviseItemResponseType.DiscountReason |
Element | New |
VerifyAddFixedPriceItemResponseType.DiscountReason |
Element | New |
VerifyAddItemResponseType.DiscountReason |
Element | New |
DetailNameCodeType.ListingFeatureDetails |
Enum | New |
Please see the recent announcements for sellers on the eBay Developers Program blog.
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 - 627.
The AddItem family of calls now returns the nature of the discount, if a discount applied, in DiscountReason. (The Verify* calls can also return DiscountReason as an indication of whether a discount could have applied, had the item actually been listed at that time.)
Current discounts are of the type Promotion. In the future, there will also be discounts of the type SpecialOffer.
Promotion: An offer that applies to an unlimited number of listings during the offering period. Example: "Get subtitle for $0.10 in Tech category when listing between 12/25 and 12/28. No limit to the number of items listed during this period."
SpecialOffer: An offer that applies to a limited number of listings during the offering period. Example: "There is no insertion fee for up to 5 auctions when listing between 12/1 and 12/10."
As part of the Edit Live Items feature that is scheduled for release in September, a new TransactionID field has been added to the GetItemRequest call. This new field will allow both Sellers and Buyers to retrieve a listing as it was at the time of a given purchase by invoking GetItem with a TransactionID in the request (even if the seller has made significant revisions to the listing, following the purchase).
Sellers will also be able to make revisions to their multi-quantity fixed price listings after a purchase has been made (currently, sellers can not change their multi-quantity fixed price listings, after at least one item in the listing has been purchased).
Sellers will be able to view the updated listing for each transaction, but Buyers will only be able to view the transactional version of a listing where they are the successful buyer. Past transactional views of an item will be available for up to 90 days from the date the transaction took place.
As part of the seller release, some listing upgrades will be removed for some sites, and some will be restricted to eBay Top-Rated Sellers or PowerSellers. The listing features include bold title, border, Featured First, Featured Plus!, gift icon, highlight, Homepage Featured, and ProPack. A new type, ListingFeatureDetails, has been added to the GeteBayDetails response that reports which listing features are available to the seller for the site. This type will be visible in the Trading WSDL from the 627 release on, but not usable until the seller release. Another addition to the GeteBayDetails response, UpdateTime, reports the time of the most recent modification to any Detail.
A type is added to ListingStartPriceDetailsType, MinBuyItNowPricePercent, which returns the minimum percentage difference between the start price and the Buy It Now price for a listing on the specified site. One exception: for the Motors site, use category details to find the percentage requirements for Motor Vehicles. MinBuyItNowPricePercent will not be usable until the seller 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 type for ShipmentType.ShippingCarrierUsed has been changed from ShippingCarrierCodeType to string. This enables sellers to specify a shipping carrier (via CompleteSale) other than the ones noted in ShippingCarrierCodeType.
With a request version lower than 627, the value you specify for CompleteSale's ShippingCarrierUsed must be a value found in ShippingCarrierCodeType. If the request version is 627 or higher, you can specify the shipping carrier of your choice, even if it is not in the ShippingCarrierCodeType list, and GetSellingManagerSaleRecord will return that value.
The shipping insurance option for both domestic and international items is being removed from the site later this year (the implementation is currently scheduled for mid-September). While you do not have to update existing listings, you will, in the future, be unable to add shipping insurance as a separate cost to new, revised, and renewed listings.
If needed, you can add shipping insurance to your item listings by purchasing insurance from the shipping carrier and adding the cost to a flat shipping cost, or (if you use calculated shipping), you can add the cost as a handling charge.
GetMyeBayBuying and GetMyeBaySelling have been modified so they return the proper set of pagination results for World of Good Items.
As announced, GetUser formerly returned the following to indicate a site on which a seller has a payment gateway account (and thus a site on which the seller can use the IntegratedMerchantCreditCard payment method): User.SellerInfo.IntegratedMerchantCreditCardInfo.AvailableSite. That field has been removed from the WSDL. Now, instead of that deprecated field, please use the following new field: User.SellerInfo.IntegratedMerchantCreditCardInfo.SupportedSite.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 627 and Changed Functionality - 627.
The Call Reference for GetCategories and GetCategoryFeatures has been updated with new introductory material and new samples.
Documentation Changes and Errata - 625
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 |
|---|---|---|
VariationSpecificPicturesCodeType |
Enumerated type | Removed |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 625.
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 - 625 and Changed Functionality - 625.
The documentation has been updated to clarify that if you revise 4 variations from the same multi-variation listing, the response includes 4 InventoryStatus nodes (1 for each varation), and only 1 Fees node for that listing.
Documentation Changes and Errata - 623
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 |
|---|---|---|
ExpressDetailsType |
Complex type | Removed |
ExpressHistogramAisleType |
Complex type | Removed |
ExpressHistogramDepartmentType |
Complex type | Removed |
ExpressHistogramDomainDetailsType |
Complex type | Removed |
ExpressHistogramProductType |
Complex type | Removed |
ExpressPreferencesType |
Complex type | Removed |
ExpressProductType |
Complex type | Removed |
ExpressSellerRequirementsType |
Complex type | Removed |
WishListEntryType |
Complex type | Removed |
ExpressSellingPreferenceCodeType |
Enumerated type | Removed |
FetchTokenRequestType.IncludeRESTToken |
Element | Removed |
UserType.RESTToken |
Element | Removed |
AuthTokenTypeCodeType.RESTToken |
Enumeration | Removed |
FeatureEligibilityType |
Complex type | New |
InventoryFeesType |
Complex type | New |
CountryDetailsType.DetailVersion |
Element | New |
CountryDetailsType.UpdateTime |
Element | New |
CurrencyDetailsType.DetailVersion |
Element | New |
CurrencyDetailsType.UpdateTime |
Element | New |
DispatchTimeMaxDetailsType.DetailVersion |
Element | New |
DispatchTimeMaxDetailsType.UpdateTime |
Element | New |
GetCategoryFeaturesRequestType.AllFeaturesForCategory |
Element | New |
GetUserRequestType.IncludeFeatureEligibility |
Element | New |
IntegratedMerchantCreditCardInfoType.SupportedSite |
Element | New |
ItemSpecificDetailsType.DetailVersion |
Element | New |
ItemSpecificDetailsType.UpdateTime |
Element | New |
ListingStartPriceDetailsType.DetailVersion |
Element | New |
ListingStartPriceDetailsType.UpdateTime |
Element | New |
PaymentOptionDetailsType.DetailVersion |
Element | New |
PaymentOptionDetailsType.UpdateTime |
Element | New |
RegionDetailsType.DetailVersion |
Element | New |
RegionDetailsType.UpdateTime |
Element | New |
RegionOfOriginDetailsType.DetailVersion |
Element | New |
RegionOfOriginDetailsType.UpdateTime |
Element | New |
ReturnPolicyDetailsType.DetailVersion |
Element | New |
ReturnPolicyDetailsType.UpdateTime |
Element | New |
ReviseInventoryStatusResponseType.Fees |
Element | New |
SellerType.FeatureEligibility |
Element | New |
ShippingCarrierDetailsType.DetailVersion |
Element | New |
ShippingCarrierDetailsType.UpdateTime |
Element | New |
ShippingLocationDetailsType.DetailVersion |
Element | New |
ShippingLocationDetailsType.UpdateTime |
Element | New |
ShippingPackageDetailsType.DetailVersion |
Element | New |
ShippingPackageDetailsType.UpdateTime |
Element | New |
ShippingServiceDetailsType.DetailVersion |
Element | New |
ShippingServiceDetailsType.UpdateTime |
Element | New |
SiteBuyerRequirementDetailsType.DetailVersion |
Element | New |
SiteBuyerRequirementDetailsType.UpdateTime |
Element | New |
SiteDetailsType.DetailVersion |
Element | New |
SiteDetailsType.UpdateTime |
Element | New |
TaxJurisdictionType.DetailVersion |
Element | New |
TaxJurisdictionType.UpdateTime |
Element | New |
TimeZoneDetailsType.DetailVersion |
Element | New |
TimeZoneDetailsType.UpdateTime |
Element | New |
URLDetailsType.DetailVersion |
Element | New |
URLDetailsType.UpdateTime |
Element | New |
UnitOfMeasurementDetailsType.DetailVersion |
Element | New |
UnitOfMeasurementDetailsType.UpdateTime |
Element | New |
UserType.QualifiesForSelling |
Element | New |
FeedbackRatingStarCodeType.GreenShooting |
Enum | New |
FeedbackRatingStarCodeType.SilverShooting |
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 - 623.
ReviseInventoryStatus now returns fees for each item that was modified in the call. Please note that increasing a listing's price can result in changes to the insertion fee. ReviseInventoryStatus also now allows you to change the quantity or start price of a variation in a multi-variation listing.
The RedShooting Star used to appear when feedback scores were 100,000 and above. However, since eBay has so many sellers with very high feedback, two new ratings have been added. Now the RedShooting Star appears for feedback scores from 100,000 to 499,999; a new GreenShooting Star appears for feedback scores from 500,000 to 999,999; and a new SilverShooting Star appears for feedback scores that are 1,000,000 and above.
This release includes new DetailVersion and UpdateTime fields as part of the GeteBayDetails response, so that you can download the data plus the version and time and cache them locally.
Then, you can make the GeteBayDetails call again to see whether the version or time has changed in the latest response. If these values have changed for any of the details, you can update your cache with those details and the new version/time. If the version and time have not changed for some details, you can skip updating those fields.
The ListingDuration field has been added as a item list option for ActiveList. Therefore, you will now see the ListingDuration field in the ActiveList container of the GetMyeBaySelling response.
The GetUser call contains a new IncludeFeatureEligibility container in the request, so you can choose whether to return data about which features you (as a seller) can use when listing items (such as BuyItNow or one-day listing duration). If the value in GetUser.IncludeFeatureEligibility is true, the response will include the FeatureEligibility node. The new FeatureEligibility fields include: QualifiesForSelling, QualifiesForBuyItNow, QualifiesForBuyItNowMultiple, and QualifiedForFixedPriceOneDayDuration.
You can now use the AllFeaturesForCategory field in the GetCategoryFeatures call to retrieve all features for a given category. Information for child categories is not included.
In other words:
All platform notifications will now include the user's EIASToken to identify the subscriber. This token will be returned only to the subscriber. (The EIAS value for a given user does not change, even if the user's eBay user name changes.)
This doesn't change the basic nature of the individual notifications. Note that the unique user identifier returned in the EIASToken property has nothing to do the authentication token that you pass in API 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.
Formerly, GetUser returned the following to indicate a site on which a seller has a payment gateway account (and thus a site on which the seller can use the IntegratedMerchantCreditCard payment method): User.SellerInfo.IntegratedMerchantCreditCardInfo.AvailableSite. Now, instead of that deprecated field, the following new field should be used: User.SellerInfo.IntegratedMerchantCreditCardInfo.SupportedSite.
The FetchToken and GetUser calls still returned the RESTToken field. Since REST calls have been deprecated for over a year now, these fields are being removed to close a bug.
The MemberMessage.Body field in the AddMemberMessageRTQ call can now accept up to 2000 characters. The previous limit was 1000 characters, but now you can enter and retrieve 2000-character messages.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 623 and Changed Functionality - 623.
None for this release.
Documentation Changes and Errata - 621
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.
No schema changes in this release.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
Until late June, 2009, the current API version will remain at version 621.
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 - 621.
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 - 621 and Changed Functionality - 621.
The schema input section of the AddItemFromSellingManagerTemplate topic was updated to indicate that only the following can be specified as children of the Item container: payment methods and the PayPal email address.
The documentation of the PlaceOffer topic was updated to indicate that in the case of multi-quantity, fixed price listings, SellingStatus.HighBidder is returned only if there is just one transaction.
In GetSellerTransactions, Item.Quantity and Item.SellingStatus.QuantitySold are returned in the context of Transaction, so if the transaction was for a listing with variations, then Quantity is the total quantity for the specified variation, and QuantitySold is the quantity sold in that transaction.
In ReviseFixedPriceItem, when you revise multiple variations in the same listing at the same time (i.e, within a very short period), the best practice is to use a single ReviseFixedPriceItem request that includes all the variation revisions in the same request.
Please note that if your application design requires you to revise each variation individually, you should avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing.
Documentation Changes and Errata - 619
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 |
|---|---|---|
NameValueListType.VariationSpecificPictures |
Element | Removed |
NameValueListType.VariationsEnabled |
Element | Removed |
BrandMPNType |
Complex type | New |
TicketListingDetailsType |
Complex type | New |
GetSellerListRequestType.IncludeVariations |
Element | New |
ProductListingDetailsType.BrandMPN |
Element | New |
ProductListingDetailsType.EAN |
Element | New |
ProductListingDetailsType.ISBN |
Element | New |
ProductListingDetailsType.ListIfNoProduct |
Element | New |
ProductListingDetailsType.ReturnSearchResultOnDuplicates |
Element | New |
ProductListingDetailsType.TicketListingDetails |
Element | New |
ProductListingDetailsType.UPC |
Element | New |
ProductListingDetailsType.UseFirstProduct |
Element | New |
DisputeResolutionRecordTypeCodeType.FeatureFeeCredit |
Enum | New |
DisputeResolutionRecordTypeCodeType.FeatureFeeNotCredit |
Enum | New |
DisputeResolutionRecordTypeCodeType.ReverseFeatureFeeCredit |
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 - 619.
With a request version of 619 or higher, PromotionalDiscount can be returned in Fees.Fee for the AddItem family of calls. (eBay will not actually start returning this element until mid-June, but you can begin coding to account for this element with version 619.) PromotionalDiscount is returned whenever a discount has been applied to the respective listing fee and is the amount of money the seller saved due to the promotion that was in effect at the time they submitted their listing.
Starting with request version 619, the meaning of Fee for VerifyAddItem matches that of Fee in AddItem: it is the actual cost of the particular listing feature (e.g. bold title, highlight), thus reflecting any discounts that applied. Note that with a request version lower than 619, Fee in VerifyAddItem reflects the pre-discount cost of the listing feature and does not match the meaning of Fee in AddItem.
For more information, see the topic "Promotional Discounts" in "Fees Resulting from Listing an Item".
Now Power Sellers can receive a refund or credit of their Final Value Fee as part of the resolution of a dispute. The FVF is known as the Feature Fee when it is refunded. Developers can use the GetDisputes or GetUserDisputes calls to determine if a refund or credit has been granted. The new enumeration values that were added for this feature are part of the DisputeResolutionRecordTypeCodeType and are: FeatureFeeCredit, FeatureFeeNotCredit, and ReverseFeatureFeeCredit.
AddItem and related calls now support external product IDs in ProductListingDetails for listing with ISBN, UPC, EAN, Brand+MPN, and ticket keywords. ProductListingDetails also now supports the ePID value that is displayed on the eBay Web site (using the ProductReferenceID field).
ProductListingDetails also supports new fields that let you control how eBay handles your listing request when no product matches are found or when multiple product matches are found.
The new fields in ProductListingDetails are enabled for all catalog-enabled categories (not just Media categories).
ExternalProductID will be deprecated in a future release.
In AddItem and related calls, LookupAttributeArray is now enabled for all catalog-enabled categories that support the notion of a condition (e.g., not Tickets). The condition values (e.g., "New" and "Used") are not normalized across categories. The name and value must match the attribute name and value defined in GetAttributesCS or GetProductSellingPages. (For example, on the US site, you would use "Brand New" for books, or "New, Never Opened" for cameras.)
GetSellerList now returns details for mult-variation listings. Pass IncludeVariations in the request to retrieve the Variations node. Only the variation specifics, price, quantity, quantity sold, and SKU are returned (not the pictures, etc.).
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 API has been updated to allow you to omit DispatchTimeMax (or set it to 0) in AddItem and related calls when ShippingService=Pickup or ShipToLocations=None.
Reminder: When GetCategoryFeatures returns HandlingTimeEnabled=false, it means that a handling time is required when flat or calculated shipping services are specified. (This rule does not apply when the listing only offers local pickup or freight.)
eBay is deprecating Dutch (multi-listing) competitive-bid item listings. Version 619 represents the Third Phase in the deprecation process. This is the final deprecation phase.
Phase III, version 619: On all sites globally, eBay throws an error
if you attempt to create a Dutch auction with AddItem or
VerifyAddItem. If you attempt to create a Dutch auction with
RelistItem, eBay generates a warning and resets
Quantity to 1.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 619 and Changed Functionality - 619.
None for this release.
Documentation Changes and Errata - 617
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 |
|---|---|---|
FreeGalleryPlusEnabledDefinitionType |
Complex type | New |
FreePicturePackEnabledDefinitionType |
Complex type | New |
MaximumBuyerPolicyViolationsDetailsType |
Complex type | New |
MaximumItemRequirementsDetailsType |
Complex type | New |
MaximumUnpaidItemStrikesCountDetailsType |
Complex type | New |
MaximumUnpaidItemStrikesDurationDetailsType |
Complex type | New |
MaximumUnpaidItemStrikesInfoDetailsType |
Complex type | New |
MinimumFeedbackScoreDetailsType |
Complex type | New |
NumberOfPolicyViolationsDetailsType |
Complex type | New |
PolicyViolationDurationDetailsType |
Complex type | New |
SiteBuyerRequirementDetailsType |
Complex type | New |
VerifiedUserRequirementsDetailsType |
Complex type | New |
CategoryFeatureType.FreeGalleryPlusEnabled |
Element | New |
CategoryFeatureType.FreePicturePackEnabled |
Element | New |
FeatureDefinitionsType.FreeGalleryPlusEnabled |
Element | New |
FeatureDefinitionsType.FreePicturePackEnabled |
Element | New |
GeteBayDetailsResponseType.BuyerRequirementDetails |
Element | New |
SiteDefaultsType.FreeGalleryPlusEnabled |
Element | New |
SiteDefaultsType.FreePicturePackEnabled |
Element | New |
DetailNameCodeType.BuyerRequirementDetails |
Enum | New |
FeatureIDCodeType.FreeGalleryPlusEnabled |
Enum | New |
FeatureIDCodeType.FreePicturePackEnabled |
Enum | New |
SellingManagerSoldListingsPropertyTypeCodeType.ResponseRequiredForReturnCase |
Enum | New. Reserved for future use. |
Until late May, 2009, the current API version will remain at version 615. Therefore, most changes to calls in the 617 schema version will not be enabled until late May 2009, at the earliest.
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 - 617.
As of June 2009, in certain categories, if a seller adds a picture (or pictures) to a listing, the seller gets free, automatic upgrades. The free upgrades are Gallery Plus, which enhances pictures in search results, and Picture Pack, a discount package that includes super-sizing of pictures. To determine the categories that support the free upgrades, see recent changes to GetCategoryFeatures.
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.
Site-specific buyer requirements are now returned in the GeteBayDetails response. Sellers can now choose from site-specific buyer requirements that are returned in the response to limit the number of policy violations or non-payment strikes that a buyer can have if they want to bid on an item that the seller is listing.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 617 and Changed Functionality - 617.
In the AddItem documentation, the PictureURL section states, "On the main eBay site, a listing can have a maximum of 12 picture URLs hosted by eBay Picture Services or a maximum of 6 picture URLs hosted by a third-party vendor. If you specify multiple vendor-hosted pictures in listing calls, PhotoDisplay must be set to VendorHostedPictureShow."
However, the VendorHostedPictureShow option is no longer available. Now a listing can only have one vendor-hosted picture. The documentation will be updated to reflect this in the next release.
Documentation Changes and Errata - 615
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 |
|---|---|---|
ItemSpecificsRecommendationsType |
Complex type | Removed |
CategoryItemSpecificsType.Updated |
Element | Removed |
FeeType.DiscountedFee |
Element | Removed |
FeeType.RelatedDiscountedFeeName |
Element | Removed |
GetCategorySpecificsResponseType.CategoryItemSpecifics |
Element | Removed |
GetRecommendationsResponseContainerType.ItemSpecificsRecommendations |
Element | Removed |
AddFixedPriceItemRequestType |
Complex type | New |
AddFixedPriceItemResponseType |
Complex type | New |
AttributeConversionEnabledFeatureDefinitionType |
Complex type | New |
EndFixedPriceItemRequestType |
Complex type | New |
EndFixedPriceItemResponseType |
Complex type | New |
PicturesType |
Complex type | New |
RelistFixedPriceItemRequestType |
Complex type | New |
RelistFixedPriceItemResponseType |
Complex type | New |
ReviseFixedPriceItemRequestType |
Complex type | New |
ReviseFixedPriceItemResponseType |
Complex type | New |
SellingManagerProductSpecificsType |
Complex type | New |
VariationKeyType |
Complex type | New |
VariationSpecificPictureSetType |
Complex type | New |
VariationType |
Complex type | New |
VariationsEnabledDefinitionType |
Complex type | New |
VariationsType |
Complex type | New |
VerifyAddFixedPriceItemRequestType |
Complex type | New |
VerifyAddFixedPriceItemResponseType |
Complex type | New |
AttributeConversionEnabledCodeType |
Enumerated type | New |
VariationPictureRuleCodeType |
Enumerated type | New |
VariationSpecificPicturesCodeType |
Enumerated type | New |
VariationSpecificsRuleCodeType |
Enumerated type | New |
AddSellingManagerProductRequestType.SellingManagerProductSpecifics |
Element | New |
AddToWatchListRequestType.VariationKey |
Element | New |
CategoryFeatureType.AttributeConversionEnabled |
Element | New |
CategoryFeatureType.VariationsEnabled |
Element | New |
FeatureDefinitionsType.AttributeConversionEnabled |
Element | New |
FeatureDefinitionsType.VariationsEnabled |
Element | New |
FeeType.PromotionalDiscount |
Element | New |
GetItemRequestType.VariationSKU |
Element | New |
GetItemRequestType.VariationSpecifics |
Element | New |
ItemType.Variations |
Element | New |
NameValueListType.VariationSpecificPictures |
Element | New |
NameValueListType.VariationsEnabled |
Element | New |
PlaceOfferRequestType.VariationSpecifics |
Element | New |
RecommendationValidationRulesType.VariationPicture |
Element | New |
RecommendationValidationRulesType.VariationSpecifics |
Element | New |
RemoveFromWatchListRequestType.VariationKey |
Element | New |
ReviseSellingManagerProductRequestType.SellingManagerProductSpecifics |
Element | New |
SellingManagerProductType.SellingManagerProductSpecifics |
Element | New |
SellingManagerSoldTransactionType.Variation |
Element | New |
ShipmentType.Notes |
Element | New |
SiteDefaultsType.AttributeConversionEnabled |
Element | New |
SiteDefaultsType.VariationsEnabled |
Element | New |
TransactionType.Variation |
Element | New |
FeatureIDCodeType.AttributeConversionEnabled |
Enum | New |
FeatureIDCodeType.VariationsEnabled |
Enum | New |
ShippingServiceCodeType.UPSWorldwideSaver |
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 - 615.
In the CompleteSale call, in ShipmentType.Notes, a Half.com seller can include shipment-related notes to the buyer. Thus, Half.com sellers can use ShipmentType.Notes in conjunction with the following existing fields available to all sellers: ShipmentTrackingNumber and ShipmentCarrierUsed.
The AddFixedPriceItem, EndFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem calls are now available in the Trading API. Unlike the way they are used in the Large Merchant Services solution, the calls do not have to be included within a data file. You can make each call the way you ordinarily make Trading API calls. For instance, an AddFixedPriceItem call would look very similar to an AddItem call. You can review the parameters for each call in the Trading API Call Reference.
AddFixedPriceItem and related calls are nearly identical to the AddItem family of calls. Here are the main differences with the fixed-price calls:
These calls are still available for use within Large Merchant Services data files. In other words, the way these calls work with the LMS Solution has not changed.
Multi-variation listings contain items that are logically the same product, but that vary in their manufacturing details (such as color), and optionally price and quantity. For example, you could create one listing with shirts that are all the same brand and style, and then organize them into a variation (a subset) with 20 large, blue shirts for $20.00 each and another variation with 15 medium, black shirts for $9.99 each. A listing can include up to 120 variations over its lifetime.
This feature will be available soon in the Sandbox, and then available in production in a subsequent release. Keep an eye on the eBay Developers Program newsletter for details.
To create multi-variation lisings, you use the AddFixedPriceItem family of calls. In AddFixedPriceItem and related calls, see the following fields for changes or additions related to multi-variation listings:
Also see new and changed fields in the following calls:
API calls that support orders, My eBay, and category metadata have also been updated.
Please note the following behavioral changes, in case you need to make adjustments to how your application currently interprets data returned by eBay:
In GetItem and related calls:
GetMyeBayBuying and related calls also support activities related to variations.
GetSearchResults returns each variation as a separate item result. This means multiple results can have the same ItemID, EndTime, and TimeLeft in the same response. When this occurs, the ViewItemURL links to a view of the View Item page that is configured to show you the relevant variation.
See Multi-Variation Listings for details about API support for this feature.
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 is deprecating Dutch (multi-listing) competitive-bid item listings in three phases. Version 615 represents the Second Phase in the deprecation process.
Phase II, version 615: On the US (0), CA (2), FRCA (210), UK (3),
and DE (77) sites; eBay throws an error if you attempt to create a Dutch auction with
AddItem or VerifyAddItem. If you attempt to create
a Dutch auction with RelistItem, eBay generates a warning and resets
Quantity to 1.
Phase III, version 619: On all sites globally, eBay will throw an error
if you attempt to create a Dutch auction with AddItem or
VerifyAddItem. If you attempt to create a Dutch auction with
RelistItem, eBay generates a warning and resets
Quantity to 1.
PromotionalDiscount, while available in the 615 schema, will not be returned until version 619. In 619, PromotionalDiscount will be returned in all Fee containers where a discount has been applied to the fee. This will work with the entire AddItem family of calls.
The following shows an example of the current Fee container, returned with a request version lower than 619:
<Fee>
<Name>Bold</Name>
<Fee currencyID="USD">2.0</Fee>
</Fee>
With a request version of 619 or higher, the AddItem family of calls can return a Fee container similar to the following:
<Fee>
<Name>Bold</Name>
<Fee currencyID="USD">0.5</Fee>
<PromotionalDiscount currencyID="USD">1.5</PromotionalDiscount>
</Fee>
Starting with version 619, a change will occur in the way VerifyAddItem returns Fee values. Currently, VerifyAddItem returns Fee values that represent the pre-discount cost of the fee, regardless of any promotional discounts. Starting with version 619, VerifyAddItem will return the discounted fee price (discounts will be subtracted from the original cost of the fee), matching how AddItem currently behaves.
As previously announced, eBay is beginning to convert some categories that previously supported ID-based attributes to only support custom Item Specifics instead.
GetCategoryFeatures now returns AttributeConversionEnabled to identify categories that eBay has fully converted from ID-based attributes to custom Item Specifics.
Here are examples of converted categories on the US eBay site (site ID 0), if you need to test this use case:
If a category has been converted, you can pass either ID-based attributes (Item.AttributeSetArray) or custom Item Specifics Item.ItemSpecifics) in the AddItem family of calls, but you can't pass both formats in the same AddItem request.
For a transition period,
AttributeConversionEnabled will return a value of Enabled for converted
categories. In these categories, if you pass in ID-based attributes in AddItem,
eBay converts them to custom Item Specifics on your behalf.
Once this transition period has ended, AttributeConversionEnabled will
begin to return a value of Disabled (or GetCategory2CS won't return category-to-characteristic set
mappings at all), and AddItem requests with ID-based attributes
will fail. Keep an eye on the eBay Developers Program newsletter for information about the
length of the transition period.
If the category is flagged as CatalogEnabled in GetCategory2CS, the attribute conversion flag in GetCategoryFeatures is also a hint that you can use GetItemRecommendations to retrieve product details in the custom Item Specifics format (instead of using GetProductSellingPages to retrieve product details in the ID-based attributes format).
If a category has not yet been converted, you may be able to pass ID-based attributes (such as Item Condition)
and custom Item Specifics in the same AddItem request. For example, this would work for
categories where GetCategory2CS returns AttributeSetID and
GetCategoryFeatures returns ItemSpecificsEnabled, but
AttributeConversionEnabled is not set to Enabled or Disabled.
With request version 607 and lower, GetCategorySpecifics does not return recommendations for categories that have been converted from ID-based attributes to custom Item Specifics. For all versions, GetCategorySpecifics does return recommendations for other categories. (This change has been made to discourage sellers from selecting values in both formats (in converted categories) and then passing them together in AddItem. This does not prevent you from passing custom Item Specifics in AddItem in these categories. You just won't see recommendations.)
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 615 and Changed Functionality - 615.
General updates have been made in the Trading API Guide and Trading API Call Reference to information about the calls related to Selling Manager and Selling Manager Pro.
The Platform Notifications Guide erroneously added the prefix "UPI" to the names of the following notifications:
WebHelp has been changed to refer to these notifications by their correct names.
Documentation Changes and Errata - 613
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.
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 - 613.
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 - 613 and Changed Functionality - 613.
The Application Settings tool, introduced in 577, has passed its Beta phase and is now the standard tool for managing user tokens. The old Authentication & Authorization chapter, which described application configuration processes made obsolete by the Application Settings tool, has been removed. The replacement chapter, Getting a Token, describes how to use the Application Settings tool to manage authentication and authorization.
PrivateNotes is no longer documented as being supported for the AddItem call.
Documentation Changes and Errata - 611
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 |
|---|---|---|
GetCategorySpecificsRequestType.CategorySpecificsFileInfo |
Element | New |
GetCategorySpecificsResponseType.FileReferenceID |
Element | New |
GetCategorySpecificsResponseType.TaskReferenceID |
Element | New |
EndReasonCodeType.Sold |
Enum | New |
SearchFlagCodeType.WorldOfGood |
Enum | New |
eBay is deprecating Dutch (multi-listing) competitive-bid item listings in three phases.
Phase I, Release 611: eBay generates a warning when you create a Dutch Auction listing with AddItem, VerifyAddItem, or RelistItem.
The GetHighBidders call and the ListingTypeCodeList.Dutch type are deprecated in this phase. GetHighBidders will continue to work until no Dutch Auction listings remain on the site.
Phase II, Release 615: In sites US, CAFR, CA, UK, and DE; ebay will throw an error if you attempt to create a Dutch auction with AddItem or VerifyAddItem. For RelistItem, eBay will generate a warning and reset Quantity value to 1.
Phase III, Release 619: In all sites globally, ebay will throw an error if you attempt to create a Dutch Auction with AddItem or VerifyAddItem. For RelistItem, eBay will generate a warning and reset Quantity to 1.
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 - 611.
You can now use the downloadFile call in the File Transfer API to download a single GetCategorySpecifics response that contains custom Item Specific recommendations (if any) for all categories on a specified site. The GetCategorySpecifics response is returned as a .zip file attachment. It uses the new Recommendations node (introduced with version 609).
The Trading API normally enables you to retrieve recommendations for 250-275 leaf categories at a time. For applications that support a very wide variety of categories, the new file download approach may be more convenient.
| Note: You don't need to learn about (or use) Large Merchant Services or the Bulk Data Exchange API in order to use downloadFile call in the File Transfer API. |
Here's how it works:
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.
Starting with this release, sellers adding items to the India site (site ID 203) will no longer be able to charge a value added tax (VAT) in addition to the price of their items. Instead, sellers must include any VAT charges as part of the item price. The sellers are solely responsible for compliance relating to tax legislation in India.
Note that the eBay APIs have not changed; you can still add items to the India site that include VAT values (Item.VATDetails). If you do add an item to the India site with a VAT value, eBay generates a warning message that indicates the listing was accepted, but the VAT value was removed. To include the VAT, relist the item with a StartPrice value that includes the VAT.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 611 and Changed Functionality - 611.
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.