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 - 1111
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 |
|---|---|---|
UsageConstraintCodeType |
Type | New |
ValidationRules.UsageConstraint |
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 - 1111.
The NameRecommendation.ValidationRules.UsageConstraint field was added to the GetCategorySpecifics response to indicate whether the item specific is required, recommended, or optional. Previously, returned item specifics were only 'marked' as required or optional. With the introduction of this new field, eBay is able to specify to sellers which item specifics are highly recommended, although not required. The item specifics that are recommended can possibly improve search results and/or sales conversion.
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 - 1111 and Changed Functionality - 1111.
None for this release.
Documentation Changes and Errata - 1107
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 |
|---|---|---|
OrderType.OrderLineItemCount |
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 - 1107.
New OrderLineItemCount field added to OrderType. This field will indicate the total number of line items in an order. This field will be returned under the ContainingOrder container of the GetItemTransactions or GetSellerTransactions calls. In order for the ContainingOrder container to be returned, a user must include the IncludeContainingOrder field in the call request and set its value to true.
This field has yet to be wired on, so will not be currently returned in any circumstance. However, once this field is wired on, the user must be using Version 1107 of the Trading WSDL (or newer, as versions roll out), and the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value must be set to '1113' in order to see this field in the response.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Starting in June 2019, eBay will start changing the format of order identifier values. The new format will be a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.
During the transition period, developers/sellers will use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in all Trading API call response payloads. The compatibility version is expected to be Version 1113. During the transition period and even after, the new and old OrderID formats will still be supported in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
You can read more about this change in the Spring 2019 Seller Updates.
Starting July 1, 2019, the Good 'Til Cancelled renewal schedule will be modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). You can read more about this change in the Spring 2019 Seller Updates.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1107 and Changed Functionality - 1107.
The occurrence value of the CityName field of AddressType was incorrectly stated as 'Always' being returned. This was not correct, and the occurrence value was changed to 'Conditionally' returned instead. Although most addresses include a city name, some do not. For example, Singapore is an island city-state, and the CityName field would not be applicable to any address in Singapore.
For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. The Buyer.Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.
Documentation Changes and Errata - 1101
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.HighlineSearchFee |
Enum | New |
AccountDetailEntryCodeType.HighlineSearchFeeCredit |
Enum | New |
AccountDetailEntryCodeType.SnadOutlierFinalValueFee |
Enum | New |
AccountDetailEntryCodeType.SnadOutlierFinalValueFeeCredit |
Enum | New |
AccountDetailEntryCodeType.SnadOutlierFinalValueFeeOnShipping |
Enum | New |
AccountDetailEntryCodeType.SnadOutlierFinalValueFeeOnShippingCredit |
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.
Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories (and brands within those categories), sellers will no longer be required to associate an eBay catalog product to the listing in any categories. Although the mandate has been rolled back, it can still be very useful to sellers (and buyers searching for their items) if a listing is associated with an eBay catalog product, if one is available for their product. Sellers can use the the search operation in the Catalog API or the FindProducts call in the Shopping API to search for matching eBay catalog products. If a matching product is found, the seller will need the catalog product's eBay Product Identifier (ePID) value when they list their item. The ePID value will be passed in to the ProductListingDetails.ProductReferenceID when using the AddItem call.
Due to this rollback, sellers will no longer need to use GetCategoryFeatures to see if a listing category requires association with an eBay catalog product, nor will they need to use GetCategorySpecifics to see if a product brand within a listing category requires association with an eBay catalog product.
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 - 1101.
Six new enumeration values were added to AccountDetailEntryCodeType to account for the three new charges (and three corresponding credits). These three sets of charges/credits are summarized below:
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 opted in to the eBay Managed Payments program, the enumeration value returned in the Transaction.Status.PaymentMethodUsed field will be CreditCard, regardless of the actual payment method used by the buyer to pay for the order.
Similarly, if a seller wants/needs to pass a payment method in when using the AddOrder or SendInvoice calls, a seller opted in to eBay Managed Payments should only pass a value of CreditCard into the Order.PaymentMethods and PaymentMethods fields, respectively.
eBay Managed Payments is currently only available to a limited number of sellers on the US site. For sellers in the eBay Managed Payments program, a payment method does not need to be specified at listing/checkout time.
For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for a user's address, the AddressID field returned for a shipping address will also contain the last two digits of the user's Australian Business Number (ABN), if applicable. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site.
The three catalog change request URLs (CreateProductUrl, AppealProductUrl, or ManageProductUrl) will no longer be returned in the URLDetails.URLType field of GeteBayDetails since catalog change requests through the UI flow are currently not available.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1101 and Changed Functionality - 1101.
Numerous documentation updates and notes were made in type documentation to account for recent changes related to eBay Managed Payments and the rollback of the Product-Based Shopping Experience mandate.
Documentation Changes and Errata - 1099
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 March 18, 2019 on North American (US and Canada) and all Asian eBay sites, and followed shortly after (around April 1) on all European sites, the only supported listing duration for all new fixed-price listings will be Good 'Til Cancelled (GTC). Existing fixed-price listings with non-GTC durations will not be affected until it becomes time for the seller to relist that item, in which case the seller will have to relist it with the GTC listing duration.
As soon as this change rolls out, only the GTC enumeration value will be accepted in the Item.ListingDuration field of an Add/Revise/Relist/Verify listing call. Any other value that is passed into this field will be ignored, and the listing duration will be set to GTC automatically. The metadata in the GetCategoryFeatures call response will be updated to reflect this change. When using GetCategoryFeatures to retrieve supported listing durations for different listing types and categories for a particular eBay site, the seller includes the FeatureID field in the response and sets its value to ListingDurations.
Beginning May 1, 2019, eBay will no longer support electronic payments through a seller's Integrated Merchant Credit Card account. To accept online credit card payments from buyers, a seller must either specify PayPal as an accepted payment method, or opt in to the eBay Managed Payments program (currently only available to sellers in US).
Once this change takes affect, if IMCC is passed in as a value in an Item.PaymentMethods field of an Add/Revise/Relist call, this value will be ignored and dropped (and listing will possibly get blocked if IMCC is the only specified payment method). Once a seller is opted in to eBay Managed Payments, no Item.PaymentMethods values will need to be specified as eBay controls the accepted payment methods for each marketplace.
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 - 1099.
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 number of item specifics that may be defined for a listing has increased from 30 to 45. In Add/Revise/Relist calls, item specific name-value pairs are specified through the ItemSpecifics.NameValueList container.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1099 and Changed Functionality - 1099.
Numerous documentation improvements were made for this release.
Documentation Changes and Errata - 1095
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 in mid-March 2019 on North American (US and Canada) and all Asian eBay sites, and followed shortly after (around April 1) on all European sites, the only supported listing duration for all new fixed-price listings will be Good 'Til Cancelled (GTC). Existing fixed-price listings with non-GTC durations will not be affected until it becomes time for the seller to relist that item, in which case the seller will have to relist it with the GTC listing duration.
GTC listings renew automatically every 30 days as long as the listing is showing quantity available (1 or more), an insertion fee may be charged for each 30-day period in which the listing is renewed. With GTC listings, it may also be a good idea to take advantage of the out-of-stock feature. With the out-of-stock feature, your fixed-price listing will retain its purchase and search history, but will display to potential buyers as being 'out of stock' if the quantity reaches 0. Then, the seller will just have to revise their listing with more inventory to make purchases possible again. The out-of-stock feature is set in My eBay Selling Preferences.
As soon as this change rolls out, only the GTC enumeration value will be accepted in the Item.ListingDuration field of an Add/Revise/Relist/Verify listing call. Any other value that is passed into this field will be ignored, and the listing duration will be set to GTC automatically. The metadata in the GetCategoryFeatures call response will be updated to reflect this change. When using GetCategoryFeatures to retrieve supported listing durations for different listing types and categories for a particular eBay site, the seller includes the FeatureID field in the response and sets its value to ListingDurations.
Beginning May 1, 2019, eBay will no longer support electronic payments through a seller's Integrated Merchant Credit Card account. To accept online credit card payments from buyers, a seller must either specify PayPal as an accepted payment method, or opt in to the eBay Managed Payments program (currently only available to sellers in US).
Once this change takes affect, if IMCC is passed in as a value in an Item.PaymentMethods field of an Add/Revise/Relist call, this value will be ignored and dropped (and listing will possibly get blocked if IMCC is the only specified payment method). Once a seller is opted in to eBay Managed Payments, no Item.PaymentMethods values will need to be specified as eBay controls the accepted payment methods for each marketplace.
The 2019 Early Seller Update is now available. Seller updates generally affect all or most sellers, but generally aren't specific to sellers and developers using the public APIs. This update covers the following topics:
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 - 1095.
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 only supported listing duration for all new fixed-price listings on the eBay Australia site is Good 'Til Cancelled (GTC). Existing fixed-price listings with non-GTC durations will not be affected until it becomes time for the seller to relist that item, in which case the seller will have to relist it with the GTC listing duration.
With this change, only the GTC enumeration value will be accepted in the Item.ListingDuration field of an Add/Revise/Relist/Verify listing call. Any other value that is passed into this field will be ignored, and the listing duration will be set to GTC automatically. The metadata in the GetCategoryFeatures call response has been updated to reflect this change to fixed-price listings.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1095 and Changed Functionality - 1095.
Added a note in the PictureDetails.PictureURL field about the 500 pixels requirement for all listing photos. With this requirement, all photos being added to a listing must be at least 500 pixels on its longest side. Any photos that do not meet this requirement will not be published to the listing.
Documentation Changes and Errata - 1091
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 |
|---|---|---|
Item.MotorsGermanySearchable |
Field | Deprecated |
Item.ShippingTermsInDescription |
Field | Deprecated |
Seller.MotorsDealer |
Field | Deprecated |
SellerContactDetails.Phone2CountryCode |
Field | Deprecated |
SellerContactDetails.Phone2CountryPrefix |
Field | Deprecated |
SellerContactDetails.Phone2AreaOrCityCode |
Field | Deprecated |
SellerContactDetails.Phone2LocalNumber |
Field | Deprecated |
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 - 1091.
Previously, beginning with Version 1027, sellers on the US, UK, and DE sites gained the capability to accept Best Offers on auction listings. This capability is now also available to sellers on Canada sites (English and French), and to the eBay marketplaces in Australia, France, Italy, and Spain.
Sellers using auctions must choose between using the Best Offer or Buy It Now feature, as both features cannot be enabled on the same auction listing. If an auction listing is enabled with Best Offer, this feature will no longer be applicable once the listing receives its first qualifying bid.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Sellers accepting Best Offers for an auction listing can now set the Best Offer Auto Reject threshold price (Item.ListingDetails.MinimumBestOfferPrice) to a dollar value higher than the auction starting price (Item.StartPrice).
Best Offers in auction listings are available to sellers on the US, Canada, UK, Germany, Australia, France, Italy, and Spain sites. Note that the Best Offer feature in auction listings is no longer applicable once the listing receives its first qualifying bid.
Previously, sellers using the Add/Revise/Relist calls had to include the CategoryMappingAllowed field and set its value to true. Now, eBay will do category mapping automatically (CategoryMappingAllowed field defaults to true instead of false, so sellers can now just omit the CategoryMappingAllowed field in an Add/Revise/Relist call.
With category mapping, eBay will automatically 'map' or 're-route' and outdated/deprecated Category ID to the updated/correct Category ID. The primary Category ID is specified in Add/Revise/Relist calls in the PrimaryCategory.CategoryID field, and the secondary listing category (if used) is specified in Add/Revise/Relist calls in the SecondaryCategory.CategoryID field. And if eBay does category mapping, the new Category IDs will appear in the response of a successful Add/Revise/Relist call.
The following fields under the SellerContactDetails container in an Add/Revise/Relist call have been deprecated since adding a secondary contact number is no longer supported for Classified Ad listings. If any of these fields are included in an Add/Revise/Relist call, they will be ignored:
The following two eBay Motors-related fields were deprecated. Previously, both of these boolean fields were set through an Add/Revise/Relist call.
The Item.ShippingTermsInDescription field used in Add/Revise/Relist calls is deprecated. If this field is included in an Add/Revise/Relist call, it will be ignored.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1091 and Changed Functionality - 1091.
None for this release.
Documentation Changes and Errata - 1085
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.
For sellers enrolled in the new eBay Managed Payments program, a specified payment method is not necessary. If a payment method is specified in the API call itself, or through an associated Payment Business Policy, it will be dropped from the listing and the seller will get a warning message when the call is run.
Sellers in the new eBay Managed Payments program can also enable the immediate payment feature by including the Item.AutoPay field in an Add/Revise/Relist call and setting its value to true.
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 - 1085.
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 - 1085 and Changed Functionality - 1085.
Provided a little more detail to the 'eBay Collect and Remit Tax' field descriptions and added links to the Australian 'Good and Service Tax' and US Sales Tax Collection help topics. Currently, there are five US states that will start collecting sales tax from buyers (through eBay) in 2019, starting with Minnesota and Washington in January, 2019. See the eBay sales tax collection help topic for more information.
Provided a note in the SetTaxTable/GetTaxTable calls and in the SalesTax container fields (in listing calls) about sales tax settings being ignored by eBay if an item is sold to a buyer in a US state that is applicable to the 'eBay Collect and Remit Tax' feature. Currently, there are five US states that will start collecting sales tax from buyers (through eBay) in 2019, starting with Minnesota and Washington in January, 2019. See the eBay sales tax collection help topic for more information.
Highlighted the fact that a seller selling a product with a UPC value on a European eBay site should pass this UPC value into the ProductListingDetails.EAN or VariationProductListingDetails.EAN field, and a seller selling a product with an EAN value on the US eBay site should pass this EAN value into the ProductListingDetails.EAN or VariationProductListingDetails.EAN field.
Updated field description to tell users to use whole numbers (and not decimals) in the WeightMajor and WeightMinor fields to specify shipping package weight. Also provided samples in these two fields to show how different weight should be specified. So, if a package weighed 2 pounds, and 4.7 ounces, the ounces should be rounded up to '5', so it would be expressed as follows:
<WeightMajor>2</WeightMajor>
<WeightMinor>5</WeightMinor>
Cleaned up the enumerated type documentation to indicate which enumeration values can be used as filters in the GetOrders call request, and which values are only applicable to the reponse of GetOrders (and other order management calls). One big change is that the Cancelled value is used in the GetOrders request (and not CancelPending) to see orders with pending or completed cancellation requests.
Provided an example of an actual ExtendedOrderID value and added note that these values are used in the Post-Order and Fulfillment APIs to retrieve orders.
Documentation Changes and Errata - 1081
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.
Regional shipping rate tables have been enabled for the following sites: Canada (English), Canada (French), and Italy. With regional shipping rate tables, the seller can customize and set the shipping rates based on shipping speed (One-Day, Expedited, Standard, Economy) and distance to specified domestic regions. Regional shipping rate tables are required for sellers opted into the eBay Guaranteed Delivery feature and using the 'Door-to-Door' option.
In Add/Revise/Relist calls, a domestic shipping rate table can be applied to a listing by using the DomesticRateTableId field. The unique identifiers of shipping rate tables can be found by using the getRateTables method of the Account API, or these identifiers can be viewed in the browser's URL field when a specific rate table is selected.
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 - 1081.
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.
Sellers can now select a 30-day listing duration for eBay Motors listings. The 30-day listing duration will replace the 21-day listing duration, a duration time that will soon be wired off for eBay Motors listings.
In Add/Revise/Relist calls, the listing duration is set with the ListingDuration field, and Days_30 is used for a 30-day listing duration.
The CategoryBasedAttributesPrefill field is no longer applicable, has no affect, and has been removed from the WSDL as of Version 1081. It should no longer be used in Add/Revise/Relist/Verify calls. If this field is used, a warning will be triggered when the call is executed.
A seller can now disable any charitable donation that is set up for a listing by using the DeletedField in a Revise call, and passing in the string value, Item.Charity. The charitable donation feature cannot be disabled for an auction listing if there are any active bids on the listing, and it cannot be disabled if there are any pending Best Offers/Counter Offers on a listing.
Similarly, the non-profit organization and donation percentage in an active listing can now be modified in a Revise call, as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing. To revise the non-profit organization and/or donation percentage, the CharityID and/or DonationPercent fields are used.
A seller can now use the ReviseFixedPriceItem call to delete a variation in a multiple-variation listing, even if that variation still has quantity and/or has had one or more previous sales during the life of the listing. The Variation.Delete boolean field is used to delete the variation. Previously, if a variation had any purchases, you could not delete the variation, but only set its quantity to zero.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1081 and Changed Functionality - 1081.
The maximum length of the PaymentInstructions field (in ShippingDetails container) was inaccurately documented as 1000, when the actual maximum length is actually 500 characters. This field can be used in Add/Revise/Relist calls, and is also returned in order management calls when set on the listing.
Sellers can no longer offer shipping insurance and product warranties to buyers through API flows, so all types and fields related to shipping insurance and product warranties have been marked as deprecated, but have not been completely removed from the public WSDL yet.
Documentation Changes and Errata - 1077
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 |
|---|---|---|
| Return Policy Updates | ||
Category.DomesticReturnsAcceptedValues |
Field | New |
Category.DomesticReturnsDurationValues |
Field | New |
Category.DomesticReturnsShipmentPayeeValues |
Field | New |
Category.DomesticRefundMethodValues |
Field | New |
Category.InternationalReturnsAcceptedValues |
Field | New |
Category.InternationalReturnsDurationValues |
Field | New |
Category.InternationalReturnsShipmentPayeeValues |
Field | New |
Category.InternationalRefundMethodValues |
Field | New |
Category.ReturnPolicyDescriptionEnabled |
Field | New |
FeatureDefinitions.DomesticReturnsAcceptedValues |
Field | New |
FeatureDefinitions.DomesticReturnsDurationValues |
Field | New |
FeatureDefinitions.DomesticReturnsShipmentPayeeValues |
Field | New |
FeatureDefinitions.DomesticRefundMethodValues |
Field | New |
FeatureDefinitions.InternationalReturnsAcceptedValues |
Field | New |
FeatureDefinitions.InternationalReturnsDurationValues |
Field | New |
FeatureDefinitions.InternationalReturnsShipmentPayeeValues |
Field | New |
FeatureDefinitions.InternationalRefundMethodValues |
Field | New |
FeatureDefinitions.ReturnPolicyDescriptionEnabled |
Field | New |
SiteDefaults.DomesticReturnsAcceptedValues |
Field | New |
SiteDefaults.DomesticReturnsDurationValues |
Field | New |
SiteDefaults.DomesticReturnsShipmentPayeeValues |
Field | New |
SiteDefaults.DomesticRefundMethodValues |
Field | New |
SiteDefaults.InternationalReturnsAcceptedValues |
Field | New |
SiteDefaults.InternationalReturnsDurationValues |
Field | New |
SiteDefaults.InternationalReturnsShipmentPayeeValues |
Field | New |
SiteDefaults.InternationalRefundMethodValues |
Field | New |
SiteDefaults.ReturnPolicyDescriptionEnabled |
Field | New |
CategoryFeatureType |
Type | Updated |
FeatureIDCodeType |
Type | Updated |
SiteDefaultsTypeSiteDefaultsType |
Type | Updated |
ReturnsDurationCodeType |
Type | New |
ReturnsRefundMethodCodeType |
Type | New |
DomesticReturnsShipmentPayeeCodeType |
Type | New |
ReturnsAcceptedCodeType |
Type | New |
ReturnsShipmentPayeeCodeType |
Type | New |
DomesticRefundMethodCodeType |
Type | New |
InternationalRefundMethodCodeType |
Type | New |
DomesticReturnsAcceptedCodeType |
Type | New |
DomesticReturnsDurationCodeType |
Type | New |
InternationalReturnsShipmentPayeeCodeType |
Type | New |
InternationalReturnsDurationCodeType |
Type | New |
InternationalReturnsAcceptedCodeType |
Type | New |
ReturnPolicyDescriptionEnabledDefinitionType |
Type | New |
InternationalReturnsShipmentPayeeDefinitionType |
Type | New |
InternationalReturnsDurationDefinitionType |
Type | New |
InternationalReturnsAcceptedDefinitionType |
Type | New |
InternationalRefundMethodDefinitionType |
Type | New |
DomesticReturnsShipmentPayeeDefinitionType |
Type | New |
DomesticReturnsDurationDefinitionType |
Type | New |
DomesticReturnsAcceptedDefinitionType |
Type | New |
DomesticRefundMethodDefinitionType |
Type | New |
DetailNameCodeType |
Type | New |
FeatureDefinitionsType |
Type | New |
Note on return policies: In GetCategoryFeatures, the response values for the return policies differ from the values returned for the other features in that the SiteDefaults and Category containers list the allowable site and category values, and not the actual "default" values for these settings. With this, the SiteDefaults container lists all the return policy values that are supported at the root node of the specified marketplace and the Category container lists the allowed return policy values if (1) the allowable values for the category differ from the values allowed at the root node of the marketplace (in the case of any category IDs supplied in the request) or (2) if the allowable values for the category differ from those of their parent category. This exception pertains to the following domestic and international return policy flags: ReturnsDurationValues, ReturnsAcceptedValues, ReturnsShipmentPayeeValues, and RefundMethodValues. In addition, the FeatureDefinitions container is not currently populated for the return policy values.
| Name | Part of Schema | Type of Change |
|---|---|---|
| GetAccount Updates | ||
AccountDetailEntryCodeType.PaymentIntermediationFee |
Enum | New |
AccountDetailEntryCodeType.FeePaymentIntermediationRVI |
Enum | New |
AccountDetailEntryCodeType.FeePaymentIntermediationChargeback |
Enum | New |
AccountDetailEntryCodeType.FeePaymentIntermediationChargebackRVI |
Enum | New |
| EndItem Updates | ||
EndReasonCodeType.ProductDeleted |
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.
As of August 30, 2018, California will require certain sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact health of California buyers. To enable sellers to show this warning on a listing, eBay is adding a new 'California Prop 65 Warning' item specific to listing flows.
Unlike standard item specifics that allow a maximum of 65 characters in the NameValueList.Value field in an Add/Revise/Relist call, the matching value for the 'California Prop 65 Warning' item specific allows up to 800 characters of text. When a seller passes in this item specific, eBay will automatically insert a warning symbol icon for the listing.
This requirement applies to all single and multiple-variation listings in most eBay US categories (including eBay Motors, Motors Parts & Accessories, and PBSE-enforced categories).
For multiple-variation listings, the 'California Prop 65 Warning' is passed just once at the listing level, and will be propagated to each variation. For Product-Based listings, this 'California Prop 65 Warning' is also required at listing time, and will get picked up by the listing.
For more information about Proposition 65, see the New Proposition 65 Warnings page on the CA.gov site.
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 - 1077.
None for this release.
The following four enumeration values were added to AccountDetailEntryCodeType, and will be returned (when applicable) in the GetAccount call.
PaymentIntermediationFeeFeePaymentIntermediationRVIFeePaymentIntermediationChargebackFeePaymentIntermediationChargebackRVIA new ProductDeleted enumeration value was added to EndReasonCodeType. This enumeration value cannot be used by the seller in an End listing call, but it will get returned in GetItem if a listing was administratively ended by eBay if the item in a listing becomes unpurchasable due to the eBay Catalog product associated with the listing being removed from the catalog.
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.
Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category in a ReviseItem or ReviseFixedPriceItem call, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field, as shown below:
<SecondaryCategory>
<CategoryID>0</CategoryID>
</SecondaryCategory>
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1077 and Changed Functionality - 1077.
Updated the RestrictedToBusiness field description to include UK as another country that supports Business-to-Business listings.
Documentation Changes and Errata - 1073
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.
Currently, the GeteBayDetails call is used to retrieve site-level, return policy metadata. Starting in September 2018, the GetCategoryFeatures call will start returning category-level metadata for both domestic and international return policies, and developers should make plans to use that call for this metadata instead.
The 2018 Fall Seller Update is now available. Below are just a few updates that are available in the Seller Update:
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 - 1073.
The VariationProductListingDetails.ProductReferenceID in AddFixedPriceItem, ReviseFixedPriceItem, and RelistFixedPriceItem calls has been wired on for use when listing in PBSE categories. This field can only be used for listings in categories where PBSE is either enabled or enforced. In PBSE-enforced categories, a unique ePID will actually be required for each variation in the multiple-variation listing.
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 Months_1 enum value, historically only supported on the DE and AT sites, is scheduled to be deprecated, and DE and AT sellers may be blocked from creating, revising, or relisting an item if they use this value in the ReturnPolicy.InternationalReturnsWithinOption or ReturnPolicy.ReturnsWithinOption fields. The Months_1 value is being sunset beginning late August 2018, and after 18 months you will receive a blocking error if you attempt to use this value. Use Days_30 instead.
If the ReturnsWithinOption and/or InternationalReturnsWithinOption values are not specified in the Return Policy of an Add/Revise/Relist call, the default value with by 30 Days (Days_30). Previously, the default value was 14 Days (Days_14)
If the price for a fixed-price item (set in the StartPrice field) is changed with a ReviseItem or ReviseFixedPriceItemcall, the Best Offer Auto-Accept (BestOfferAutoAcceptPrice) and/or Best Offer Auto-Decline (MinimumBestOfferPrice) price values will be retained (if set for the listing) as long as they are still considered valid against the new 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 - 1073 and Changed Functionality - 1073.
Updated the DomesticRateTableId and InternationalRateTableId field descriptions to describe how to unassociate/remove a shipping rate table from an individual listing using the Revise or Relist calls.
Although the ProductListingDetails.ProductReferenceID field was already being returned in the GetItem call, it was missing in the Call Reference documentation.
Made a correction to the field description. This field was inaccurately described as including shipping charge and sales tax, when it accurately only indicates the sales price of one unit of the item. This field is returned in GetOrders (and other order management calls) and GetMyeBaySelling.
Copyright © 2005–2019 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.