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.

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

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.

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.

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

• GetItem

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

• AddFixedPriceItem
• AddItem
• AddItems
• GetBidderList
• GetItem
• GetSellerEvents
• GetSellerList
• RelistFixedPriceItem
• RelistItem
• ReviseFixedPriceItem
• ReviseItem
• VerifyAddFixedPriceItem
• VerifyAddItem
• VerifyRelistItem

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:

• More robust sales data available under Performance tab in Seller Hub
• Updates and expansion for all Promoted Listings products (Standard, Express, and Advanced)
• More sellers will get the option of requiring all buyers to provide payment details before making a Best Offer on a listing, reducing the risk of Unpaid Items for Best Offer transactions
• More sellers will get the option of requiring all buyers to provide payment details before making a Best Offer on a listing, reducing the risk of Unpaid Items for Best Offer transactions
• Upcoming updates to order fees and credits
  • Sellers will now be refunded the $0.30 per-order fee for orders that are cancelled at the buyer's request
  • The additional final value fee charged to Below Standard sellers will increase from 5% to 6% (of sales price)
  • Final value fees will have a slight increase for most categories (0.3% for Store sellers and 0.35% for non-Store sellers). See the Selling Fees Updates table for the full list of fee increases.
  • Listing Subtitle fee increases by $0.50 for both fixed-price and auction listings
  • Starting in May 2022, sellers will get partial final value fee credits for partial refunds
  • Starting in June 2022, the Promoted Listings Standard fee will be calculated based on the total order cost (including applicable taxes and shipping), and not just the sales price

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.

Version 1235

Index of Changed Calls - 1235

Schema Changes - 1235

Announcements - 1235

New Features - 1235

Changed Functionality - 1235

Documentation Changes and Errata - 1235

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

Index of Changed Calls - 1235

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

• AddFixedPriceItem
• AddItem
• AddItems
• RelistFixedPriceItem
• RelistItem
• ReviseFixedPriceItem
• ReviseItem
• VerifyAddFixedPriceItem
• VerifyAddItem
• VerifyRelistItem

Schema Changes - 1235

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.

Note: Support for extended producer responsibility regulations and custom policies will become active mid-December 2021. Additional resources such as the custom policies resource (for the Account API), the getExtendedProducerResponsibilityPolicies method (for the Sell Metadata API), and the Custom Policies help page will also become active.

Announcements - 1235

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

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

Note: Support for extended producer responsibility regulations and custom policies will become active mid-December 2021. Additional resources such as the custom policies resource (for the Account API), the getExtendedProducerResponsibilityPolicies method (for the Sell Metadata API), and the Custom Policies help page will also become active.

New Schema added to support custom policies

To support custom policies, policy IDs can be specified in add, revise, relist, or verify calls. This feature is supported by a limited number of sites and specific categories. Refer to the Metadata API to return the enabled sites and categories. To create and manage custom policies, see the Account API.

• CustomPolicies: This container and its child fields are used to specify custom policy IDs.

New Schema added to support extended producer responsibility regulations

To support new extended producer responsibility regulations, information about the producer of a new item can be specified in add, revise, relist, or verify calls. This feature is supported by a limited number of sites and specific categories. Refer to the Metadata API to return the enabled sites and categories.

• ExtendedProducerResponsibility: This container field provides information about the producer of the new item. This includes producer, packaging, shipment packaging, and added documentation IDs, and the EcoParticipationFee.
• VariationExtendedProducerResponsibility: This container field defines variation-specific Extended Producer Responsibility information, specifically the EcoParticipationFee in add, revise, relist, or verify calls.

Changed Functionality - 1235

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 1235

Below is the list of the new error messages that rolled out with the 1235 release. All of these messages are related to using Extended Producer Responsibility. The long version of each message is used below.

• (Warning) 21920322: replaceable_value is not applicable and has been dropped.
• (Error) 21920323: replaceable_value is required for this category.
• (Warning) 21920324: Eco Participation Fee is not applicable for the condition and has been dropped.
• (Error) 21920325: Eco Participation Fee is not valid and needs to be a number between replaceable_value and replaceable_value.
• (Error) 21920326: replaceable_value is not valid.
• (Error) 21920327: replaceable_value cannot be revised if the item has a bid or is ending within 12 hours.replaceable_value business day(s).
• (Warning) 21920328: Same policy ID(ies) replaceable_value cannot be specified multiple times.
• (Error) 21920329: Only replaceable_value policies can be specified, But given policies are replaceable_value.
• (Error) 21920330: The specified replaceable_value policy(ies) replaceable_value are not found.
• (Error) 21920331: The policy(ies) replaceable_value is not of type replaceable_value.
• (Warning) 21920332: Item level Eco Participation Fee will be ignored for MSKU items.

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

