Trading API

Trading API Release Notes

The latest version of the Trading API has rolled out to all the API machines and is now available! Be sure to check out all the new features and known issues.

If you are getting started with the API, the following locations have information about joining the eBay Developers Program, creating test users, and other steps to getting your application certified to go live against the eBay production servers:

Q1 2019
Version Release Date
1101 2019-Mar-29
1099 2019-Mar-15
1097 Not Released
1095 2019-Feb-15
1093 Not Released
1091 2019-Jan-18
Q4 2018
Version Release Date
1089 Not Released
1087 Not Released
1085 2018-Oct-26
1083 Skipped
Q3 2018
Version Release Date
1081 2018-Sep-28
1079 Not Released
1077 2018-Aug-31
1075 Not Released
1073 2018-Aug-03
1071 Not Released
1069 Not Released
Q2 2018
Version Release Date
1067 2018-Jun-22
1065 2018-Jun-08
1063 Not Released
1061 2018-May-11
1059 Not Released
1057 2018-Apr-13

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.

Version 1099

Index of Changed Calls - 1099

Schema Changes - 1099

Announcements - 1099

New Features - 1099

Changed Functionality - 1099

Documentation Changes and Errata - 1099

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1099

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1099

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.

Announcements - 1099

Change Requests

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 Fixed-Priced Listings to Become Good 'Til Cancelled

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.

IMCC Payments Will No Longer Be Accepted

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.

New Features - 1099

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.

Changed Functionality - 1099

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.

Maximum Number of Item Specifics Increased

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.

Documentation Changes and Errata - 1099

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 Doc Improvements

Numerous documentation improvements were made for this release.

Version 1095

Index of Changed Calls - 1095

Schema Changes - 1095

Announcements - 1095

New Features - 1095

Changed Functionality - 1095

Documentation Changes and Errata - 1095

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1095

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1095

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.

Announcements - 1095

Change Requests

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 Fixed-Priced Listings to Become Good 'Til Cancelled

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.

IMCC Payments Will No Longer Be Accepted

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.

2019 Early Seller Update Now Available

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:

New Features - 1095

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.

Changed Functionality - 1095

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.

Only 'GTC' Supported for Fixed-Priced Listings in Australia

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.

Documentation Changes and Errata - 1095

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 Note About 500 Pixels Requirement for Listing Photos

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.

Version 1091

Index of Changed Calls - 1091

Schema Changes - 1091

Announcements - 1091

New Features - 1091

Changed Functionality - 1091

Documentation Changes and Errata - 1091

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1091

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1091

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

Announcements - 1091

Change Requests

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.

New Features - 1091

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.

Best Offer Feature Enabled for Auction Listings on More Sites

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.

Changed Functionality - 1091

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.

Change to Minimum Best Offer Price Threshold in Auction Listings

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.

New Category Mapping Now Done by Default

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.

Secondary Phone Numbers No Longer Supported in Classified Ad Listings

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:

Two eBay Motors-related Fields Deprecated

The following two eBay Motors-related fields were deprecated. Previously, both of these boolean fields were set through an Add/Revise/Relist call.

ShippingTermsInDescription Field Deprecated

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.

Documentation Changes and Errata - 1091

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.

Version 1085

Index of Changed Calls - 1085

Schema Changes - 1085

Announcements - 1085

New Features - 1085

Changed Functionality - 1085

Documentation Changes and Errata - 1085

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1085

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1085

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.

Announcements - 1085

Change Requests

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.

Payment Changes for Sellers in eBay Managed Payments Program

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.

New Features - 1085

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.

Changed Functionality - 1085

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.

Documentation Changes and Errata - 1085

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.

Doc Updates to 'eBay Collect and Remit Tax' Fields

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.

Doc Updates to SalesTax Container

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.

Using EAN and UPC Values in Listing Calls

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.

Clarified How Package Weight is Specified in ShippingPackageDetails

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>

Made it More Clear How OrderStatus Values are Used In GetOrders

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.

