Trading API
The latest version of the Trading API has rolled out to all the API machines and is now available! Be sure to check out all the new features and known issues.
If you are getting started with the API, the following locations have information about joining the eBay Developers Program, creating test users, and other steps to getting your application certified to go live against the eBay production servers:
|
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
These release notes go back four quarters. For older release notes, see the Release Notes archive.
The lowest supported version is 941.
To learn how versioning works in the Trading API, see eBay's Schema Versioning Strategy.
Documentation Changes and Errata - 1201
For a current list of known issues, see Site Status Updates 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.
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 |
|---|---|---|
AccountDetailEntryCodeType.AdFeeExpress |
Enum | New |
AccountDetailEntryCodeType.AdFeeExpressCredit |
Field | New |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 1201.
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.
Two new enumeration values were added for GetAccount (in AccountDetailEntryCodeType) to account for the new Promoted Listing Express feature. The enumeration values include:
AdFeeExpressAdFeeExpressCreditSee these new values in AccountDetailEntryCodeType for more information.
The following new error messages that rolled out with the 1201 release:
21920297: Store Fixed Price format is no longer supported. The listing format has changed from Store Fixed Price to Basic Fixed Price.This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1201 and Changed Functionality - 1201.
Althougth the max length constraint value has always existed for the VariationTitle field, it was not documented until now. The maximum character length for this field is 120 characters. This field is returned in the response of the following calls for multiple-variation listings:
Documentation Changes and Errata - 1199
For a current list of known issues, see Site Status Updates 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.
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 API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 1199.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The maximum length of a Feedback comment has been increased to 500 characters. The table below summarizes the Trading API calls and fields to which this change applies:
| Call | Field | Input/Output? |
|---|---|---|
| GetFeedback | CommentText | Output |
| FeedbackResponse | Output | |
| Followup | Output | |
| LeaveFeedback | CommentText | Input |
| RespondToFeedback | ResponseText | Input |
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1199 and Changed Functionality - 1199.
None for this release.
Documentation Changes and Errata - 1197
For a current list of known issues, see Site Status Updates 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.
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 |
|---|---|---|
Category.SpecialFeatures |
Field | New |
SiteDefaults.SpecialFeatures |
Field | New |
None for this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 1197.
A new SpecialFeatures container was added to GetCategoryFeatures. This container will be returned if the user is searching for item condition values (by including and setting a FeatureID field to ConditionValues and the corresponding category supports special item conditions such as Certified Refurbished (Condition ID 2000). This item condition value will no longer be returned under the ConditionValues container.
A seller must be pre-qualified by eBay to list items with the Certified Refurbished condition.
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.
Below is the list of the new error messages that rolled out with the 1197 release:
21920269: Ignored duplicate Video Id(s).21920271: A listing can have maximum replaceable_value video(s).21920275: replaceable_value cannot be revised if the item has a bid or a best offer or is ending within 12 hours.21920276: replaceable_value cannot be revised if the item has a bid or a best Offer and is ending within 12 hours.21920298: VideoID(s) must contain only alphanumeric characters of length replaceable_value.21920299: VideoID(s) are not owned by the seller account.21920300: No Offline Payments selected for the site you are listing on or for the category selected.21920301: Offline payment must be selected for items that are priced at or higher than replaceable_value.21920304: You cannot publish this listing since your charity information is still being verified. This may take around 2-3 business days.21920305: Seller is not eligible to use Certified Refurbished condition either for this site or for the category selected.21920306: Certified Refurbished condition has been dropped from the item.These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1197 and Changed Functionality - 1197.
None for this release.
Documentation Changes and Errata - 1193
For a current list of known issues, see Site Status Updates 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.
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 |
|---|---|---|
FulfillmentType |
Type | New |
Program.Fulfillment |
Field | New |
ShippingServiceCostOverride.ShippingSurcharge |
Field | Removed |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 1193.
A new Fulfillment container will be returned in GetOrders, GetOrderTransactions, GetItemTransactions (to seller only), and GetSellerTransactions for paid orders being fulfilled by eBay or an eBay fulfillment partner.
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 all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified Refurbished', and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Condition ID 2500, 'Seller Refurbished' is the other option for sellers.
Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center.
The capability for sellers to create and maintain multiple domestic and international shipping rate tables has rolled out to the UK and Germany marketplaces. Prior to this, these sellers only had one 'default' domestic shipping rate table and one 'default' international shipping rate table.
In Add/Revise/Relist calls, a seller specifies the domestic and/or international shipping rate table to use for the listing through the ShippingDetails.RateTableDetails container.
Multiple shipping rate tables are now supported in the following marketplaces: US, Australia, Canada (English and French), Italy, UK, and Germany.
The ShippingServiceCostOverride.ShippingSurcharge has been removed from WSDL. This field was already not usable and was marked as deprecated. Sellers can only apply shipping surcharges to shipping service options through the Shipping rate tables tool in My eBay.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1193 and Changed Functionality - 1193.
None for this release.
Documentation Changes and Errata - 1189
For a current list of known issues, see Site Status Updates 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.
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 API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
All Selling Manager Pro calls are being deprecated. Selling Manager Pro calls will start being decommissioned beginning on June 1, 2021.
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 - 1189.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The following warning message was added:
21920296: PayPal email address, PayPal payment method and Item.PaymentDetails container have been removed from this Classified listing.
The existing 21916605 error message was updated to: Only single item quantity is permitted when the listing is in auction-style or under selected categories in FixedPrice format. Before the update, this error message text was not covering the fixed-price use case.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1189 and Changed Functionality - 1189.
The ShippingSurcharge field in ShippingServiceCostOverrideType marked as deprecated. Sellers can no longer directly apply shipping surcharges to listings through Add/Revise calls or through shipping business policies. Shipping surcharges can only be applied to shipping service options through the Shipping rate tables tool in My eBay.
Added a note to Item.eBayPlus field description about the field not being supported for Australian sellers. In Australia, eBay will evaluate/determine whether a listing is eligible for eBay Plus, and the seller has no control over setting the feature for a listing.
Documentation Changes and Errata - 1179
For a current list of known issues, see Site Status Updates 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.
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 API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
The GetPromotionalSaleDetails, SetPromotionalSaleListings, and SetPromotionalSale calls are being deprecated, and they will no longer be supported after March 31, 2021. eBay recommends that sellers use the Marketing API, which provides all Promotions Manager capabilities. The Marketing API will continue to be improved and enhanced as more marketing features become available to sellers.
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 - 1179.
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 - 1179 and Changed Functionality - 1179.
Some minor documentation updates were made to various type files.
Documentation Changes and Errata - 1177
For a current list of known issues, see Site Status Updates 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.
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 API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 1177.
New enumeration values were added to AuthenticityVerificationType. Values now account for order line items that fail authentication and are not able to be returned to the seller because of legal constraints, and for order line items that are passed with exception.
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.
Below is the list of updated error messages that rolled out with the 1177 release:
10122: Picture URL cannot contain semicolon.21920282: New Payment Terms of Use will soon be in effect. Please go to replaceable_value to accept the agreement.21920283: You need to accept the new Payment Terms of Use before you can create or revise listings. Please go to replaceable_value to accept the agreement.These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1177 and Changed Functionality - 1177.
None for this release.
Documentation Changes and Errata - 1173
For a current list of known issues, see Site Status Updates 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.
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 API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
The 2020 Fall Seller Update page was published. Below are some of the highlights:
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 - 1173.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
The currency of the listing fees returned under the Fees container in add/revise/relist calls will reflect the listing site's currency, and not necessarily the seller's default/home currency. Previously, the currency used for these listing fees was the seller's default/home currency even if that seller was listing on a site outside of their home country. This change affects the following calls:
Below is the list of the new error messages that rolled out with the 1173 release:
21920292: You cannot remove a SKU when Item InventoryTrackingMethod is set to SKU.21920293: This application is not permitted to update the eBay fulfillment flag.21920294: Picture URL cannot be a stock photo. replaceable_value picture URL(s) have been dropped.21920295: Picture URL cannot contain html or javascript content like ".cookie", ".location", "ebviewitem.", "showhelp", "showmodaldialog", "navigateandfind", "createpopup", "standardwrite", "writepersonalizedheader", "blockactivecontent".These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1173 and Changed Functionality - 1173.
None for this release.
Documentation Changes and Errata - 1169
For a current list of known issues, see Site Status Updates and the Knowledge Base.
No calls were added, modified, deprecated, or affected by documentation changes in this release.
There are no schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
The Quantity and StartPrice response fields in the InventoryStatusType are being deprecated, and they will no longer be supported after April 30, 2022. eBay has found that the values returned for these fields are not reliably accurate and recommends that the responses for these fields be ignored.
The Quantity and StartPrice request fields can still be used, and sellers can leverage the GetItem call to verify that the requested quantity and/or price updates were successful.
This deprecation affects the ReviseInventoryStatus call.
There are no new features in 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.
Error messages (21920285, 21920286, 21920287, 21920288, 21920290, and 21920291) were added to this release of the Trading API. Error message (80) was also updated. Below is the list of the new and updated error messages that rolled out with the 1169 release:
80: This site does not support Private Dutch Auction, Private Buy It Now Auction or Private Fixed Price listings.21920285: Quantity cannot be updated for items that are fulfilled by eBay.21920286: Items that are fulfilled by eBay do not allow these operations - Edit item SKU, Edit variation SKU, Add/Delete variations, Add/Delete variation specifics and Add/Delete variation pictures.21920287: SKU is required in every variation for items that are fulfilled by eBay.21920288: If your item sells for $10,000 or more, you agree to accept payment via Escrow.com and to allow eBay to amend your return policy to offer 7-day returns. Learn more at https://pages.ebay.com/escrow.21920290: eBay fulfillment cannot be applied to an item when there is a pending offer.21920291: Additional shipping cost was dropped from the listing either because it is not applicable or the quantity was set to <=1.These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1169 and Changed Functionality - 1169.
None for this release.
Documentation Changes and Errata - 1165
For a current list of known issues, see Site Status Updates 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.
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 |
|---|---|---|
AuthenticityVerificationType |
Type | New |
TransactionProgramType |
Type | New |
Transaction.Program |
Field | New |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
The ReviseSellingManagerSaleRecord call is being deprecated. No new features and/or fields will be added to ReviseSellingManagerSaleRecord, and it will no longer be supported after March 30, 2021. eBay recommends that sellers use the CompleteSale Trading API call to mark orders as paid, mark orders as shipped, and provide shipment tracking details.
The GetCategorySpecifics call is being deprecated. No new features and/or fields will be added to GetCategorySpecifics, and it will no longer be supported after January 31, 2022. eBay recommends that large sellers and developers make plans to migrate to the Taxonomy API RESTful methods.
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 - 1165.
A new Program container is returned for orders subject to the Authenticity Guarantee service program. With the Authenticity Guarantee service program, some high-value items in specific categories, like luxury watches or handbags, must be authenticated by a third-party authenticator before being sent to the buyer.
This program is initially only available to a select number of sellers, but this program will eventually become applicable and required for all sellers selling specific items in specific categories.
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.
Error message (21920283) and Warning (21920282) were added as part of the User Agreement Service v2 integration to inform seller about Payments Terms of Use (PTOU). Other messages were also updated. Below is the list of the new and updated error messages that rolled out with the 1165 release:
715: Invalid value provided for Weight Minor. Enter a value between replaceable_value and replaceable_value replaceable_value.21916962: The postage cost will be calculated based on dimensional weight, not the actual weight of your package. Please check the weight and dimensions of your package.21916963: The dimensional weight of your package exceeds the weight limit for the shipping service you selected. Please check the dimensions of your package.21920282: A new User Agreement will soon be in effect. Please go to replaceable_value to accept the agreement.21920283: A new User Agreement is in effect and needs to be signed before you can create or revise listings. Please go to replaceable_value to accept the agreement.These error and warning messages can be viewed in the Errors By Number page.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1165 and Changed Functionality - 1165.
None for this release.
Documentation Changes and Errata - 1161
For a current list of known issues, see Site Status Updates 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.
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 |
|---|---|---|
RelevanceIndicatorType |
Type | New |
NameRecommendation.RelevanceIndicator |
Field | New |
Item.ListingDesigner |
Field | Removed |
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
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 - 1161.
A new RelevanceIndicator container is returned in GetCategorySpecifics for item specifics if eBay has data on how many searches have been performed for listings in a specific category using that item specific.
'Buyer Demand Data' is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to 'Buyer Demand Data' in GetCategorySpecifics.
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.
Platform Notifications will no longer be delivered to non-secure servers/URLs that use the 'http' protocol. Any specified URL must use the 'https' protocol. This means that any URLs specified in the ApplicationDeliveryPreferences.ApplicationURL and DeliveryURLDetails.DeliveryURL fields of the SetNotificationPreferences call must use the 'https' protocol.
The GetNotificationPreferences call may be used to view the current URLs to check if they are using the 'https' protocol.
The calculation of the Final Value Fee is changing for managed payments sellers, so the value returned in the FinalValueFee fields for each order line item in order management call responses should only be considered as estimated values. The getTransactions method of the Finances API can be used to get accurate Final Value Fee values.
See the Selling fees for managed payments sellers help page for more information about how Final Value Fees are changing for managed payments sellers.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1161 and Changed Functionality - 1161.
The retiring of Listing Designer templates was already announced with Version 1157, but now the ListingDesigner field in ItemType has been removed from the 1161 Version of the WSDL. Existing listings that are already using a Listing Designer template will remain unchanged. If a seller tries to use a Listing Designer template using the ListingDesigner container, it will have no effect on the listing, but the seller will receive a warning message about Listing Designer templates no longer being available.
Copyright © 2005–2021 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.