Documentation Changes and Errata - 1235

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

None for this release.

Version 1225

Index of Changed Calls - 1225

Schema Changes - 1225

Announcements - 1225

New Features - 1225

Changed Functionality - 1225

Documentation Changes and Errata - 1225

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

Index of Changed Calls - 1225

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

• GetAccount
• GetItemTransactions
• GetOrders
• GetOrderTransactions
• GetSellerTransactions

Schema Changes - 1225

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.

Announcements - 1225

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

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

None for this release.

Changed Functionality - 1225

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.

eBay France's VAT ID to be Returned in Order Management Calls

When VAT is applicable to an order, a buyer's VAT Identifier Number (VATIN) will be returned at the order level, and eBay's VAT tax ID will be returned at the line item level for all order management calls. With Version 1225, France VAT IDs will start being returned.

A new value, VAT_ID, will be returned as the name attribute in the Transaction.eBayCollectAndRemitTaxes.eBayReference field, and this value will indicate that the VAT ID is for eBay France. The Order.BuyerTaxIdentifier.ID field will show the VATIN for the buyer.

Two Enums Added to TaxTypeCodeType for EU VAT Tax

Two new enumeration values were added to TaxTypeCodeType. The values in this type are returned in the TaxDetails.Imposition field in order management calls. Below are the two new values:

• ImportVAT: this value indicates that French VAT tax was charged to the buyer against the order line item.
• VAT: this value indicates that VAT tax was charged to the buyer against the order line item on the UK marketplace, the Norway marketplace, or other EU marketplace (except for France).

Authenticity Guarantee Service Costs Returned in Order Management Calls

A new ServiceCost container will get returned for items going through the Authenticity Guarantee process. The cost shown in this container is the service cost charged to the buyer for an item that will go through the Authenticity Guarantee process.

Authenticity Guarantee service is only applicable to luxury watches, handbags, and sneakers categories.

Documentation Changes and Errata - 1225

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

The SpecifiedInvoice Option in GetAccount Marked as Deprecated

The SpecifiedInvoice value, defined in AccountHistorySelectionCodeType, can no longer be used in the AccountHistorySelection field of GetAccount. Support for this value was actually stopped in Version 1131, but the documentation was not updated to state this until now. As an alternative to SpecifiedInvoice, the BetweenSpecifiedDates value can be used instead.

Version 1221

Index of Changed Calls - 1221

Schema Changes - 1221

Announcements - 1221

New Features - 1221

Changed Functionality - 1221

Documentation Changes and Errata - 1221

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

Index of Changed Calls - 1221

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

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

None for this release.

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

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

None for this release.

Changed Functionality - 1221

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.

Changes to Refurbished Item Conditions in Category 9355

Condition ID 2500 ('Seller Refurbished') can no longer be used in the Cell Phones & Smartphones category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. In lieu of the 'Seller Refurbished' item condition in category 9355, sellers will have to get pre-qualified for and start using one of the following refurbished item conditions: condition ID 2010 ('Excellent - Refurbished'), condition ID 2020 ('Very Good - Refurbished'), and condition ID 2030 ('Good - Refurbished'). Any seller who is not eligible to use these new refurbished item conditions in category 9355 will be blocked if they try to create a new listing or revise an existing listing with any of these three new item conditions. Any active listings in category 9355 that had condition ID 2500 ('Seller Refurbished') as the item condition should have been administratively ended by eBay. Sellers will have to relist these items, and unless they are eligible to list with the new refurbished item conditions, they will need to use another item condition supported in category 9355, such as condition ID 3000 ('Used').

GetCategoryFeatures Updated to Return New Refurbished Item Conditions

GetCategoryFeatures was updated to start returning the three new refurbished item condition values, which are condition ID 2010 ('Excellent - Refurbished'), condition ID 2020 ('Very Good - Refurbished'), and condition ID 2030 ('Good - Refurbished'). Similar to condition ID 2000 ('Certified - Refurbished'), the new refurbished item condition values are returned in the SpecialFeatures container (instead of the ConditionValues container) to indicate that sellers must be pre-qualified to use these item conditions.