Enhanced ExtendedOrderID Field Description in Order Management Calls

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.

Version 1081

Index of Changed Calls - 1081

Schema Changes - 1081

Announcements - 1081

New Features - 1081

Changed Functionality - 1081

Documentation Changes and Errata - 1081

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1081

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1081

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.

Announcements - 1081

Change Requests

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.

New Regional Shipping Rate Tables Available for Three More Countries

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.

New Features - 1081

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.

Changed Functionality - 1081

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.

30-Day Listing Duration Enabled for eBay Motors Listings

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.

CategoryBasedAttributesPrefill Field Deprecated

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.

More Flexibility in Revising Charitable Listings

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.

More Flexibility in Deleting Variations

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.

Documentation Changes and Errata - 1081

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.

Max Length of PaymentInstructions Field Corrected

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.

Shipping Insurance and Warranty Documentation Cleaned Up

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.

Version 1077

Index of Changed Calls - 1077

Schema Changes - 1077

Announcements - 1077

New Features - 1077

Changed Functionality - 1077

Documentation Changes and Errata - 1077

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1077

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1077

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.

GetCategoryFeatures updates

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.

Other updates

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

Announcements - 1077

Change Requests

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.

Updates to California Proposition 65 Going into Effect

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.

New Features - 1077

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.

New Payment Intermediation Fees/Credits Added to GetAccount

The following four enumeration values were added to AccountDetailEntryCodeType, and will be returned (when applicable) in the GetAccount call.

  • PaymentIntermediationFee
  • FeePaymentIntermediationRVI
  • FeePaymentIntermediationChargeback
  • FeePaymentIntermediationChargebackRVI

New End Listing Reason Added

A 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.

Changed Functionality - 1077

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.

No Restriction on Dropping Secondary Category on a Listing

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>

Documentation Changes and Errata - 1077

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 RestrictedToBusiness Field Description

Updated the RestrictedToBusiness field description to include UK as another country that supports Business-to-Business listings.

Version 1073

Index of Changed Calls - 1073

Schema Changes - 1073

Announcements - 1073

New Features - 1073

Changed Functionality - 1073

Documentation Changes and Errata - 1073

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1073

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1073

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.

Announcements - 1073

Change Requests

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.

Return Policy Metadata Moving to GetCategoryFeatures

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.

2018 Fall Seller Update Now Available

The 2018 Fall Seller Update is now available. Below are just a few updates that are available in the Seller Update:

  • Updates to secure HTTPS content
  • Updates on listing fees
  • The latest on Product-Based Shopping Experience
  • What's new in shipping

New Features - 1073

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.

Support for Variation-Level ePIDs in PBSE Categories

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.

Changed Functionality - 1073

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.

Months_1 Enum in ReturnsWithinCodeType Being Deprecated

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.

30-Day Return Period Replaces 14-day as the Default

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)

Valid Best Offer Threshold Values Retained When Revising Item

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.

Documentation Changes and Errata - 1073

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 DomesticRateTableId and InternationalRateTableId Descriptions

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.

Added ProductReferenceID Field to GetItem Documentation

Although the ProductListingDetails.ProductReferenceID field was already being returned in the GetItem call, it was missing in the Call Reference documentation.

Corrected Description of Transaction.TransactionPrice Field

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.

Version 1067

Index of Changed Calls - 1067

Schema Changes - 1067

Announcements - 1067

New Features - 1067

Changed Functionality - 1067

Documentation Changes and Errata - 1067

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1067

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1067

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.eBayCollectAndRemitTax Field New
TransactionType.eBayCollectAndRemitTax Field New
TransactionType.eBayCollectAndRemitTaxes Field New
TaxDescriptionCodeType.GST Enum New
TaxTypeCodeType.GST Enum New

Announcements - 1067

Change Requests

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.

New Features - 1067

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 - 1067.

New Tax Fields Added to Order Management Calls to Account for Australian Import Tax

