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 - 1055
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 |
|---|---|---|
URLTypeCodeType.CreateProductUrl |
Enum | New |
URLTypeCodeType.AppealProductUrl |
Enum | New |
URLTypeCodeType.ManageProductUrl |
Enum | 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 - 1055.
The following three new enumeration types were added to URLTypeCodeType: CreateProductUrl, AppealProductUrl, and CreateProductUrl. These URLs will be returned under the URLDetails container of the GeteBayDetails response if one of the DetailName values in the GeteBayDetails request is URLDetails, or if no DetailName values are specified.
Different base URLs will be returned depending on whether you call GeteBayDetails in Sandbox or Production environment. As of April 2018, these URLs and the create/revise/manage catalog change request flows are only available in the Sandbox environment. These URLs and the create/revise/manage catalog change request flows will become available in the Production environment in August 2018 with the launch of Product-Based Shopping Experience Phase 2. See the URLTypeCodeType definition for more information on these three URLs, and see the Product-Based Shopping Experience landing page for more information on Product-Based Shopping Experience Phase 2.
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 - 1055 and Changed Functionality - 1055.
None for this release.
Documentation Changes and Errata - 1049
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 Product-Based Shopping Experience Playbook has been updated, has been moved to the Selling Integration Guide.
The ProductRequired field in the GetCategorySpecifics response will start getting returned in the Production environment for categories/brands that will require an association with an eBay catalog product. This field is only returned for the 'Brand' NameRecommendation container. Previously, this field was only wired on in the Sandbox environment.
If a product brand within an eBay category requires an eBay catalog product, the seller will have to associate the listing with an eBay catalog product when creating/revising a listing. To do this, an eBay Product ID (ePID) is passed into the ProductListingDetails.ProductReferenceID field when using the Add/Revise calls of the Trading API, or an ePID must be passed into the product.epid field when using the createOrReplaceInventoryItem call of the Inventory API.
Through 'Phase 1' of the Product-Based Shopping Experience requirement, scheduled to start being enforced in May 2018, this field will only be returned if Enabled for the product brand. However, with 'Phase 2' of the Product-Based Shopping Experience requirement, scheduled to start being enforced in August 2018, this field will get returned (whether it is Enabled or Disabled) for all product brands if the requirement applies to the eBay category. In 'Phase 2', the seller will have to call GetCategoryFeatures first to see if the requirement applies to the category, and if it does, then the seller will have to call GetCategorySpecifics to see if the requirement applies to the product brand within the category. For more information about Product-Based Shopping Experience requirements, see the Product-Based Shopping Experience Playbook.
The 2018 Spring Seller Update has been published. Please see this document for information on the following enhancements/changes:
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 - 1049.
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.
For sellers who are eligible and opted in to the 'Click and Collect' program, this feature can only be set at the seller's account level, and cannot be set at the listing level. If this option is turned on at the account level, each individual listing must be evaluated for 'Click and Collect' eligibility. This feature is only available to sellers on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
This means that the the EligibleForPickupDropOff field in the PickupInStoreDetails container should no longer be set in an Add/Revise/Relist/Verify listing call, and if this field is included, it will have no functional affect on the listing.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1049 and Changed Functionality - 1049.
For all 'Click and Collect' related fields in the Trading API, a note was added about sellers only being able to enable the Click and Collect feature at the account level, and then each individual listing within a Click and Collect-enabled category must be evaluated for eligibility.
Documentation Changes and Errata - 1047
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 |
|---|---|---|
ProductRequiredCodeType |
Type | New |
RecommendationValidationRulesType.ProductRequired |
Element | 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 - 1047.
A new ProductRequired field will start getting returned in GetCategorySpecifics. This field will only returned for the 'Brand' NameRecommendation container, and only for eBay categories where the Product-Based Commerce mandate applies. Currently, this field is only wired on in the Sandbox environment, but it will be wired on in Production later in March 2018.
If a product brand within an eBay category requires an eBay catalog product, the seller will have to associate the listing with an eBay catalog product when creating/revising a listing. To do this, an eBay Product ID (ePID) is passed into the ProductListingDetails.ProductReferenceID field when using the Add/Revise calls of the Trading API, or an ePID must be passed into the product.epid field when using the createOrReplaceInventoryItem call of the Inventory API.
Through 'Wave 1' of the Product-Based Commerce mandate, scheduled to start being enforced in May 2018, this field will only be returned if Enabled for the product brand. However, with 'Phase 2' of the Product-Based Commerce mandate, scheduled to start being enforced in August 2018, this field will get returned (whether it is Enabled or Disabled) for all product brands if the mandate applies to the eBay category. In 'Phase 2', the seller will have to call GetCategoryFeatures first to see if the mandate applies to the category, and if it does, then the seller will have to call GetCategorySpecifics to see if the mandate applies to the product brand within the category. For more information about Product-Based Shopping Experience requirments, see the Product-Based Shopping Experience Playbook.
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.
A note was added to the ProductListingDetails.IncludeeBayProductDetails field description that states that this boolean field cannot be set to false if the eBay category and product is part of Product-Based Commerce mandate. If the eBay category and product is part of the mandate and this field is included and set to false, an Add/Revise/Relist/Verify call will fail.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1047 and Changed Functionality - 1047.
A note was added to the PlaceOffer documentation about the call not supporting the purchase of items where the immediate payment option is set on the listing.
Documentation Changes and Errata - 1045
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 |
|---|---|---|
ItemType.PrivateListing |
Element | 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.
A new Product-Based Shopping Experience Playbook is now available. This playbook discusses the eBay categories and product brands that will start requiring an eBay catalog product when listing/revising a product. It also discusses what developers/sellers need to do to prepare/integrate with this mandate in 2018. In 2018, this mandate will only apply to US, UK, AU, and CA (English) sites, but this mandate will start rolling out to other sites in 2019 and beyond.
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 - 1045.
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 PrivateListing field has been deprecated and removed from the WSDL with Version 1045. It should no longer be used in Add/Revise/Relist/Verify calls. This field will still get returned in 'Get' calls until it is fully wired off around July 2019.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1045 and Changed Functionality - 1045.
The ProductListingDetails.NameValueList container used in Add/Revise/Relist calls has been removed from the Call Reference docs. Although this container was added in Version 997, it was never wired on. This container should not be used.
The Recommendations.ProductIdentifiers container has been removed from the Call Reference docs. Although this container was added in Version 997, it was never wired on and never returned in the GetCategorySpecifics. This container should not be used.
Documentation Changes and Errata - 1039
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 |
|---|---|---|
ItemType.IsSecureDescription |
Element | 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 - 1039.
A new boolean field named IsSecureDescription was added to ItemType. This boolean field is returned in GetItem and other 'Get' calls to indicate whether or not the listing description for an eBay listing is HTTPS secure/compliant. To be HTTPS secure/compliant, the listing description field may not contain any links to site pages that use the HTTP (and not HTTPS) protocol.
This field will be returned for the following calls:
If an eBay listing is not HTTPS compliant, the seller may want to revise the listing, removing any and all links to HTTP pages. For more information about why eBay made this change, please see the Policy Updates page of the Fall 2017 Seller Updates page.
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.
Once a seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId fields of the RateTableDetails container in an Add/Revise/Relist call, and the DomesticRateTable and InternationalRateTable tags will no longer work. The unique identifiers for all shipping rate tables defined for a seller's account can be retrieved with the getRateTables method of the Account API.
The seller can also apply domestic and international to a shipping business policy and then apply this business policy to the listing through the SellerProfiles.SellerShippingProfile container. Shipping business policies can be created and managed with the Account API.
Shipping rate tables are currently only available for US, Australia, UK, and Germany sites.
For US and Canada sellers charging a restocking fee for non-SNAD returns, the seller can now use the Percent_20 value in the ReturnPolicy.RestockingFeeValueOption to reserve the right to charge a restocking fee percentage for returned items of up to 20 percent (of sale price), but at the seller's discretion, they can also charge less than 20 percent.
The seller can also set a restocking fee in a return business policy and then apply this business policy to the listing through the SellerProfiles.SellerReturnProfile container. Business policies can be created and managed with the Account API.
The maximum number of Item Specifics returned in the response of the GetCategorySpecifics call has been increased from 15 to 25. The caller can control how many Item Specifics are returned by setting the MaxNames value in the GetCategorySpecifics call request. If the MaxNames field is omitted, its value defaults to 25, and up to 25 Item Specifics are returned for that category.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1039 and Changed Functionality - 1039.
A general documentation cleanup was performed for numerous Trading type definitions.
Documentation Changes and Errata - 1035
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.
No changed 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 eBay Guaranteed Delivery feature has rolled out to the US site. Eligible sellers must opt in to this program. This feature will allow buyers to select items that are guaranteed to be delivered in 1 day, 2 days, 3 days, or 4 days. For general information about this feature, see the Fall 2017 Seller Update. For sellers looking for more technical information on how to integrate with and enabled eBay Guaranteed Delivery through eBay APIs, see the API Integration Playbook for eBay Guaranteed Delivery document.
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 - 1035.
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.
With the rollout of eBay Guaranteed Delivery, the maximun number of combined domestic and international shipping rate tables has increased from 20 to 40. Shipping rate tables are required for sellers using the Door-to-Door Option of eBay Guaranteed Delivery, and these tables are used to define shipping cost and delivery times for specific regions and for the different shipping speed categories (Overnight, Expedited, Standard, Economy).
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1035 and Changed Functionality - 1035.
Although it is not returned in GetOrders, the PrivateNotes field was erroneously appearing in the GetOrders Call Reference documentation. It has been removed in the 1035 Version of the document.
Although it is returned in GetMyeBaySelling, the PaymentProfileID field was erroneously missing from the GetMyeBaySelling Call Reference documentation. It has been added in the 1035 Version of the document.
A general documentation cleanup was performed for several calls and type docs.
Documentation Changes and Errata - 1033
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.
No changed 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 eBay Guaranteed Delivery feature is set to roll out in October 2017. Eligible sellers must opt in to this program. This feature will allow buyers to select items that are guaranteed to be delivered in 1 day, 2 days, 3 days, or 4 days. For general information about this feature, see the Fall 2017 Seller Update. For sellers looking for more technical information on how to integrate with and enabled eBay Guaranteed Delivery through eBay APIs, see the API Integration Playbook for eBay Guaranteed Delivery document.
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 - 1033.
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 - 1033 and Changed Functionality - 1033.
None for this release.
Documentation Changes and Errata - 1031
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.
See the 2017 Fall Seller Update for information about upcoming selling changes, including the eBay Guaranteed Delivery feature, integration of Markdown Manager into Seller Hub, new Q&A feature on product pages, information on eBay policy updates, and updates to Returns.
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 - 1031.
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.
With Trading WSDL Version 1031, the InsuranceDetailsType has been removed. This type was used by the InsuranceDetails and InternationalInsuranceDetails containers in Add/Revise/Relist/Verify calls for sellers to offer shipping insurance to buyers on any eBay site. This feature is no longer applicable/supported on any eBay sites.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1031 and Changed Functionality - 1031.
Although the SellerProfiles container has always been returned by 'Get' calls like GetItem since Business Policies have been supported by the Trading API, this container was missing in the Call Reference pages for the 'Get' calls. This container now appears in the Call Reference pages for the following calls:
In the ShippingTimeMax and ShippingTimeMin fields of ShippingServiceDetails, ShippingServiceOptionsType, and MultiLegShipmentType, it was clarified that the shipping times are based on business days only. For ShippingServiceDetails (returned in the GeteBayDetails call), it was also stated that the seller should look at the ShippingTimeMax value for a shipping service when setting up a listing for eBay Guaranteed Delivery. With eBay Guaranteed Delivery, becoming available in October 2017, the seller's handling time and the shipping time must be four days or less.
Documentation Changes and Errata - 1029
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.
Starting on September 1, 2017, sellers will no longer be able to list and buyers will no longer be able to buy on Half.com. Beginnning on this date, Half.com will redirect to eBay.com. Returns and refunds for Half.com listings will continue to be processed until October 31, 2017. Half.com users will still have access to their My Account Page until November 30, 2017. For more information on this change, please see the Half.com Closing FAQ page.
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 - 1029.
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.
Gift Services and the Gift Icon (in listings) are no longer supported on any eBay Marketplace sites. This means that the Item.GiftServices and Item.GiftIcon fields should no longer be used in Add/Revise/Relist/Verify calls.
The following listing enhancements are no longer supported on any eBay Marketplace sites. This means that the enumeration values associated with this listing enhancements should no longer be passed in through the Item.ListingEnhancement field. Here are the deprecated listing enhancements along with their associated enumeration values:
BasicUpgradePackBundle)Border)Featured)Highlight)ProPackBundle)ProPackPlusBundle)This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1029 and Changed Functionality - 1029.
None for this release.
Documentation Changes and Errata - 1027
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.
Beginning on August 31, 2017, API support for Half.com listings is being fully deprecated. For a full list of API calls, types, fields, and enumeration values affected by this change, see the Documentation Changes and Errata section.
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 - 1027.
Beginning with Version 1027, sellers on the US, UK, and DE sites can offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both features.
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 - 1027 and Changed Functionality - 1027.
Beginning on August 31, 2017, API support for Half.com listings is being fully deprecated. This section will discuss the full list of API calls, types, fields, and enumeration values affected by this change.
The following Trading API calls are exclusively for Half.com listings, and these calls will no longer function beyond August 31:
The following Trading API types are exclusively for Half.com listings, and these types will no longer be applicable beyond August 31:
The following Trading API fields and enumeration values are exclusively for Half.com listings, and these fields/values will no longer be applicable beyond August 31:
Half enumeration value of ListingTypeCodeTypeShipped enumeration value of OrderStatusCodeTypeHalf enumeration value of TransactionPlatformCodeTypeCreditCardVerifyHalfOptIn and UnconfirmedHalfOptIn enumeration values of UserStatusCodeTypeDocumentation Changes and Errata - 1025
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 |
|---|---|---|
MembershipDetailsType |
Type | New |
MembershipDetailType |
Type | New |
UserType.Membership |
Element | 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.
Beginning with Version 1027, sellers on the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. Once this new capability rolls out, the seller can offer Buy It Now or Best Offer in an auction listing, but not both.
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 - 1025.
If a seller is enrolled in one or more membership programs, such as eBay Plus, a Membership container will be returned in the GetUser call. This Membership container will provide details about the seller's membership, including the applicable eBay site and the membership expiration date.
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 - 1025 and Changed Functionality - 1025.
All applicable Best Offer calls, fields, and feature guide documentation was updated to reflect the fact that Best Offers will soon be available for auction listings on the US, UK, and DE sites.
Copyright © 2005–2017 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.