Currently, these refurbished item conditions are only applicable for the Cell Phones & Smartphones category (category ID 9355) and for the following marketplaces: US, Canada, UK, Germany, and Australia.

New and Updated Error Codes for 1221

The text of the following existing error code was updated. The long version of message is used below.

• (Error) 12320: The deposit amount must be replaceable_value or less.

Below is the list of the new error messages that rolled out with the 1221 release. All of these messages are related to using refurbished item conditions. The long version of each message is used below.

• (Error) 21920311: Seller is not eligible to use Refurbished Item Condition in this Category.
• (Error) 21920312: Seller is not eligible to use Refurbished Item Condition for the selected Brand.
• (Error) 21920313: When listing an item with Refurbished condition, replaceable_value cannot be used in the Title.
• (Error) 21920314: When listing an item with Refurbished condition, replaceable_value cannot be used in the Subtitle.
• (Error) 21920315: When listing an item with Refurbished condition, at least replaceable_value image(s) must be provided.
• (Error) 21920316: When listing an item with Refurbished condition, maximum handling time must be replaceable_value business day(s).
• (Error) 21920317: When listing an item with Refurbished condition, free shipping must be provided.
• (Error) 21920318: When listing an item with Refurbished condition, returns must be accepted.
• (Error) 21920319: When listing an item with Refurbished condition, refund must be provided as Money Back.
• (Error) 21920320: When listing an item with Refurbished condition, the minimum time you'll accept returns must be replaceable_value days.
• (Error) 21920321: When listing an item with Refurbished condition, seller must pay the cost for return shipping.

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

Documentation Changes and Errata - 1221

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

Added Some Clarification for the Reserve Price Fee

Updated the Item.ReservePrice field description (used by Add/Revise/Relist calls) to make it more clear about the fee structure and policy used for the reserve price feature.

Updated Numerous Add/Revise/Relist/Verify Call Samples

Made numerous updates to Add/Revise/Relist/Verify call samples in the reference docs. Two high-level updates included adding the required item specifics for the specified category, and also removing PayPal and payment-related fields that are no longer needed for sellers onboarded for managed payments.

Version 1217

Index of Changed Calls - 1217

Schema Changes - 1217

Announcements - 1217

New Features - 1217

Changed Functionality - 1217

Documentation Changes and Errata - 1217

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

Index of Changed Calls - 1217

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

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

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.

ReviseCheckoutStatus Call Decommissioned

The ReviseCheckoutStatus call was decommissioned on July 31, as scheduled. This call and all of its exclusively used types and fields have been removed from the schema and reference documentation.

eBay recommends that sellers use the CompleteSale call to update the status and/or details of orders.

Sellers can also use the createShippingFulfillment method of the Fulfillment API to provide shipment tracking information for one or more line items of a paid order.

New Features - 1217

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

None for this release.

Changed Functionality - 1217

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 and Revised Error Messages

Below is the list of new error messages that rolled out with the 1217 release:

• (Error) 21920308: Unable to create Business Policies for this listing. The call to underlying service did not succeed.
• (Warning) 21920310: Lot Size is not applicable for Multi-SKU listings.

Below is an existing error message whose text was revised with the 1217 release:

• (Warning) 21920306: Seller is not eligible to use replaceable_value condition either for this site or for the category selected

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

Documentation Changes and Errata - 1217

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

A Clarification Provided on Shipment Tracking Number

A note was added to the ShipmentTrackingDetails.ShipmentTrackingNumber field description informing users that the Trading API only supports alphanumeric characters in shipment tracking numbers.

A Clarification on Managed Payments Sellers Providing Offline Payment Methods

Updated the notes in numerous payment method-related fields to make it clear that offline payment methods will need to be provided by managed payments sellers for listings that require or support offline payment methods. An example of this would be a motor vehicle listing. Generally, the full payment of a motor vehicle happens offline between the buyer and seller, so the seller has to provide the available offline payment methods such as Money Order, Cashier's Check, Loan Check, etc.

Removed Notes on Integrated Merchant Credit Card Account Fields

Sellers have not been allowed to use Integrated Merchant Credit Card (aka iMCC) payment gateway accounts to handle buyer payments since May 2019. Many iMCC fields had notes explaining that these payment gateway accounts were no longer supported, but these notes have been removed and these fields have been marked as no longer applicable.

Update to some Charity-Related Fields

Some Charity-related field descriptions said that PayPal had to be used to purchase items in charitable listings, but this is not correct. Any form of electronic payment available to the buyer can be used to purchase these items, and the charitable donation will still go through.