Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

The table below lists the API capabilities that are deprecated and scheduled for decommission.

API Method(s)/Field(s) Deprecation Date Decommission Date Notes
Trading API

GetSellerDashboard

2023/05/12

2024/04/02

The GetSellerDashboard call of the Trading API will be decommisioned on April 2, 2024. The alternative for this API is Seller Standards Profile methods of the Seller Analytics API.

Trading API

The following calls have multiple fields being deprecated:

2023/05/03

2024/01/31

Numerous fields in the response payloads of the GetOrders, GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling calls are being deprecated. See the Deprecated Trading Order Management Fields document for the complete list of deprecated fields and reasons for deprecation.

Trading API

GetMyeBayReminders

2023/05/02

2023/07/17

The GetMyeBayReminders call of the Trading API will be decommisioned and removed from WSDL and docs on July 17, 2023. This call had very little traffic or adoption, and only showed counts for different categories of selling/buying reminders with no other data. Instead of this API, buyers and sellers can go to My eBay to see all of their selling/buying reminders.

Trading API

AddTransactionConfirmationItem

GetContextualKeywords

2023/05/02

2023/06/05

The AddTransactionConfirmationItem and GetContextualKeywords calls of the Trading API will be decommisioned and removed from WSDL and docs on June 5, 2023. The features associated with these API calls are no longer supported, so these calls no longer have any purpose.

Trading API

PictureDetails.PhotoDisplay field in the following calls:

2023/04/24

2023/07/31

Since all sellers on all eBay marketplaces now get all picture features and functionality (like Super Size/Zoom) at no extra cost, the PictureDetails.PhotoDisplay field in Add/Revise/Relist/Verify calls is longer required to be included in request payload. This field will be removed from the schema and docs on July 31, 2023.

If this field is passed in now, it does not have an effect. If this field is passed in after the decommission date, a generic warning message will be returned that indicates that the element is not recognized.

After decommission date, this field will stop being displayed in GetBidderList and GetItem responses.

Trading API

GetCharities

2023/04/17

2023/09/18

The GetCharities call of the Trading API will be decommisioned on September 18, 2023. The alternative for this API is Charity API, which has a getCharityOrg method to retrieve details on a specific Charity, and a getCharityOrgs method to retrieve multiple charities based on search filters.

Account API

X-EBAY-C-MARKETPLACE-ID request header in the createCustomPolicy, updateCustomPolicy, getCustomPolicy, and getCustomPolicies methods.

2023/03/14

TBD

As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific). A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.

Due to this change, the X-EBAY-C-MARKETPLACE-ID request header will no longer be relevant. If this header is passed in, it will just be ignored in all four methods.

The getCustomPolicy method can retrieve any global policy, and the getCustomPolicies method will return all global custom policies.

Inventory API

producerProductId, productDocumentationId, productPackageId, and shipmentPackageId fields in the createOffer, bulkCreateOffer, updateOffer, getOffer, and getOffers methods.

2023/02/27

TBD

These four Extended Producer Responsibility IDs will no longer be set at the listing level. Instead, sellers will provide these IDs at the account level when applicable/required. There are no current plans to support these IDs at the account level through an API, so sellers must provide and update these IDs through their eBay account.

Trading API

ProducerProductID, ProductDocumentationID, ProductPackageID, and ShipmentPackageID fields in the AddFixedPriceItem, AddItem, AddItems, GetItem, RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem, ReviseItem, VerifyAddFixedPriceItem, VerifyAddItem, and VerifyRelistItem calls.

2023/02/27

TBD

These four Extended Producer Responsibility IDs will no longer be set at the listing level. Instead, sellers will provide these IDs at the account level when applicable/required. There are no current plans to support these IDs at the account level through an API, so sellers must provide and update these IDs through their eBay account.

Metadata API

No fields will be deprecated, but the getExtendedProducerResponsibilityPolicies method will stop returning category-level metadata for Producer Product ID, Product Documentation ID, Product Package ID, and Shipment Package ID.

2023/02/27

TBD

These four Extended Producer Responsibility IDs will no longer be set at the listing level, and since there are no current plans to support these IDs at the account level through an API, the category-level metadata will stop being returned.

Return Management API

All

2023/02/03

TBD

All methods of the Return Management API are scheduled to be decommisioned. The official decommission date will be announced once determined. This API is now out of synch with return management flows on eBay. Current users of the Return Management API and all users interested is programmatically managing return requests should make plans to migrate to the Post-Order API.

Trading API

GetOrderTransactions

2023/01/31

2024/01/31

The GetOrderTransactions call will be decommissioned on January 31, 2024. No further updates are planned for this API during the deprecation period. Developers have the option of migrating to the GetOrders call in the Trading API, or the getOrders method of the Fulfillment API. Please note that the Fulfillment API only returns paid orders, so if your use case calls for retrieving both paid and unpaid orders, we recommend migrating to the GetOrders call in the Trading API.

Business Policies Management API All 2021/03/23 TBD The Business Policies Management API is deprecated and is scheduled for decommission in 2022. We recommend that you migrate to the fulfillment_policy, payment_policy, and return_policy resources of the Account API to set up and manage all of your fulfillment, payment, and return business policies.
Finding API findCompletedItems 2020/10/15/ TBD The findCompletedItems call is deprecated as of October 15, 2020, and access is restricted. 

An alternative to the findCompletedItems call is the Marketplace Insights API, but please note that this API is restricted and requires eBay Business approval for access. Please contact the Developer Technical Support team if you are interested in getting access to the Marketplace Insights API.