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 on behalf of EU/UK seller. 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.

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

AddDispute
AddDisputeResponse
DisableUnpaidItemAssistance
GetDispute
GetUserDisputes
SellerReverseDispute

2022/09/19

2023/01/31

These six Dispute calls in the Trading API are deprecated and are scheduled for decommission on January 31, 2023.

The DisableUnpaidItemAssistance, AddDisputeResponse, and SellerReverseDispute calls do not have alternative APIs to use since the Unpaid Item Assistant feature and Unpaid Item cases are deprecated. However, there is a page in Selling Preferences in My eBay that allows a seller to cancel and relist any items that have not been paid for after a specified amount of days.

There are REST API equivalents for the other three calls as follows:

Charity API

getCharityOrgByLegacyId

2022/09/12

2023/01/16

The getCharityOrgByLegacyId method requires a PayPal Giving Fund ID to retrieve an eBay charitable organizaiton, and eBay will no longer support these IDs beginning on January 16, 2023. The alternative to this method is the getCharityOrg method, and this method requires the eBay-generated ID for a charitable organization.

Trading API

GetStorePreferences
SetStorePreferences

2022/08/23

2022/09/30

GetStorePreferences and SetStorePreferences are deprecated and are scheduled for decommission on September 30, 2022. Vacation settings are no longer set through the Edit store page in My eBay, but are set up through the Time Away section. For more information on setting up Time Away settings, see the Time Away help page.

Trading API

GetApiAccessRules

2022/08/22

2023/03/10

GetApiAccessRules is deprecated and is scheduled for decommission on March 10, 2023. Starting on August 22, 2022, this call will only return the ApplicationAggregate container, and no usage data on specific Trading calls. Going forward, we recommend that you make plans to migrate to the Developer Analytics API, an API that retrieves all usage data on all RESTful APIs and the Trading API.

Shopping API

The CharityNumber field returned in the following calls:

GetSingleItem
GetMultipleItems

2022/07/28

2023/01/16

The CharityNumber field will stop being returned in the GetSingleItem and GetMultipleItems calls after January 16, 2023. This field is used to specify the PayPal Giving Fund identifier of a non-profit organization and the CharityID field is used to specify the unique eBay-generated identifier of a non-profit organization. All non-profit organizations registered as a charity organization on eBay's platform have both identifiers, but the eBay ID should start being used exclusively going forward.

Trading API

Charity.ExternalID field returned in the GetCharities call.

2022/07/28

2023/01/16

The Charity.ExternalID field will stop being returned in the GetCharities call after January 16, 2023. The Charity.ExternalID field is used to specify the PayPal Giving Fund identifier of a non-profit organization and the id attribute of the root Charity field is used to specify the unique eBay-generated identifier of a non-profit organization. All non-profit organizations registered as a charity organization on eBay's platform have both identifiers, but the eBay ID should start being used exclusively going forward.

Trading API

GetStoreCustomPage
GetStoreOptions
SetStore
SetStoreCustomPage

2022/07/20

2022/09/30

These four Store calls in the Trading API are scheduled for decommission on September 30, 2022. These four calls are primarily used to create, modify, and retrieve custom store pages, and the new Stores platform no longer supports custom store pages, but only customized store categories and vacation settings. 

Trading API

The following containers and fields in the GetStore call:

CustomHeader (string)
CustomHeaderLayout (enum)
CustomListingHeader (whole container)
ExportListings (boolean)
HeaderStyle (enum)
HomePage (long)
ItemListLayout (enum)
ItemListSortOrder (enum)
Logo.LogoID (int)
Logo.Name (string)
Theme (whole container)
TitleWithCompatibility (boolean)

2022/07/20

2022/09/30

The new Stores platform no longer supports custom store pages and other customization functionality, so the noted containers and fields in the GetStore call response payload are scheduled for decommission on September 30, 2022.

The Store data that will still be returned in this call's response include store category/hierarchy information, store name, store description, store URL, and store subscription level.

Trading API

CharityNumber field used by the following calls:

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

2022/06/23

2023/01/16

The CharityNumber field is used by the AddItem family of calls to specify a non-profit organization that will receive sale proceeds from the listing. The CharityNumber field is used to specify the PayPal Giving Fund identifier of a non-profit organization and the CharityID field is used to specify the unique eBay-generated identifier of a non-profit organization. All non-profit organizations registered as a charity organization on eBay's platform have both identifiers, but the CharityNumber field will stop being accepted after January 16, 2023.

CharityNumber will also stop being returned in GetBidderList, GetItem, GetOrderTransactions, and GetSellerList after January 16, 2023, and it will be removed from the Trading WSDL.

Trading API

BuyerRequirementDetails container used by the following calls:

AddFixedPriceItem
AddItem
AddItems
RelistItem
ReviseItem
ReviseFixedPriceItem
RelistFixedPriceItem
VerifyAddFixedPriceItem
VerifyAddItem
VerifyRelistItem

2022/06/09

2022/10/07

The BuyerRequirementDetails container (and children) for Add/Revise/Relist calls will be decommisioned, as listing-level buyer requirements will no longer be supported. If this container is used for Add/Revise/Relist calls after it has been decommisioned, it will be ignored and dropped, and a warning message will be returned to the seller. For 'GET' calls, the container will still be returned if Buyer Requirements are set at the account level.

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.