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.

Q4 2022
Version Release Date
1291 2022-Dec-30
1289 2022-Dec-16
1287 2022-Dec-02
1285 2022-Nov-18
1283 No Schema or Doc Updates
1281 2022-Oct-21
1279 2022-Oct-07
Q3 2022
Version Release Date
1277 No Schema or Doc Updates
1275 2022-Sep-09
1273 No Schema or Doc Updates
1271 No Schema or Doc Updates
1269 No Schema or Doc Updates
1267 2022-Jul-15
1265 No Schema or Doc Updates
Q2 2022
Version Release Date
1263 No Schema or Doc Updates
1261 No Schema or Doc Updates
1259 No Schema or Doc Updates
1257 2022-May-06
1255 2022-Apr-22
1253 No Schema or Doc Updates
Q1 2022
Version Release Date
1251 No Schema or Doc Updates
1249 2022-Mar-11
1247 2022-Feb-25
1245 No Schema or Doc Updates
1243 No Schema or Doc Updates
1241 No Schema or Doc Updates

These release notes go back four quarters. For older release notes, see the Release Notes archive.

Version 1285

Index of Changed Calls - 1285

Schema Changes - 1285

Announcements - 1285

New Features - 1285

Changed Functionality - 1285

Documentation Changes and Errata - 1285

For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.

.

Index of Changed Calls - 1285

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 - 1285

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 - 1285

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

New Features - 1285

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

None for this release.

Changed Functionality - 1285

This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.

Updated Picture Limit

This release of the Trading API updates the picture limit. With the exception of motor vehicle listings on the US and Canada marketplaces, sellers can now include up to 24 pictures in a listing free of charge in all categories on all marketplaces. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors).

Documentation Changes and Errata - 1285

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

None for this release.

Version 1281

Index of Changed Calls - 1281

Schema Changes - 1281

Announcements - 1281

New Features - 1281

Changed Functionality - 1281

Documentation Changes and Errata - 1281

For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.

.

Index of Changed Calls - 1281

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 - 1281

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.FedExReturnLabelFee Enum New
AccountDetailEntryCodeType.FedExReturnLabelFeeCredit Enum New
AccountDetailEntryCodeType.AUPostReturnLabelFee Enum New
AccountDetailEntryCodeType.AUPostReturnLabelFeeCredit Enum New
AccountDetailEntryCodeType.UpsCaLabelFee Enum New
AccountDetailEntryCodeType.UpsCaLabelFeeCredit Enum New
AccountDetailEntryCodeType.FedExCaLabelFee Enum New
AccountDetailEntryCodeType.FedExCaLabelFeeCredit Enum New
AccountDetailEntryCodeType.HubbedReturnLabelFee Enum New
AccountDetailEntryCodeType.HubbedReturnLabelFeeCredit Enum New
AccountDetailEntryCodeType.RoyalMailReturnLabelFee Enum New
AccountDetailEntryCodeType.RoyalMailReturnLabelFeeCredit Enum New
AccountDetailEntryCodeType.ParcelForcePostReturnLabelFee Enum New
AccountDetailEntryCodeType.ParcelForcePostReturnLabelFeeCredit Enum New
AccountDetailEntryCodeType.OffsiteAdsFee Enum New
AccountDetailEntryCodeType.OffsiteAdsFeeCredit Enum New
CancelReasonCodeType.AddressIssues Enum New
CancelReasonCodeType.BuyerCancelOrAddressIssue Enum Deprecated
Item.IsItemEMSEligible Field New

Announcements - 1281

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

EU and UK Payments regulations update: Digital Signatures

Due to EU and UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers, including GetAccount. Refer to Digital Signatures for APIs for information about creating signatures to be included in the HTTP payload.

New Features - 1281

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

New item eligibility flag for shipping managed by eBay

The new boolean field IsItemEMSEligible was added to the GetItem call (in ItemType). If true, the item is eligible for shipping managed by eBay; false, the item is not eligible for shipping managed by eBay.

Changed Functionality - 1281

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.

Updates to GetAccount Call

Sixteen new enumeration values were added for GetAccount (in AccountDetailEntryCodeType) to account for new account fees/credits. The enumeration values include:

See these new values in AccountDetailEntryCodeType for more information.

Updates to CancelReasonCodeType type

