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.

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

API Method(s)/Field(s) Deprecation Date Decommission Date Notes
Client Alerts API

All

2023/03/15

2023/05/31

All methods of the Client Alerts API will be decommisioned on May 31, 2023. The alternative for this API is Platform Notifications, which supports all notification event types supported by Client Alerts API.

For anyone that is not familiar with Platform Notifications, we recommend that you read the Platform Notifications Guide to get started.

Account API

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

2023/03/14

2023/04/03

As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. 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 is no longer relevant. If this header is passed in after April 3, 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

2023/04/03

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

2023/04/03

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

2023/04/03

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.

Resolution Case Management API

All

2023/02/03

2023/06/05

All methods of the Resolution Case Management API will be decommisioned on June 5, 2023. This API is now out of synch with case management flows on eBay. Current users of the Resolution Case Management API and all users interested is programmatically managing and resolving eBay cases should make plans to migrate to the Post-Order API.

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.

Trading API

Store.SubscriptionLevel field returned in the GetStore call.

2022/09/30

2023/03/23

This field is deprecated and will stop being returned beginning on March 31, 2023. The getSubscription method of the Account API can be used to retrieve information on a seller's eBay store subscription.

Marketing API

2022/09/30

2023/04/03

The fundingModels array of the createReportTask method will stop supporting multiple values. During the deprecation period, a warning response header will be returned. After decommission date arrives, using multiple values in fundingModels array will be a blocking error.

Transaction reports will stop supporting the following metric keys: impressions, clicks, ctr, avg_cost_per_sale, pl_transactions, cpc_impressions, cpc_clicks, cpc_ctr, cpc_conversion_rate, cpc_return_on_ad_spend, cpc_avg_cost_per_sale, cpc_transactions, cpc_ad_fees_listingsite_currency, cpc_ad_fees_payout_currency, cost_per_click. During the deprecation period, a warning response header will be returned specifically calling out these deprecated metrics.

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.