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:
| Q4 2008 | Q3 2008 | Q2 2008 | Q1 2008 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Version | Release Date | Version | Release Date | Version | Release Date | Version | Release Date | ||||
| 597 | Not Released | 583 | 2008-9-17 | 571 | 2008-6-25 | 557 | 2008-3-19 | ||||
| 595 | 2008-12-10 | 581 | 2008-9-3 | 569 | 2008-6-11 | 555 | 2008-3-5 | ||||
| 593 | Not Released | 579 | 2008-8-20 | 567 | 2008-5-28 | 553 | 2008-2-20 | ||||
| 591 | 2008-11-12 | 577 | 2008-8-6 | 565 | 2008-5-14 | 551 | 2008-2-6 | ||||
| 589 | 2008-10-29 | 575 | 2008-7-23 | 563 | 2008-4-30 | 549 | 2008-1-23 | ||||
| 587 | 2008-10-15 | 573 | 2008-7-9 | 561 | 2008-4-16 | 547 | 2008-1-9 | ||||
| 585 | 2007-10-3 | 559 | 2008-4-2 | ||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
Documentation Changes and Errata - 595
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 |
|---|---|---|
ItemType.InventoryTrackingMethod |
Element | New |
As announced, starting December 31, 2008, eBay will no longer offer eBay Live Auctions. The corresponding functionality in the API also will be retired.
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 - 595.
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 - 595 and Changed Functionality - 595.
For additions to the Trading API Guide regarding affiliate commissions through use of PlaceOffer, please see the PlaceOffer Policies and Guidelines.
No 593 schema was released.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 591
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
No changed calls in this release.
No schema changes in this release.
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 591.
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.
Updated Nov. 26: As recently announced in the eBay Developers Program blog, eBay's Large Merchant APIs are now in Beta. Large Merchant Services offer a powerful new way to list and manage items in bulk. These APIs can save developers processing power and bandwidth, and allow sellers to react quickly to marketplace dynamics.
The Trading API can be used in conjunction with eBay's Large Merchant Services (LMS) to complete your large merchant solution. The Merchant Data API (in LMS) defines two requests for creating new listings: AddFixedPriceItem and RelistFixedPriceItem. When you create a listing with these requests, you can optionally use an InventoryTrackingMethod field to choose whether you prefer to track the listing by item ID or by your own unique SKU. If you track by SKU, it means you can pass your SKU instead of the item ID in subsequent Merchant Data API requests, such as ReviseFixedPriceItem, and in several Trading API calls. The Trading API's AddItem and RelistItem calls do not offer the inventory tracking preference. However, you can use GetItem, GetSellerList, GetSellerTransactions, and other Trading API calls to retrieve data about these listings and transactions. ReviseInventoryStatus also supports tracking listings by SKU.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 591 and Changed Functionality - 591.
None for this release.
Documentation Changes and Errata - 589
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 |
|---|---|---|
ShippingPackageDetailsType.Default |
Entity | Removed |
AddItemFromSellingManagerTemplateRequestType |
Complex type | New |
AddItemFromSellingManagerTemplateResponseType |
Complex type | New |
AddSellingManagerInventoryFolderRequestType |
Complex type | New |
AddSellingManagerInventoryFolderResponseType |
Complex type | New |
AddSellingManagerProductRequestType |
Complex type | New |
AddSellingManagerProductResponseType |
Complex type | New |
AddSellingManagerTemplateRequestType |
Complex type | New |
AddSellingManagerTemplateResponseType |
Complex type | New |
DeleteSellingManagerInventoryFolderRequestType |
Complex type | New |
DeleteSellingManagerInventoryFolderResponseType |
Complex type | New |
DeleteSellingManagerItemAutomationRuleRequestType |
Complex type | New |
DeleteSellingManagerItemAutomationRuleResponseType |
Complex type | New |
DeleteSellingManagerProductRequestType |
Complex type | New |
DeleteSellingManagerProductResponseType |
Complex type | New |
DeleteSellingManagerTemplateAutomationRuleRequestType |
Complex type | New |
DeleteSellingManagerTemplateAutomationRuleResponseType |
Complex type | New |
DeleteSellingManagerTemplateRequestType |
Complex type | New |
DeleteSellingManagerTemplateResponseType |
Complex type | New |
GetSellingManagerAlertsRequestType |
Complex type | New |
GetSellingManagerAlertsResponseType |
Complex type | New |
GetSellingManagerEmailLogRequestType |
Complex type | New |
GetSellingManagerEmailLogResponseType |
Complex type | New |
GetSellingManagerInventoryFolderRequestType |
Complex type | New |
GetSellingManagerInventoryFolderResponseType |
Complex type | New |
GetSellingManagerInventoryRequestType |
Complex type | New |
GetSellingManagerInventoryResponseType |
Complex type | New |
GetSellingManagerItemAutomationRuleRequestType |
Complex type | New |
GetSellingManagerItemAutomationRuleResponseType |
Complex type | New |
GetSellingManagerSaleRecordRequestType |
Complex type | New |
GetSellingManagerSaleRecordResponseType |
Complex type | New |
GetSellingManagerSoldListingsRequestType |
Complex type | New |
GetSellingManagerSoldListingsResponseType |
Complex type | New |
GetSellingManagerTemplateAutomationRuleRequestType |
Complex type | New |
GetSellingManagerTemplateAutomationRuleResponseType |
Complex type | New |
GetSellingManagerTemplatesRequestType |
Complex type | New |
GetSellingManagerTemplatesResponseType |
Complex type | New |
InventoryStatusType |
Complex type | New |
MoveSellingManagerInventoryFolderRequestType |
Complex type | New |
MoveSellingManagerInventoryFolderResponseType |
Complex type | New |
ReviseInventoryStatusRequestType |
Complex type | New |
ReviseInventoryStatusResponseType |
Complex type | New |
ReviseSellingManagerInventoryFolderRequestType |
Complex type | New |
ReviseSellingManagerInventoryFolderResponseType |
Complex type | New |
ReviseSellingManagerProductRequestType |
Complex type | New |
ReviseSellingManagerProductResponseType |
Complex type | New |
ReviseSellingManagerSaleRecordRequestType |
Complex type | New |
ReviseSellingManagerSaleRecordResponseType |
Complex type | New |
ReviseSellingManagerTemplateRequestType |
Complex type | New |
ReviseSellingManagerTemplateResponseType |
Complex type | New |
SaveItemToSellingManagerTemplateRequestType |
Complex type | New |
SaveItemToSellingManagerTemplateResponseType |
Complex type | New |
SellingManagerAlertType |
Complex type | New |
SellingManagerAutoListAccordingToScheduleType |
Complex type | New |
SellingManagerAutoListMinActiveItemsType |
Complex type | New |
SellingManagerAutoListType |
Complex type | New |
SellingManagerAutoRelistType |
Complex type | New |
SellingManagerAutoSecondChanceOfferType |
Complex type | New |
SellingManagerDetailsType |
Complex type | New |
SellingManagerEmailLogType |
Complex type | New |
SellingManagerFolderDetailsType |
Complex type | New |
SellingManagerOrderStatusType |
Complex type | New |
SellingManagerProductInventoryStatusType |
Complex type | New |
SellingManagerProductType |
Complex type | New |
SellingManagerSearchType |
Complex type | New |
SellingManagerSoldOrderType |
Complex type | New |
SellingManagerSoldTransactionType |
Complex type | New |
SellingManagerTemplateDetailsArrayType |
Complex type | New |
SellingManagerTemplateDetailsType |
Complex type | New |
SellingManagerVendorDetailsType |
Complex type | New |
SetSellingManagerItemAutomationRuleRequestType |
Complex type | New |
SetSellingManagerItemAutomationRuleResponseType |
Complex type | New |
SetSellingManagerTemplateAutomationRuleRequestType |
Complex type | New |
SetSellingManagerTemplateAutomationRuleResponseType |
Complex type | New |
TimeRangeType |
Complex type | New |
VATRateType |
Complex type | New |
DayOfWeekCodeType |
Enumerated type | New |
SellingManagerAlertTypeCodeType |
Enumerated type | New |
SellingManagerAutoRelistOptionCodeType |
Enumerated type | New |
SellingManagerAutoRelistTypeCodeType |
Enumerated type | New |
SellingManagerAutoSecondChanceOfferTypeCodeType |
Enumerated type | New |
SellingManagerAutomationPropertyTypeCodeType |
Enumerated type | New |
SellingManagerEmailSentStatusCodeType |
Enumerated type | New |
SellingManagerEmailTypeCodeType |
Enumerated type | New |
SellingManagerGeneralPropertyTypeCodeType |
Enumerated type | New |
SellingManagerInventoryPropertyTypeCodeType |
Enumerated type | New |
SellingManagerPaidStatusCodeType |
Enumerated type | New |
SellingManagerPaisaPayPropertyTypeCodeType |
Enumerated type | New |
SellingManagerProductSortCodeType |
Enumerated type | New |
SellingManagerSearchTypeCodeType |
Enumerated type | New |
SellingManagerShippedStatusCodeType |
Enumerated type | New |
SellingManagerSoldListingsPropertyTypeCodeType |
Enumerated type | New |
SellingManagerSoldListingsSortTypeCodeType |
Enumerated type | New |
UnpaidItemStatusTypeCodeType |
Enumerated type | New |
GetItemRequestType.SKU |
Element | New |
GetSellerTransactionsRequestType.InventoryTrackingMethod |
Element | New |
ItemTransactionIDType.SKU |
Element | New |
ItemType.PaymentAllowedSite |
Element | New |
SellingManagerProductDetailsType.FolderID |
Element | New |
SellingManagerProductDetailsType.Note |
Element | New |
SellingManagerProductDetailsType.RestockAlert |
Element | New |
SellingManagerProductDetailsType.RestockThreshold |
Element | New |
SellingManagerProductDetailsType.VendorInfo |
Element | New |
SendInvoiceRequestType.SKU |
Element | New |
ShippingPackageDetailsType.DefaultValue |
Element | New |
FeatureIDCodeType.IntangibleEnabled |
Enum | New |
NotificationEventTypeCodeType.BulkDataExchangeJobCompleted |
Enum | New |
StoreItemListSortOrderCodeType.HighestPricedPlusShipping |
Enum | New |
StoreItemListSortOrderCodeType.LowestPricedPlusShipping |
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 - 589.
This Trading API release contains a preview of calls related to Selling Manager and Selling Manager Pro. These calls will be available in 2009 for Open eBay participants who are building applications related to Selling Manager and Selling Manager Pro. For more information about Open eBay, please see http://developer.ebay.com/echo.
As stated in the description of each call in the Call Reference, these calls are unsupported and are currently available only to Open eBay pilot participants. These calls are subject to change without notice; the deprecation process is inapplicable to these calls.
For information about Selling Manager and Selling Manager Pro, please see http://pages.ebay.com/selling_manager_pro and http://pages.ebay.com/selling%5Fmanager.
More information about these calls will be provided in 2009. For the names of the new calls, please see the New Calls section, above.
The Item.PaymentAllowedSite field, which can be returned by GetItem, enables you to view the sites on which an item can be purchased, based on the payment methods offered for the item.
By March 2009, a Payflow account (obtainable in January 2009 in My eBay) will be required when sellers on the US site offer credit cards (Visa, MasterCard, American Express, and Discover).
For general information about specifying payment methods, see Payment Method Differences. For information on payment changes on the US site, see August Payments Policy Changes.
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.
When sellers first list fixed-price items, their search ranking is determined by seller qaulity (DSRs) and title relevance. Best Match search ranking also takes into account buyer activity. When items in a listing begin to sell, the Resent Sales History factors into search ranking. Items that sell the fastest are given a relative lift in search results.
Recent Sales history is tracked with a moving window to ensure it reflects the most recent activity. Due to the moving window, it is advantageous for sellers to maintain item availability for a GTC listing (that is, keep quanitity from dropping too low), or to relist as quickly as possible when an item ends (recent sales scores can be transferred to the relisted item). Refer to How the Moving Window Affects Recent Sales in the Developers Program Community Blog for more information.
ShippingPackageDetailsType.Default (returned by GeteBayDetails) was deprecated with version 589. DefaultValue is its replacement. The API returns only DefaultValue for versions greater than or equal to 589. The API returns both Default and DefaultValue for versions lower than 589. We recommend that you change your application to handle the return of DefaultValue.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 589 and Changed Functionality - 589.
In the Call Reference, the Item.PictureDetails.PictureURL field has been removed from the output of GetSearchResults, as a documentation correction.
Documentation Changes and Errata - 587
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 |
|---|---|---|
SellingManagerProductDetailsType.PartNumber |
Entity | Removed (unused by calls) |
SellingManagerProductDetailsType.ProductPartNumber |
Entity | Removed (unused by calls) |
ShippingPackageDetailsType.DimensionsSupported |
Element | New |
ShippingServiceDetailsType.ShippingServicePackageDetails |
Element | New |
ShippingServiceDetailsType.WeightRequired |
Element | New |
ShipmentDeliveryStatusCodeType.Error |
Enum | Reserved for future use |
ShipmentDeliveryStatusCodeType.Unconfirmed |
Enum | Reserved for future use |
ShipmentDeliveryStatusCodeType.Unknown |
Enum | Reserved for future use |
ShippingServiceCodeType.CA_PostExpeditedFlatRateBox |
Enum | New |
ShippingServiceCodeType.CA_PostExpeditedFlatRateBoxUSA |
Enum | New |
TransactionPlatformCodeType.WorldOfGood |
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 - 587.
WorldOfGood has been added as a TransactionPlatformCodeType value. It is returned by GetItemTransactions, GetMyeBayBuying, GetMyeBaySelling, GetOrderTransactions, and GetSellerTransactions.
If you are still using Item.AttributeSetArray instead of Item.ReturnPolicy to specify a return policy, you can now pass -10 in ValueID and ReturnsNotAccepted in ValueLiteral to specify "Returns Not Accepted" in AddItem. This value was available on the US site in early October. It should be available on international sites in late October. See the eBay Developer Newsletter and blog for updates on when sellers will be required to specify a return policy.
Please note that GetAttributesCS has not been updated to mirror the latest changes to the Return Policy fields that each site supports. For example, GetAttributesCS does not return the -10 value for "Returns Not Accepted", but AddItem does accept this value. GetAttributesCS also may show return policy attributes or values that are no longer applicable on some sites. If you pass inapplicable attributes or values in AddItem, they will be dropped, and a warning may be returned.
Featured First is a paid feature that sellers may purchase for individual listings to get a chance to increase exposure. It is currently available for the following sites: US (0 - not Motors), Canada (2), Canada (French) (210), UK (3), Ireland (205), Germany (77), Austria (16), Switzerland (193), and Italy (101). Featured First gives you an opportunity, but no guarantee, to have your listing appear on the first page of search results in the Featured Items section.
With Featured First:
See the Featured First online help page for more information.
As part of this change, Featured Plus now behaves slightly differently for browse functionality. When browsing, instead of all Featured Plus items being shown prior to any non-featured items, Featured Plus items are now shown in real time, at the top of the page they would normally show up on. The behavior for keyword searching has not changed.
See the Featured Plus online help page for more information.
The Featured First option is selected by specifying Featured in the PictureDetails.GalleryType field. The behavior of your listing within the search results is determined as follows:
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 has simplified (reduced) the list of package types for the shipping calculator. If a seller relists or revises an item with a deprecated package type, eBay will automatically map the deprecated package type to an appropriate active package type. Simplification of the package types only applies to the shipping calculator for the eBay US site and eBay Motors Parts and Accessories.
In the future, eBay will require sellers to provide package dimensions for the shipping calculator when it is used for large packages, irregular sized packages, and all the UPS air services for packages.
If a seller provides package dimensions for a service that does not require dimensions, eBay will use the dimensions to more accurately calculate shipping rates. We encourage sellers to provide package dimensions whenever possible so that shipping rates are more accurate for buyers. (If dimensions are omitted, eBay uses a set of default values for rate calculations.)
Developer impact
587:
In the future:
Affected calls: GeteBayDetails and the AddItem family of calls.
To learn about the shipping calculator, see GetItemShipping documentation.
The shipping mechanisms discussed in the 585 Release Notes will go into effect for eBay DE around November 4. eBay DE is currently the only site for which the GroupN style of elements apply.
See Schema Changes for a list of new shipping services.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 587 and Changed Functionality - 587.
None for this release.
Documentation Changes and Errata - 585
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 |
|---|---|---|
BuyerPaymentMethodCodeType.Moneybookers |
Entity | Removed |
BuyerPaymentMethodCodeType.allpay |
Entity | Removed |
AddItemRequestContainerType |
Complex type | New |
AddItemResponseContainerType |
Complex type | New |
AddItemsRequestType |
Complex type | New |
AddItemsResponseType |
Complex type | New |
EndItemRequestContainerType |
Complex type | New |
EndItemResponseContainerType |
Complex type | New |
EndItemsRequestType |
Complex type | New |
EndItemsResponseType |
Complex type | New |
Group1MaxFlatShippingCostDefinitionType |
Complex type | New |
Group2MaxFlatShippingCostDefinitionType |
Complex type | New |
Group3MaxFlatShippingCostDefinitionType |
Complex type | New |
MaxFlatShippingCostCBTExemptDefinitionType |
Complex type | New |
MaxFlatShippingCostDefinitionType |
Complex type | New |
PaymentMethodDefinitionType |
Complex type | New |
ShippingServicePackageDetailsType |
Complex type | New |
CostGroupFlatCodeType |
Enumerated type | New |
CategoryFeatureType.Group1MaxFlatShippingCost |
Element | New |
CategoryFeatureType.Group2MaxFlatShippingCost |
Element | New |
CategoryFeatureType.Group3MaxFlatShippingCost |
Element | New |
CategoryFeatureType.PaymentMethod |
Element | New |
FeatureDefinitionsType.Group1MaxFlatShippingCost |
Element | New |
FeatureDefinitionsType.Group2MaxFlatShippingCost |
Element | New |
FeatureDefinitionsType.Group3MaxFlatShippingCost |
Element | New |
FeatureDefinitionsType.MaxFlatShippingCost |
Element | New |
FeatureDefinitionsType.MaxFlatShippingCostCBTExempt |
Element | New |
FeatureDefinitionsType.PaymentMethod |
Element | New |
FeedbackDetailType.FeedbackRevised |
Element | New |
ShippingServiceDetailsType.CostGroupFlat |
Element | New |
SiteDefaultsType.Group1MaxFlatShippingCost |
Element | New |
SiteDefaultsType.Group2MaxFlatShippingCost |
Element | New |
SiteDefaultsType.Group3MaxFlatShippingCost |
Element | New |
SiteDefaultsType.PaymentMethod |
Element | New |
FeatureIDCodeType.Group1MaxFlatShippingCost |
Enum | New |
FeatureIDCodeType.Group2MaxFlatShippingCost |
Enum | New |
FeatureIDCodeType.Group3MaxFlatShippingCost |
Enum | New |
FeatureIDCodeType.MaxFlatShippingCost |
Enum | New |
FeatureIDCodeType.MaxFlatShippingCostCBTExempt |
Enum | New |
FeatureIDCodeType.PaymentMethods |
Enum | New |
ShippingServiceCodeType.CA_PriorityWorldwide |
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.
As announced in Version 583, eBay is imposing limits on shipping costs for selected categories.
Starting October 8, this cost threshold applies to items listed on the eBay US site (regardless of whether shipping within or shipping into the US) for items in the Books, Movies & DVDs, Music, and Video Games categories. (Items listed on other sites yet shipped into the US are not limited by these thresholds.)
For details, see Maximum Flat Rate Shipping Cost in the Specifying Shipping Costs portion of the Shipping documentation. (If you read the Version 583 documentation, please note that there is no MaxFlatShippingCostEnabled element and that the *Cost elements may be returned in both the SiteDefaults and Category containers.)
Rollout schedule:
Affected calls: GetCategoryFeatures, GeteBayDetails, the AddItem family of calls.
Beginning in late October 2008, you can use ProPay as a payment method for listings on the US site. You also can use PayOnPickup for cases of cash on pickup.
For general information about specifying payment methods, see Payment Method Differences. For information on payment changes on the US site, see August Payments Policy Changes.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 585.
As previously announced, changes are occurring in the allowed payment methods for listings. Please use GetCategoryFeatures to determine the available payment methods for a site or category. For more information, see Payment Method Differences. Please also note that, as previously announced, you can use GetCategoryFeatures to determine if a listing must include PayPal as a payment method.
AddItems is a new batch listing call. It will list up to five(5) items per request.
EndItems is another new batch call. It will end up to ten(10) items early.
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 - 585 and Changed Functionality - 585.
ShippedTime was added to ShipmentType on version 583. This was not mentioned in 583 release notes.
Documentation Changes and Errata - 583
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 |
|---|---|---|
InventoryTrackingMethodCodeType |
Enumerated type | New |
AbstractResponseType.ExternalUserData |
Element | New |
CategoryFeatureType.MaxFlatShippingCost |
Element | New |
NotificationUserDataType.ExternalUserData |
Element | New |
ShipmentType.ShippedTime |
Element | New |
SiteDefaultsType.MaxFlatShippingCost |
Element | New but deprecated (Do not use) |
SiteDefaultsType.MaxFlatShippingCostCBTExempt |
Element | New |
BuyerPaymentMethodCodeType.Moneybookers |
Enum | New |
BuyerPaymentMethodCodeType.PayOnPickup |
Enum | New |
BuyerPaymentMethodCodeType.ProPay |
Enum | New |
BuyerPaymentMethodCodeType.allpay |
Enum | New |
QuestionTypeCodeType.None |
Enum | New |
ShippingCarrierCodeType.Nacex |
Enum | New |
As previously announced, starting in September 2008, on the Australia site, sellers and bidders will be unable to retrieve each other's email addresses unless they are in a transactional relationship.
The Bid Assistant feature will be removed from the eBay site, and related API elements such as BidAssistantList and BidGroupArrayType that are used in the GetMyeBayBuying call, as well as BidGroupItemStatusCodeList, BidGroupItemType, BidGroupStatusCodeList, BidGroupType, and BidRangeType, will be decremented in the beginning of October.
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 - 583.
"Total flat rate shipping cost" is the sum of the seller's base flat rate shipping charge and the cost of insurance (if insurance is required by the seller). Starting in October, there will be certain categories in which a listing with flat rate shipping can be created only if the total cost of shipping matches or is below the maximum shipping cost set by eBay for the category that the listing is in.
This cost threshold will initially apply only to items listed on the eBay US site (regardless of whether shipping within or shipping into the US) for items in the Books, Movies & DVDs, Music, and Video Games categories. (Items listed on other sites yet shipped into the US are not limited by these thresholds.)
You can start learning about the future API mechanism now by reading Maximum Flat Rate Shipping Cost in the Specifying Shipping Costs portion of the Shipping documentation.
Rollout schedule:
A new field, HideDuplicateItems, has been added to GetCategoryListings, GetProducts, and GetSearchResults to suppress duplicate item listings from search results. When HideDuplicateItems is set to true in the request, duplicate item listings will not be returned in the response. If duplicate items were filtered from the search results, then DuplicateItems will be returned in the response with a value of true.
Items are considered duplicates when all of the following conditions are met:
The listing format for the duplicate and the original item listing must both fall into the same basic type of listing:
HideDuplicateItems is optional and defaults to false if not specified.
In the 565 release, changes were made to treat Store Inventory Format (StoresFixedPrice)items as basic fixed price (FixedPriceItem) items on the Italy site. This change is now extended to many more eBay sites. Starting mid-September, these changes will be available on the following eBay sites: US, US Motors, CA and CA-FR. Use GetCategoryFeatures with FeatureID set to CombinedFixedPriceTreatment to determine whether a given site or category are affected.
Additional changes for fixed price listings include:
FixedPriceItem) listings and Store inventory format (StoresFixedPrice) listings on the eBay Italy site. Listing durations of 30 days and "Good Til Cancelled" (GTC) are being allowed for store subscribers and non-store subscribers for basic fixed price and Store inventory format listings on additional sites and categories. Use GetCategoryFeatures with FeatureID set to ListingDurations to determine the standard listing durations allowed for a given site or category. Set FeatureID set to StoreOwnerExtendedListingDurationsEnabled to determine whether a given site or category supports extended listing durations for store owners. Set FeatureID to StoreOwnerExtendedListingDurations to get any extended durations.FixedPriceItem and StoresFixedPrice) listings. Use GetCategoryFeatures with FeatureID set to PayPalRequiredForStoreOwner to determine whether store owners must offer PayPal as a payment method for fixed price listings on a given site or category.ReviseQuantityAllowed or RevisePriceAllowed to determine whether quantity or price for fixed price listings can be revised at any time, despite standard restrictions.Please refer to the 565 release notes for additional information for these changes.
In the 565 release, the ability for sellers to specify the duration for Featured First (known as Gallery Featured on other eBay sites) was made available on the eBay Italy site. Starting in October, this feature will be supported by additional eBay sites. Use GetCategoryFeatures with FeatureID set to GalleryFeaturedDurations to determine whether a given site or category are affected. Please refer to the 565 release notes for additional information for these changes.
The new SetSellingManagerFeedbackOptions call allows Selling Manager and Selling Manager Pro subscribers to store up to ten comments that can be left as feedback to buyers. Selling Manager Pro subscribers can use AutomatedLeaveFeedbackEvent to specify an event that will trigger automated feedback to buyers.
A new field, ExternalUserData, is added to NotificationUserDataType in Set/GetNotificationPreferences requests, and to AbstractResponseType. The field is an XML-compliant string, not to exceed 256 characters. An example use case for this field is to set a third-party user-identifier string that will be returned with each notification payload. Please use due caution and encryption if you are passing any sensitive information
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.
Nacex and Correos were added to ShippingCarrierCodeType for domestic shipping for eBay Spain.
As previously announced, eBay will require all listings to specify a return policy and handling time (dispatch time) in Q1 2009. As some sellers may need to modify existing GTC (Good 'Til Canceled) listings to support these requirements, you can now use ReviseItem to add a return policy and/or dispatch time to an existing GTC listing, even when it has sales.
When Messages.Message.MessageType isn't set to AskSellerQuestion, a new value of None (in Message.QuestionType) is returned.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 583 and Changed Functionality - 583.
None for this release.
Documentation Changes and Errata - 581
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 |
|---|---|---|
FeedbackCommentArrayType |
Complex type | New |
HandlingTimeEnabledDefinitionType |
Complex type | New |
PayPalRequiredForStoreOwnerDefinitionType |
Complex type | New |
RefundDetailsType |
Complex type | New |
ReturnPolicyDetailsType |
Complex type | New |
ReturnPolicyEnabledDefinitionType |
Complex type | New |
ReturnPolicyType |
Complex type | New |
ReturnsAcceptedDetailsType |
Complex type | New |
ReturnsWithinDetailsType |
Complex type | New |
RevisePriceAllowedDefinitionType |
Complex type | New |
ReviseQuantityAllowedDefinitionType |
Complex type | New |
SetSellingManagerFeedbackOptionsRequestType |
Complex type | New |
SetSellingManagerFeedbackOptionsResponseType |
Complex type | New |
ShippingCostPaidByDetailsType |
Complex type | New |
StoreOwnerExtendedListingDurationsDefinitionType |
Complex type | New |
StoreOwnerExtendedListingDurationsEnabledDefinitionType |
Complex type | New |
StoreOwnerExtendedListingDurationsType |
Complex type | New |
WarrantyDurationDetailsType |
Complex type | New |
WarrantyOfferedDetailsType |
Complex type | New |
WarrantyTypeDetailsType |
Complex type | New |
AutomatedLeaveFeedbackEventCodeType |
Enumerated type | New |
RefundOptionsCodeType |
Enumerated type | New |
ReturnsAcceptedOptionsCodeType |
Enumerated type | New |
ReturnsWithinOptionsCodeType |
Enumerated type | New |
ShippingCostPaidByOptionsCodeType |
Enumerated type | New |
WarrantyDurationOptionsCodeType |
Enumerated type | New |
WarrantyOfferedCodeType |
Enumerated type | New |
WarrantyTypeOptionsCodeType |
Enumerated type | New |
CategoryFeatureType.HandlingTimeEnabled |
Element | New |
CategoryFeatureType.PayPalRequiredForStoreOwner |
Element | New |
CategoryFeatureType.ReturnPolicyEnabled |
Element | New |
CategoryFeatureType.RevisePriceAllowed |
Element | New |
CategoryFeatureType.ReviseQuantityAllowed |
Element | New |
CategoryFeatureType.StoreOwnerExtendedListingDurations |
Element | New |
CategoryFeatureType.StoreOwnerExtendedListingDurationsEnabled |
Element | New |
FeatureDefinitionsType.HandlingTimeEnabled |
Element | New |
FeatureDefinitionsType.PayPalRequiredForStoreOwner |
Element | New |
FeatureDefinitionsType.ReturnPolicyEnabled |
Element | New |
FeatureDefinitionsType.RevisePriceAllowed |
Element | New |
FeatureDefinitionsType.ReviseQuantityAllowed |
Element | New |
FeatureDefinitionsType.StoreOwnerExtendedListingDurations |
Element | New |
FeatureDefinitionsType.StoreOwnerExtendedListingDurationsEnabled |
Element | New |
GetCategoryListingsRequestType.HideDuplicateItems |
Element | New |
GetCategoryListingsResponseType.DuplicateItems |
Element | New |
GetProductsRequestType.HideDuplicateItems |
Element | New |
GetProductsResponseType.DuplicateItems |
Element | New |
GetSearchResultsRequestType.HideDuplicateItems |
Element | New |
GetSearchResultsResponseType.DuplicateItems |
Element | New |
GeteBayDetailsResponseType.ReturnPolicyDetails |
Element | New |
ItemType.ReturnPolicy |
Element | New |
SiteDefaultsType.HandlingTimeEnabled |
Element | New |
SiteDefaultsType.PayPalRequiredForStoreOwner |
Element | New |
SiteDefaultsType.ReturnPolicyEnabled |
Element | New |
SiteDefaultsType.RevisePriceAllowed |
Element | New |
SiteDefaultsType.ReviseQuantityAllowed |
Element | New |
SiteDefaultsType.StoreOwnerExtendedListingDurations |
Element | New |
SiteDefaultsType.StoreOwnerExtendedListingDurationsEnabled |
Element | New |
UserType.EnterpriseSeller |
Element | Reserved for future use |
DetailNameCodeType.ReturnPolicyDetails |
Enum | New |
FeatureIDCodeType.HandlingTimeEnabled |
Enum | New |
FeatureIDCodeType.PayPalRequiredForStoreOwner |
Enum | New |
FeatureIDCodeType.ReturnPolicyEnabled |
Enum | New |
FeatureIDCodeType.RevisePriceAllowed |
Enum | New |
FeatureIDCodeType.ReviseQuantityAllowed |
Enum | New |
FeatureIDCodeType.StoreOwnerExtendedListingDurations |
Enum | New |
FeatureIDCodeType.StoreOwnerExtendedListingDurationsEnabled |
Enum | New |
As announced in the eBay Developers Program blog, eBay has added or will soon be adding a number of new requirements for eBay listings. These include:
In the new View Item page, the user description is hosted by eBay on a different domain and loaded into an iFrame for display on the View Item page. This helps eBay to separate user content from eBay content, and protects users from content that could be harmful. With this change, your scripts will only be allowed to modify and control your item description and the area it occupies.
eBay has implemented this in a way that will not impact your SEO.
Here are some steps you can take to make sure your content appears as expected inside an iFrame.
Content Dimensions
File Linking
Content Validity
See also the blog post and commentary on the View Item page domain split.
For details on sizing pictures in the new View Item page, see this blog post.
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 - 581.
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 previously announced in the blog, on the US site starting in October 2008, only four payment methods will be permitted in most categories. See the blog post on Paperless Payments for preliminary details. For general information about specifying payment methods, see Payment Method Differences.
By October 2008, most categories will require the seller to specify how long it will take the seller to ship an item after receiving cleared payment. This handling time (dispatch time) does not not include the shipping time itself (the time in transit). Use GetCategoryFeatures to determine which categories require a handling time. See Handling Time and Estimated Delivery Time.
In Q1 2009, most categories will require the seller to specify a return policy. Use GetCategoryFeatures to determine which categories require a return policy, and use GeteBayDetails to determine the return policy options each site supports. See Offering a Clear Return Policy.
To make return policies easier to specify, we have added a new ReturnPolicy node in the AddItem and GetItem families of calls. The new node will be functional in mid-September 2008.
You will no longer need to use the Attribute API to specify return policy details. However, the Attribute format will still be supported as input to the AddItem family of calls until after the 2008 holiday season. Please note that some sites have added a new "Return shipping will be paid by" attribute (3993) with two values: Buyer (81120) and Seller (81121). Some sites have also added an "Item must be returned within" value of 60 days (95148). GetItem no longer returns the Return Policy attributes, regardless of your request version.
As previously announced, sellers on the US site now are required to specify at least one domestic shipping service (exception: freight shipping). For those who intend to not ship an item (that is, local pickup only), a special "shipping service" has been created for the purpose of local pickup only. For more information, see Specifying Shipping Costs.
France joins several other European Union countries where users who have sold more than 2000 EUR a month over a period of three months will have to update their account type from 'personal' to 'business'. They will receive an error message if they try to use one of the AddItem family of API calls if their account is not defined or if it has been flagged as 'business required'.
For business accounts, a return policy is required.
See Changes for Business Sellers in Release 549 for more information.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 581 and Changed Functionality - 581.
None for this release.
Documentation Changes and Errata - 579
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 |
|---|---|---|
AuthenticationEntryArrayType |
Entity | Removed |
AuthenticationEntryType |
Entity | Removed |
CartItemArrayType |
Entity | Removed |
CartType |
Entity | Removed |
CheckoutCompleteRedirectType |
Entity | Removed |
ConditionSelectionCodeType |
Entity | Removed |
DomainHistogramType |
Entity | Removed |
ExpressDetailLevelCodeType |
Entity | Removed |
ExpressHistogramSortCodeType |
Entity | Removed |
ExpressItemSortCodeType |
Entity | Removed |
ExpressProductSortCodeType |
Entity | Removed |
GetCartRequestType |
Entity | Removed |
GetCartResponseType |
Entity | Removed |
GetExpressWishListRequestType |
Entity | Removed |
GetExpressWishListResponseType |
Entity | Removed |
GetItemRequestType.IncludeExpressRequirements |
Entity | Removed |
GetSearchResultsExpressRequestType |
Entity | Removed |
GetSearchResultsExpressResponseType |
Entity | Removed |
GetUserPreferencesResponseType.ExpressPreferences |
Entity | Removed |
ItemType.ExpressDetails |
Entity | Removed |
ItemType.ExpressOptOut |
Entity | Removed |
ListingDetailsType.ExpressItemRequirements |
Entity | Removed |
ListingDetailsType.ExpressListing |
Entity | Removed |
ProductArrayType |
Entity | Removed |
SellerType.ExpressEligible |
Entity | Removed |
SellerType.ExpressSellerRequirements |
Entity | Removed |
SellerType.ExpressWallet |
Entity | Removed |
SetCartRequestType |
Entity | Removed |
SetCartResponseType |
Entity | Removed |
SetUserPreferencesRequestType.ExpressPreferences |
Entity | Removed |
WishListSortCodeType |
Entity | Removed |
WishListType |
Entity | Removed |
CharityInfoType.DisplayNameInCheckout |
Element | New |
By the end of September 2008, US eBay Express will be shut down. Any eBay Fixed Price and/or Store Inventory listings that appear on both eBay and US eBay Express will be removed from US eBay Express. These listings will remain active on eBay.com. The UK and Germany eBay Express sires were shut down in April 2008.
The following eBay Express-specific API calls (and related schema) have been deprecated as of release 579:
With request versions lower than 579, the calls will continue to work. However, regardless of the request version specified, the calls will stop working when the site is closed.
Please refer to the release notes and the respective Express sites for more information.
Please see the Developers Program Blog for information about recent announcements aimed at satisfying buyers and lowering upfront costs for sellers.
Starting in September 2008 on the Australia eBay site, sellers and bidders will not be able to retrieve each other's email addresses unless they are in a transactional relationship. If a listing is active, sellers will not be able to view the bidder's email address when using the following calls: GetHighBidders, GetBidderList, GetAllBidders. Please see the Anonymization of Email Addresses in Member to Member Communication section in the 573 release notes for more information.
Starting in September 2008, GetMyMessages API changes will be made available for the Australia Site. Please see the GetMyMessages Returns More Data section of the 573 release notes for details about the changes.
Also starting in September 2008 on the Australia site, the AddMemberMessageAAQToBidder call can be used for all categories and is not limited to Motors and Business & Industrial categories only.
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 - 579.
Now you can set the DisplayNameInCheckout flag in CharityInfoType to display a nonprofit company name on the Review Your Purchase checkout page. If the user hovers the mouse over the nonprofit company name, the company's mission statement will be displayed. The value for the DisplayNameInCheckout field is returned with the GetCharities 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.
Starting in late August 2008, GetAttributesCS will start returning more item condition choices for US Media listings (Books, DVDs & Movies, Music, and Video Games).
At time of this writing, we expect to support the following value names and IDs for the Condition attribute (10244) in Media-related characteristic sets:
with the following exceptions:
In general, we are reusing the previous "New" (including "New in Box" and "New, Never Opened") value IDs for "Brand New", and the previous "Used" value IDs for "Acceptable". If you leave the item condition as unspecified for Media listings, we will also map it to "Acceptable". This means that if you are using the old conditions in your listing templates, they will still work. But the value names will be different on eBay and in GetItem (as described above). To help your sellers describe their items more accurately to buyers, we recommend that you use GetAttributesCS to get the latest values and to keep them up to date.
Please note that the LookupAttribute field in AddItem does not support the new condition values. You can only specify "New" or "Used". eBay will map those values to "Brand New" or "Acceptable" as appropriate.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 579 and Changed Functionality - 579.
None for this release.
Documentation Changes and Errata - 577
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 |
|---|---|---|
AdFormatLeadType.FirstName |
Entity | Removed |
AdFormatLeadType.LastName |
Entity | Removed |
AdFormatLeadType.Phone |
Entity | Removed |
AdFormatLeadType.Phone2 |
Entity | Removed |
ConfirmIdentityRequestType |
Complex type | New |
ConfirmIdentityResponseType |
Complex type | New |
CompleteSaleRequestType.OrderID |
Element | New |
SellerType.StoreSite |
Element | New |
GetReturnURL |
Call | Removed |
GetRuName |
Call | Removed |
SetReturnURL |
Call | Removed |
AuthenticationEntryType |
Complex type | Removed |
AuthenticationEntryArrayType |
Complex 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.
We have made several improvements to the User Token retrieval process, and made it even easier for developers to configure and maintain their application level settings.
New features of the token retrieval process include:
Enhanced User Consent Page: the User Consent Page now supports the ability for an application to upload their Application Name, Logo, Description, and URL for display to the end user on the User Consent Page. This improvement makes the User Consent Page more friendly to new users, and provides a way for users to find out more information about the application they are authorizing. For more information, please see http://developer.ebay.com/DevZone/XML/docs/WebHelp/GettingTokens-.html.
eBay UserID Verification Option: An ID Verification option has been added to the User Consent flow, for applications that only need to confirm an eBay UserID. This option is supported at the RuName level, and allows an application to confirm an eBay UserID by taking the user through the standard User Consent Flow [also known as the Auth & Auth flow]. The application can use the ConfirmIdentity call to verify the UserID that was provided at login time. For more information, please see http://developer.ebay.com/DevZone/XML/docs/WebHelp/GettingTokens-Getting_Tokens_for_Applications_with_Multiple_Users.html.
A new configuration tool is now available on developer.ebay.com for developers to view their stored user token, manage application level Platform Notification and Client Notification settings, and customize the User Consent Page. Please try out the new tool at https://developer.ebay.com/devzone/account/appsettings/ (requires login).
With the introduction of the improved token retrieval process, the following calls are deprecated: SetReturnURL, GetReturnURL, and GetRuName.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 577.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
You can now use the CompleteSale call to designate that a multiple-item order is complete. When an OrderID is used in the CompleteSaleRequest, ItemID and TransactionID are ignored by the call. The CompleteSale status applies to the order as well as to all of the child transactions of that order.
The AddMemberMessageAAQToPartner call could previously only be used after the end of an auction/sale, which made it difficult for sellers with GTC (Good 'Til Closed) listings. Now you can use this call to contact a buyer during the active listing.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 577 and Changed Functionality - 577.
The documentation for GetAdFormatLeads has been updated to reflect the actual call behavior with respect to returning phone numbers for leads. For request versions 561 and later, lead phone numbers, Phone and Phone2, are returned in AdFormatLead.Address. Similarly, FirstName and FirstName are returned in AdFormatLead.Address. Phone, Phone2, FirstName, and LastName in AdFormatLeadType have been deprecated.
The schema and documentation for GetUser have been updated to include StoreSite.
Documentation Changes and Errata - 575
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.