A new enumerated value AddressIssues was added and the enumerated value BuyerCancelOrAddressIssue was Deprecated.

See the new value in CancelReasonCodeType for more information.

Shipping service override changes to business policies

When revising or relisting an item that is using business policies and has one or more shipping service cost overrides set up, the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included even if no changes are being made.

Australia sellers offering freight shipping changes

Sellers offering freight shipping on the Australia (AU) marketplace must now use the AU_Freight enumeration value for ShippingServiceCodeType. For these sellers, the Freight value will no longer be accepted and may lead to a blocking error.

Documentation Changes and Errata - 1281

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

None for this release.

Version 1279

Index of Changed Calls - 1279

Schema Changes - 1279

Announcements - 1279

New Features - 1279

Changed Functionality - 1279

Documentation Changes and Errata - 1279

For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.

.

Index of Changed Calls - 1279

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 - 1279

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
ShippingDetails.eBayEstimatedLabelCost Field New

Announcements - 1279

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

New Features - 1279

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

Added support for eBay shipping

The return of the eBayEstimatedLabelCost field with a value of 0.0 indicates that a free shipping label by eBay is downloadable by the seller via the eBay website. See more details about Authenticity Guarantee and how eBay shipping applies to eligible sneaker listings.

Changed Functionality - 1279

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.

New Error Codes for 1279

Below is the list of the new error messages that rolled out with the 1279 release. All of these messages are related to using eBay Shipping. The long version of each message is used below.

These error and warning messages can be viewed in the Errors By Number page.

Documentation Changes and Errata - 1279

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

None for this release.

Version 1275

Index of Changed Calls - 1275

Schema Changes - 1275

Announcements - 1275

New Features - 1275

Changed Functionality - 1275

Documentation Changes and Errata - 1275

For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.

.

Index of Changed Calls - 1275

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

No changed calls in this release.

Schema Changes - 1275

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 - 1275

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

New Features - 1275

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

A new intermediated international shipping program has been added

A new intermediated international shipping program called eBay International Shipping is available. On the US marketplace, the Global Shipping Program is scheduled to be replaced by this new intermediated shipping program (eBay International Shipping). US Sellers opted in to the Global Shipping Program will automatically get opted into eBay International Shipping once it becomes available to them. All US sellers will be migrated by March 31, 2023. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available.

Support for eBay International Shipping has been added to GetOrders, GetSellerTransactions, GetItemTransactions, and GetOrderTransactions calls. The eBay International Shipping partner's address is shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress container. Additionally, similar to the ReferenceID field provided for the Global Shipping Program, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to the Street2 field (not in the ReferenceID field).

Changed Functionality - 1275

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 - 1275

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

None for this release.

Version 1267

Index of Changed Calls - 1267

Schema Changes - 1267

Announcements - 1267

New Features - 1267

Changed Functionality - 1267

Documentation Changes and Errata - 1267

For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.

.

Index of Changed Calls - 1267

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

No changed calls in this release.

Schema Changes - 1267

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 - 1267

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

Four Store Calls Scheduled for Decommission on September 30

The new Stores platform no longer supports custom store pages and other customization functionality, so the following four store calls are deprecated and scheduled for decommission on September 30, 2022:

Although these four calls still work and will continue to work up until the decommission date, it is recommended that they are no longer used since none of the customization features in these calls can be applied to stores in the Production environment

Additionally, the following containers and fields related to store customization in the GetStore call are also deprecated and scheduled for decommission on September 30, 2022:

New Features - 1267

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

None for this release.

Changed Functionality - 1267

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 - 1267

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

None for this release.

Version 1257

Index of Changed Calls - 1257

Schema Changes - 1257

Announcements - 1257

New Features - 1257

Changed Functionality - 1257

Documentation Changes and Errata - 1257

For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.

.

Index of Changed Calls - 1257

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

No changed calls in this release.

Schema Changes - 1257

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
HitCounterCodeType Type Removed
Item.HitCounter Field Removed

Announcements - 1257

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

New Features - 1257

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

None for this release.

Changed Functionality - 1257

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.

HitCounter field removed from WSDL

The HitCounter field has been removed from the WSDL. It can no longer be used in Add/Revise calls, nor will it be returned in GetItem, GetBidderList, GetSellerEvents, or GetSellerList.

HitCount field updates