New fields will be returned in the order management calls (GetOrders, GetSellerTransactions, GetOrderTransactions, and GetItemTransactions) for orders that are subject to Australian import tax charged to the buyer. Australian import tax charged to the buyer is collected by eBay and remitted to the Australian government.

A Transaction.eBayCollectAndRemitTaxes container will be returned for any order line items subject to the import tax charged to the buyer, and the amount of this tax will be displayed in the TaxDetails.TaxAmount field under this container.

At this time, the Transaction.eBayCollectAndRemitTaxes container is only applicable to the Australia site and to the Australian import tax, but it is possible that this container may become applicable to other eBay sites and tax types in the future.

Changed Functionality - 1067

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.

Documentation Changes and Errata - 1067

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1067 and Changed Functionality - 1067.

None for this release.

Version 1065

Index of Changed Calls - 1065

Schema Changes - 1065

Announcements - 1065

New Features - 1065

Changed Functionality - 1065

Documentation Changes and Errata - 1065

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1065

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1065

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
MaximumBuyerPolicyViolationsType Type Deprecated
VerifiedUserRequirementsType Type Deprecated
BuyerRequirementDetails.LinkedPayPalAccount Field Deprecated
BuyerRequirementDetails.MaximumBuyerPolicyViolations Field Deprecated
BuyerRequirementDetails.MinimumFeedbackScore Field Deprecated
BuyerRequirementDetails.VerifiedUserRequirements Field Deprecated

Announcements - 1065

Change Requests

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.

New Features - 1065

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 - 1065.

None for this release.

Changed Functionality - 1065

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.

Four Buyer Requirement Fields Removed from WSDL

The following four BuyerRequirementDetailsType fields were removed from the WSDL with Version 1065:

  • MinimumFeedbackScore
  • LinkedPayPalAccount
  • VerifiedUserRequirements
  • MaximumBuyerPolicyViolations

These four fields should no longer be set in Add/Revise/Relist/Verify calls, as they will have no functional effect if they are included.

VerifiedUserRequirementsType and MaximumBuyerPolicyViolationsType were also removed from the WSDL with Version 1065, as these types were only used by two of the fields that are being deprecated.

Documentation Changes and Errata - 1065

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1065 and Changed Functionality - 1065.

None for this release.

Version 1061

Index of Changed Calls - 1061

Schema Changes - 1061

Announcements - 1061

New Features - 1061

Changed Functionality - 1061

Documentation Changes and Errata - 1061

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1061

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1061

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
ReturnPolicy.InternationalReturnsAcceptedOption Field New
ReturnPolicy.InternationalReturnsWithinOption Field New
ReturnPolicy.InternationalShippingCostPaidByOption Field New
ReturnPolicy.InternationalRefundOption Field New

Announcements - 1061

None for this release.

Change Requests

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.

New Features - 1061

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 - 1061.

International returns

Several International fields were added to the ReturnPolicy container. These fields let sellers specify international return policies that differ from their domestic return policies (international returns are those that are shipped using an international shipping service).