The HitCount field will no longer be returned in GetItem or GetBidderList, but it will continue to be returned in GetSellerEvents and GetSellerList, but with a logic change. Instead of the HitCount value representing the lifetime hit count for listings, the value will be the total number of page hits within the latest 30-day period.

Quantity and StartPrice no longer returned in ReviseInventoryStatus

The Quantity and StartPrice fields will no longer be returned in the ReviseInventoryStatus response. However, these fields will function the same as before in ReviseInventoryStatus request. If users would like to verify if their price and/or quanity changes were successfully pushed out to the listing (or variation within a listing), they can use the GetItem call to verify the changes.

Documentation Changes and Errata - 1257

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

None for this release.

Version 1255

Index of Changed Calls - 1255

Schema Changes - 1255

Announcements - 1255

New Features - 1255

Changed Functionality - 1255

Documentation Changes and Errata - 1255

For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.

.

Index of Changed Calls - 1255

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

No changed calls in this release.

Schema Changes - 1255

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
GetCategorySpecificsRequest Type Removed
GetCategorySpecificsResponse Type Removed
AspectUsageCodeType Type Removed
CategoryItemSpecificsType Type Removed
NameRecommendationType Type Removed
NameValueRelationshipType Type Removed
ProductRequiredCodeType Type Removed
RecommendationsType Type Removed
RecommendationValidationRulesType Type Removed
RelevanceIndicatorType Type Removed
SelectionModeCodeType Type Removed
UsageConstraintCodeType Type Removed
ValueFormatCodeType Type Removed
ValueRecommendationType Type Removed
VariationPictureRuleCodeType Type Removed
VariationSpecificsRuleCodeType Type Removed

Announcements - 1255

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

GetCategorySpecifics Call Decommisioned

The GetCategorySpecifics call has been decommisioned, and the call reference documentation has been removed. Additionally, all types exclusively used by GetCategorySpecifics have been removed from the Trading WSDL. You can see the full list of removed types in the Schema Changes section.

The alternative solution to GetCategorySpecifics is the getItemAspectsForCategory method of the Taxonomy API. For more information about migrating to the Taxonomy API and using the Taxonomy SDK, see the Taxonomy API migration guide.

New Features - 1255

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

None for this release.

Changed Functionality - 1255

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 - 1255

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

None for this release.

Version 1249

Index of Changed Calls - 1249

Schema Changes - 1249

Announcements - 1249

New Features - 1249

Changed Functionality - 1249

Documentation Changes and Errata - 1249

For a current list of known issues, see the API Status page, or visit the Support page for account support, technical support, and other support resources.

Index of Changed Calls - 1249

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 - 1249

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 - 1249

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

New Features - 1249

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

None for this release.

Changed Functionality - 1249

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.

Extended producer responsibility related information returned

Sellers can now return their listing's extended producer responsibility related information using the GetItem call.

Documentation Changes and Errata - 1249

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

None for this release.

Version 1247

Index of Changed Calls - 1247

Schema Changes - 1247

Announcements - 1247

New Features - 1247

Changed Functionality - 1247

Documentation Changes and Errata - 1247

For a current list of known issues, see the API Status page and the Knowledge Base.

Index of Changed Calls - 1247

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 - 1247

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 - 1247

Change Requests

See the API Status page for announcements regarding recently resolved or current system wide issues. Visit the Support page for account support, technical support, and other support resources.

Winter 2022 Seller Updates Available

The Winter 2022 Seller Updates have been released. Below is a high-level summary of the updates:

New Features - 1247

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

None for this release.

Changed Functionality - 1247

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.

HitCounter and HitCount Fields Deprecated

Hit counters are no longer displayed in View Item pages, so the HitCounter and HitCount fields are no longer applicable and are scheduled for decommission. For developers/sellers who are interested in seeing page views and listing performance, the getTrafficReport method of the Sell Analytics API can be used.

Currently, if the HitCounter field is used in the request payload of an add/revise/relist/verify call, the field will be ignored and a warning message will be returned.

Until both fields are decommissioned, the HitCounter and HitCount fields will still be returned in GetItem, GetBidderList, GetSellerEvents, and GetSellerList. For HitCounter, the default value for the marketplace will be returned, such as NoHitCounter or HiddenStyle.

Documentation Changes and Errata - 1247

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

None for this release.