Before this release, the single set of return policy fields represented the seller's return policies for both domestic and international returns. The preexisting return policy fields now define a seller's domestic return policy and the new international fields enable sellers to also define specific international return policies. (If a seller does not define specific international return policies, then any international returns will inherit the seller's domestic return policies).

Changed Functionality - 1061

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.

This release launches a reorganization to eBay's return policies. To streamline the number of return variations, several fields were deprecated and others were added to make return policies simple to create and easy to maintain. For details on this roll out, see the Spring 2018 Seller Announcement, Simplified Returns.

Before this release, the single set of return policy fields represented the seller's return policies for both domestic and international returns. The preexisting return policy fields now define a seller's domestic return policy and the new international fields enable sellers to also define specific international return policies. (If a seller does not define specific international return policies, then any international returns will inherit the seller's domestic return policies).

Deprecated functionality

Starting with this release, sellers can no longer specify warranty information, restocking fees, or hours for extended holiday returns with their return policies. With this, the following ReturnPolicy fields are deprecated with this release; any values supplied to these fields will not be evaluated, stored, or returned:

  • ReturnPolicy.ExtendedHolidayReturns
  • ReturnPolicy.RestockingFeeValueOption
  • ReturnPolicy.WarrantyDurationOption
  • ReturnPolicy.WarrantyOfferedOption
  • ReturnPolicy.WarrantyTypeOption

Simplified returns

Simplified returns changes the following functionality in this release:

  • Description – This field is now valid for only the EBAY_DE, EBAY_ES, EBAY_FR and EBAY_IT marketplaces.
  • RefundOption and InternationalRefundOption – These fields are now purposeful only on the US marketplace. On EBAY_US, valid values are MoneyBack and MoneyBackOrReplacement. The value MoneyBackOrExchange is deprecated. For a time, the value will be accepted and updated to MoneyBackOrReplacement, which is the value that's returned. For marketplaces other than the US, MoneyBack is the default and only supported refund option. As a best practice, and for clarity of code, do not set the RefundOption and InternationalRefundOption fields in Add/Revise/Relist calls unless you have the specific need to do so.
  • ReturnsWithinOption – The accepted values for this field have been streamlined in that most categories now support only Days_30 and Days_60 values. The Days_3 and Days_7 options have been removed from the AU marketplace and the Days_14 option has been removed from most categories.

    Call GetCategoryFeatures with DetailName set to ReturnPolicyDetails to review which categories allow a Days_14 return period (GetCategoryFeatures will be updated in mid-August 2018 with the proper return period information).
  • ShippingCostPaidByOptiopn – This field becomes conditionally required in that you must populate this field if you specify either a domestic or international return policy. Valid values for this field are Buyer and Seller.

FAQ

  • How will existing listings that currently do not specify an international return policy be treated?
    • Any listing that does not specify an international policy will be treated as though the existing return policy applies to both domestic and international sales. If the seller does not wish to offer the same return policy for both domestic and international returns, they must specify a separate return policy using the international fields. International policies are not be mandatory; however, once specified, international policies cannot be deleted (but they can be revised).
  • What happens if I specify only ReturnsAccepted for either a domestic or international return policy?
    • The ReturnsWithinOption, ShippingCostPaidByOption, and RefundOption fields are mandatory. eBay will populate these fields with default values for the next 18 months, after which an error will be returned if you do not specify valid values for these fields.
  • What happens if I specify values in the Description or RefundOption fields, but the marketplace no longer supports these fields?
    • In the cases where these fields are no longer supported, a warning is thrown and the values are ignored (they are neither read nor returned).
  • What happens if upon revise, a listing has a value that is no longer valid in one of its relevant return policy fields?
    • If the item has a bid, a pending offer, or ends within 12 hours, the return policy cannot be revised. However, compliance with currently valid options will not be enforced on these items. For any item that is not in this restricted state, a blocking error is thrown if the policy is not valid when the item is listed. In these cases, the seller cannot revise any part of their listing unless they also revise the return policy so it is compliant.
  • What happens if I try to revise a listing that currently has a restocking fee in its return policy?
    • The restocking fee value is ignored and any present value is not validated or stored.
  • What happens if I try to revise a listing that currently has a Description field?
    • Only DE, FR, IT, and ES sites will continue to support this field. In the cases where this field is no longer supported and a value is present, a warning will be thrown and any value present is ignored. Note that where supported, you can populate this field even if you set ReturnsAcceptedOption to ReturnsNotAccepted.
  • On the DE marketplace, can I continue to use Months_1 as a value for ReturnsWithinOption; will either Days_30 or Months_1 be accepted?
    • For the DE marketplace, the value Months_1 will continue to be accepted for the next 18 months. If this value is specified, it is stored as Days_30. After 18 months, a value of Months_1 will throw a blocking error.

Documentation Changes and Errata - 1061

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1061 and Changed Functionality - 1061.

None for this release.

Version 1057

Index of Changed Calls - 1057

Schema Changes - 1057

Announcements - 1057

New Features - 1057

Changed Functionality - 1057

Documentation Changes and Errata - 1057

For a current list of known issues, see Site Status Updates and the Knowledge Base.

Index of Changed Calls - 1057

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.

New Calls

No new calls in this release.

Changed Calls

Schema Changes - 1057

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
AspectUsageCodeType Type New
ProductRequiredEnabledCodeType Type New
ProductRequiredEnabledDefinitionType Type New
CategoryFeatureType.ProductRequiredEnabled Field New
FeatureDefinitionsType.ProductRequiredEnabled Field New
RecommendationValidationRulesType.AspectUsage Field New
RecommendationValidationRulesType.MaxValueLength Field New
SiteDefaultsType.ProductRequiredEnabled Field New
VariationProductListingDetailsType.ProductReferenceID Field New
FeatureIDCodeType.ProductRequiredEnabled Enum New

Announcements - 1057

Change Requests

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.

New Features - 1057

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 - 1057.

Added Ability to Reference an ePID at Variation Level

A ProductReferenceID field was added to VariationProductListingDetailsType, and this allows the seller to identify each product variation within a multiple-variation listing by an eBay Product ID (ePID). An ePID is a unique identifier of an eBay Catalog product. The seller can use the GetCategoryFeatures or GetCategorySpecifics calls to see if an ePID is supported/required for a category.

Currently, this field can only be used in the Sandbox environment to specify an ePID for an eBay Catalog product that is part of the Product-Based Shopping Experience mandate. For more information about PBSE, see the Product-Based Shopping Experience page.

This change affects the following Trading API calls:

  • AddFixedPriceItem
  • AddSellingManagerProduct
  • AddSellingManagerTemplate
  • RelistFixedPriceItem
  • ReviseFixedPriceItem
  • ReviseSellingManagerProduct
  • ReviseSellingManagerTemplate
  • VerifyAddFixedPriceItem

It will be added to 'Get' calls that return the VariationProductListingDetails container at a later date.

GetCategoryFeatures Call Updated with the ProductRequiredEnabled Feature

The GetCategoryFeatures call was updated to show sellers if a particular eBay category requires that listings be associated with an eBay Catalog product. For Phase 2 of the Product-Based Shopping Experience (PBSE), entire eBay leaf categories will start requiring that listings be associated with an eBay Catalog product. Phase 2 of PBSE is scheduled to launch on the US, UK, Australia, and Canada (English) sites in August 2018. For more information on PBSE, see the Product-Based Shopping Experience landing page.

If you wanted to use GetCategoryFeatures only to check if a category required that all listings be associated with an eBay Catalog product, you could run the following call:

<?xml version="1.0" encoding="utf-8"?>
<GetCategoryFeaturesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
   <RequesterCredentials>
      <eBayAuthToken>AgAAAA**.../96cN</eBayAuthToken>
   </RequesterCredentials>
   <ErrorLanguage>en_US</ErrorLanguage>
   <WarningLevel>High</WarningLevel>
   <CategoryID>9355</CategoryID>
   <FeatureID>ProductRequiredEnabled</FeatureID>
   <DetailLevel>ReturnAll</DetailLevel>
</GetCategoryFeaturesRequest>

GetCategorySpecifics Updated to Return Two New Fields for PBSE Categories/Brands

The GetCategorySpecifics call was updated to return two new fields - AspectUsage and MaxValueLength. These two new fields will be returned under the ValidationRules containers for Product-Based Shopping Experience mandated categories/brands. The AspectUsage field will indicate if a category aspect is a product-level aspect, or if it is an aspect that is typically unique to a particular instance of a product in that category, and the MaxValueLength field will state the maximum length of the aspect's value. The seller must make sure not to exceed this value when setting instance aspects on a listing in this category.

Changed Functionality - 1057

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.

Documentation Changes and Errata - 1057

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1057 and Changed Functionality - 1057.

None for this release.

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.