Modern APIs Migration Guide
Introduction
This guide is designed to be a high-level reference document to help our developer partners understand the new REST and GraphQL APIs that will ultimately be replacements for our:
- Traditional SOA/XML-based APIs such as Trading API
- Post-Order API method
- Platform Notification events
This guide will cover all traditional API calls, Post-Order methods, and Platform Notification events, and what their REST or GraphQL replacements are. Some traditional APIs and Platform Notification events will not be migrated at all, and if that is the case, we will provide a reason why. We will have some cases where multiple traditional APIs or multiple Platform Notification events have been grouped into one new API operation or into one notification topic, respectively. We will also have some cases where one Traditional API will be split into multiple new APIs.
This guide is grouped into API flows that are similar to the way that we have grouped API flows into the new Guides and Reference docs experience. We will start with Sell-focused APIs, and then move on to Buy-focused APIs. There are some APIs that have use cases for both sell and buy, and when that is the case, they will be covered twice, but may vary a bit based on how they different between the buyer and seller use cases.
Sell APIs
This section is focused on APIs used to support selling flows on eBay.
- Listing Management APIs
- Listing Metadata APIs
- Order Management APIs
- Account Management APIs
- Marketing and Discount APIs
- Communication APIs
- Offers and Leads APIs
Listing Management APIs
The next several sections cover APIs categorized as Listing Management APIs
- AddItem family of calls
- ReviseItem family of calls
- RelistItem family of calls
- Second Chance Offer calls
- EndItem calls
- GetItem family of calls
- Other Listing Management call
AddItem family of calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| AddFixedPriceItem | createListing mutation of the Listing API |
| AddItem | |
| AddItems | |
| VerifyAddFixedPriceItem | |
| VerifyAddItem |
Key things to know about createListing mutation:
- The marketplace field is required to specify the listing marketplace.
- The listingFormat field controls whether the listing will be an auction, fixed price, or classified ad listing.
- The listingDurationInDays field controls the duration of the listing.
- The title field sets the title of the listing.
- The description field sets the description of the listing.
- The categories object is used to provide the primary listing category, and optionally, the secondary listing category, primary eBay store category and secondary eBay store category.
- The imageUrls array is used to provide one or more images for the listing.
- The itemCondition object is used to set the condition of the item.
- The product.aspects array is used to set the aspect name-value pairs (aka item specifics) for the product.
- The items array is used to set the price and quantity of an item, as well as any Global Trade Item Numbers (GTINs) and/or an eBay Product ID (ePID) for a product. If any of these product IDs are input, eBay can attempt to match the product ID to an eBay catalog product and prefill the listing with the catalog product's details.
- For a multiple-SKU listing (aka multiple-variation listing), each variation within the listing will be defined within the items array, and a sku value and the unique traits for each variation are required.
- For a multiple-SKU listing, the listingVariations object is used to provide information on each unique variation within the listing.
- The location of the item is specified through the itemLocation object.
- Like with the Trading API, for sellers opted into Business Policies, Payment, Shipping/Fulfillment, and Return Policy business policies must be used, Payment business policy IDs or payment fields within the request are set through the paymentTerms object, shipping business policy IDs or shipping fields within the request are set through the shippingTerms object, and return policy business policy IDs or return policy fields within the request are set through the returnTerms object.
- The options field can be used to validate the input without actually creating the listing. The options field is included and set to
VALIDATEto run the operation in validation mode. This is an alternative to using the VerifyAddFixedPriceItem or VerifyAddItem calls.
Note: Initially, the createListing mutation will only support the creation of one listing per operation. If you need the ability to create listings in bulk, the Sell Feed API can be considered. See the Creating listings in bulk with the Sell Feed API section in the Listing Creation Guide for more details on adding listings in bulk.
ReviseItem family of calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| ReviseFixedPriceItem | updateListing mutation of the Listing API |
| ReviseItem | |
| ReviseInventoryStatus | bulkUpdateInventory mutation of the Listing API |
| AddToItemDescription | None. The capability of the AddToItemDescription call to append text to the existing description is not being migrated, so a user would need to replace the full text in the description field of the updateListing mutation to make any change to the description. |
Key things to know about updateListing mutation:
- The listingIdentifier object is used to identify the listing to be updated.
- Only fields that are changing need to be included in the mutation.
- For arrays in the mutation, a complete replacement is done, so all values and/or name value pairs must be included, and not just the ones that are being added or changed. An example of this would be the imageUrls array and the product.aspects array. Behavior can vary slightly based on the array, so be sure to check reference documentation to read about behavior of arrays.
- Some changes to auction listings will not be allowed when the listing is scheduled to end within 12 hours, and some changes to fixed price listings are not allowed if that particular listing has already had one or more sales. The Revise a listing help topic is a very good resource to view these restrictions on revisions.
Key things to know about bulkUpdateInventory mutation:
- The price and/or quantity of up to four items in fixed price listings can be updated with this mutation.
RelistItem family of calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| RelistFixedPriceItem | relistListing mutation of the Listing API |
| RelistItem | |
| VerifyRelistItem |
Key things to know about relistListing mutation:
- The listingIdentifier object is used to identify the listing to be relisted.
- Only fields that are changing need to be included in the mutation.
- For arrays in the mutation, a complete replacement is done, so all values and/or name value pairs must be included, and not just the ones that are being added or changed. An example of this would be the imageUrls array and the product.aspects array. Behavior can vary slightly based on the array, so be sure to check reference documentation to read about behavior of arrays.
- To replicate the behavior of VerifyRelistItem, the operationMode field must be included and set to
VALIDATE.
Second Chance Offer calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| AddSecondChanceItem | createSecondChanceListing mutation of the Listing API |
| VerifyAddSecondChanceItem |
Key things to know about createSecondChanceListing mutation:
- The listingIdentifier object is used to identify the ended auction listing where the seller will propose.a Second Chance Offer to a competitive bidder on that listing.
- The price and duration is specified in the listingTerms object.
- The user is identified through the recipientUserId field.
- To replicate the behavior of VerifyAddSecondChanceItem, the operationMode field must be included and set to
VALIDATE.
End Item calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| EndItem | endListing mutation of the Listing API |
| EndFixedPriceItem | |
| EndItems |
Key things to know about endListing mutation:
- The listingIdentifier object is used to identify the listing to end
- The reason why the seller is ending the listing should be provided in the endListingReason field
Note: Initially, the endListing mutation will only support the ending of one listing per operation. If you need the ability to end listings in bulk, the Sell Feed API can be considered. See the Ending listings in bulk using Sell Feed API section in the Listing Management Guide for more details on ending listings in bulk.
Get Item family of calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| GetItem | sellerListings query of the Listing API |
| GetMyeBaySelling | sellerListingSearch query of the Listing API |
| GetSellerList | |
| GetSellerEvents |
Key things to know about sellerListings query:
- The listingId field is used to identify the listing to retrieve
- Initially, only one listing may be retrieved per operation
Key things to know about sellerListingSearch query:
- Three different date range filters are available. Use startAtRange filter to search for listings that started within a date range, use modifiedAtRange filter to search for listings that were last modified within a date range, and use endAtRange filter to search for listings that were ended within a date range.
- The formatType filter is used to retrieve only listings of a specific format.
- The primaryCategoryIds array is used to retrieve only listings listed in one more specific eBay categories.
- The listingIds and skus array are used to retrieve one or more specific listings. If these filters are used, other filters should not be used.
- Pagination and sort options are available.
- In the response, listings that match the filter criteria are categorized into activeListings, endedListings, and scheduledListings arrays.
Other Listing Management calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| UploadSiteHostedPictures | createImageFromFile method of Media API |
| createImageFromUrl method of Media API | |
| GetAllBidders | itemBiddingActivity query of Auction API |
| GetDescriptionTemplates | None This API retrieves a gallery of decorative Listing Designer templates created by eBay, but these are no longer supported. |
Key things to know about createImageFromFile method:
- With this method, an image is uploaded to the seller's account using multipart/form-data, and a successful operation will return an imageUrl field with the eBay Picture Service (EPS) URL that can be used in add/revise/relist operation.
- A successful operation will also return the getImage URI in the Location header. The imageId value for the uploaded image will be included in the getImage URI, and it is strongly recommended that developers save/store this getImage UR or imageId value because getImage will need to be called to get the imageUrl, and this is the URL that is needed to add an image to a listing.
- The image formats supported are JPG, GIF, PNG, BMP, TIFF, AVIF, HEIC, and WEBP.
Key things to know about createImageFromUrl method:
- With this method, an imageUrl is provided (must use 'https' protocol) in the request payload that is a URL to a seller-hosted image that eBay will download from that URL and create an EPS version of the image and.upload to the seller's account. A successful operation will return an imageUrl field with the eBay Picture Service (EPS) URL that can be used in add/revise/relist operation.
- A successful operation will also return the getImage URI in the Location header. The imageId value for the uploaded image will be included in the getImage URI, and it is strongly recommended that developers save/store this getImage UR or imageId value because getImage will need to be called to get the imageUrl, and this is the URL that is needed to add an image to a listing.
- The image formats supported are JPG, GIF, PNG, BMP, TIFF, AVIF, HEIC, and WEBP.
Key things to know about itemBiddingActivity query:
- This query can be used by any eBay user, but the owner of the listing will get the most extensive data returned in the response.
- The itemId field is used to identify the auction item for which to retrieve bidding activity.
- This query does not have equivalent fields to the IncludeBiddingSummary and CallMode fields in GetAllBidders, but the data to be retrieved in all Graph QL queries can be fully customized, so a user will just specify the objects they'd like to see in the response, including activeBidHistoryRecords, cancelledBidHistoryRecords, etc.
- The data available to return is controlled by OAuth scopes. See the documentation for more information.
Listing Metadata APIs
- Taxonomy calls
- Category feature calls
- Site-level metadata calls
- eBay Catalog calls
- Parts compatibility calls
Taxonomy calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| GetCategories (Decommissioned April 15, 2026) | getDefaultCategoryTreeId method of Taxonomy API to get category tree ID |
| getCategoryTree method of Taxonomy API to get full category tree | |
| getCategorySubtree method of Taxonomy API to get a subset of the category tree, starting at any category level | |
| getCategoryPolicies method of Metadata API for all site-level data points. |
Note: See the GetCategories Migration Guide for more details and full mappings.
Category feature calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| GetCategoryFeatures (Decommissioned on June 4, 2026) | getItemConditionPolicies method of Metadata API to get item condition information for leaf categories on a marketplace |
| getListingTypePolicies method of Metadata API to get supported durations for different listing types | |
| getReturnPolicies method of Metadata API to get return policy metadata for leaf categories on a marketplace | |
| getListingStructurePolicies method of Metadata API to see which leaf categories on a marketplace support variations | |
| getNegotiatedPricePolicies method of Metadata API to see which leaf categories on a marketplace support Best Offers | |
| getMotorsListingPolicies method of Metadata API to get Motors-related metadata for leaf categories on a marketplace | |
| getAutomotivePartsCompatibilityPolicies method of Metadata API to get compatibility-related metadata for leaf categories on a marketplace | |
| getClassifiedAdPolicies method of Metadata API to get classified ad-related metadata for leaf categories on a marketplace | |
| getSiteVisibilityPolicies method of Metadata API to see which leaf categories support exposing listings on other marketplaces for a fee | |
| getItemAspectsForCategory method (or use fetchItemAspects method with Taxonomy SDK) of Taxonomy API can be used to get see which leaf categories require a specific GTIN value or Brand/MPN |
Note: See the GetCategoryFeatures Migration Guide for more details and full mappings. All of the category-level metadata returned in GetCategoryFeatures is covered in that guide. Additionally, it covers the fields that will not be migrated and the reason why.
Key things to know about the Metadata API methods:
- The eBay marketplace is set through a marketplace_id path parameter and not through a HTTP header, and these eBay marketplaces are defined in this Marketplace ID vaues table.
- The default behavior the Metadata API methods is to retrieve metadata from all leaf categories on the specified marketplace, but users can use the filter query parameter to specify anywhere from 1 to 50 leaf category IDs to restrict retrieved metadata to those leaf categories
Key things to know about Taxonomy API methods:
- Both the getItemAspectsForCategory and fetchItemAspects methods require a category tree identifier through the category_tree_id path parameter. The ID associated with each marketplace can be retrieved using the getDefaultCategoryTreeId method.
- The getItemAspectsForCategory method can only retrieve metadata on one leaf category per operation, and this leaf category is specified through the category_id query parameter.
- A successful fetchItemAspects method retrieves a binary version of a gzipped JSON file, and once extracted, this file will contain metadata on all leaf categories for a marketplace.
- The fetchItemAspects method can be paired together with the open source Taxonomy SDK to compare the aspect metadata that is returned in this response for each subsequent fetchItemAspects operation. The Taxonomy SDK uses the fetchItemAspects method to surface changes (new, modified, and removed entities) between an updated version of a bulk downloaded file relative to a previous version.
Site-level metadata
Key things to know about the Metadata API methods:
- The eBay marketplace is set through a marketplace_id path parameter and not through a HTTP header, and these eBay marketplaces are defined in this Marketplace ID vaues table.
- The getSalesTaxJurisdictions method requires a countryCode path parameter, and the only supported values are US and CA, as a seller can only configure/set sales tax rates for five US territories (no US states or D.C.) and Canadian provinces.
See below for the full list of GeteBayDetails metadata groups that will not be carried over into new modern APIs, and the reasons why:
- BuyerRequirementDetails - listing-level Buyer Requirements are no longer supported, but the seller can only set/modify these settings in My eBay
- CountryDetails - these are just ISO 3166 country codes that can be retrieved and maintained by using the standards doc or a tool.
- ItemSpecificDetails - all of these threshold values are stable across all eBay marketplaces and have not had a single change since 2010. These thresholds will be covered in supporting docs instead
- ListingFeatureDetails - this metadata is no longer needed since Bold Titles is the only supported feature out of the eight features that are returned, and Bold Titles are supported on all eBay marketplaces
- ProductDetails - the text used for each marketplace when a GTIN is unknown/not applicable does not change, and all values are documented here: /api-docs/sell/static/inventory/product-identifier-text.html
- RecoupmentPolicyDetails - this metadata is no longer applicable
- RegionDetails - the region IDs are no longer supported
- ShippingCategoryDetails - the shipping speed/level metadata is only informational and is not used anywhere in listing flows
- TimeZoneDetails - timezone data is not eBay-specific data and other tools and libraries can be used for this data
- URLDetails - default root URLs will not be migrated
- VariationDetails - all of these threshold values are stable across all eBay marketplaces and have not had a single change since 2013. These thresholds will be covered in docs instead
eBay catalog calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| findProducts (To be decommissioned on August 17, 2026) | search method of Catalog API |
| getProductDetails (To be decommissioned on August 17, 2026) | getProduct method of Catalog API. The eBay Product ID (ePID) is passed in as path parameter |
Key things to know about the search method:
- The q query parameter is used to specify a search string, and eBay will scan the title, description, and item specifics fields in listings looking for matches.
- If a user has a GTIN value, the gtin query parameter can be used to specify that GTIN ID to see if an eBay catalog product match is found.
- The mpn query parameter can also be used to specify a Manufacturer Part Number, but this filter must be paired up with the q query parameter, where the user will generally pass in the brand of the part.
- The aspect_filter query parameter allows the user to specify one or more item specific name-value pairs as part of the search.
- The category_ids query parameter is used to retrieve only products associated with specific eBay categories.
- The fieldgroups query parameter is used to control the type and amount of data that is retrieved for products.
- The limit query parameter is used to control the maximum number of products retrieved per page of data, and the offset query parameter determines which page of data is retrieved.
Parts compatibility calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| getCompatibilitySearchNames | getCompatibilityPropertyNames method of Metadata API |
| getCompatibilitySearchValues | getCompatibilityPropertyValues method of Metadata API |
| getCompatibilitySearchValuesBulk | getMultiCompatibilityPropertyValues method of Metadata API |
| getProductCompatibilities | getProductCompatibilities method of Metadata API |
| getCompatibilitySearchDataVersion | No direct replacement, but both the getCompatibilityPropertyValues and getMultiCompatibilityPropertyValues return a metadataVersion value in the response. |
Key things to know about the methods under the compatibilities resource of the Metadata API:
- The X-EBAY-C-MARKETPLACE-ID header is needed to identify the eBay marketplace from which metadata will be retrieved. Compatibility methods will only retrieve data for marketplaces that support parts compatibility
- The leaf category is specified through the categoryId field.
- With the getCompatibilitySearchValues method, a property name such as Make or Model must be input into the propertyName field to retrieve the values for that property name on that marketplace.
- The propertyFilters array in the getCompatibilitySearchValues method is used to further filter the property values that will be returned. For example, you might want to only see the vehicle Makes from the year 1957, so you would include the propertyName field and set it to “Year” and include the propertyValue field and set it to “1957”.
- The getCompatibilitySearchValuesBulk method works similarly to the getCompatibilitySearchValues method, except that multiple property names such as Make, Model, and Year can be specified through the propertyNames array, and then each vehicle that matches the specified attributes is returned under a separate compatibilityDetails node.
- The getProductCompatibilities method requires that a motor vehicle part or accessory is identified through the productIdentifier container using an ePID or a GTIN ID. This method also has filters, pagination, and sorting available.
Order Management APIs
Through new GraphQL APIs and operations, paid orders and unpaid orders (also called item commitments) will be split into two different entities,
- Orders
- Item Commitments.
A Purchase Quote entity has also been created, and this entity is used when two or more item commitments are combined together so that a buyer can make one payment for multiple item commitments, and a Purchase Quote can also be created even for one item commitment when the buyer requests an updated invoice or when the seller sends one to the buyer as a reminder for payment.
Note: The TransactionID field was not migrated over to existing REST APIs, and this field and concept will also not be migrated over to GraphQL APIs. The orderLineItemId field is the replacement.
- Trading API order retrieval calls
- Trading API after-sale calls
- Post-Order Cancellation APIs
- Post-Order Return APIs
- Post-Order Case APIs
- Post-Order Inquiry APIs
Post-Order Cancellation APIs
Trading API order retrieval calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| GetOrders and GetSellerTransactions (paid orders/line items) |
orders query of Order API |
| ordersByIds query of Order API | |
| orderLineItemsByIds query of Order API | |
| getOrders and getOrder methods of Fulfillment API | |
| GetOrders and GetSellerTransactions (unpaid orders/line items) |
itemCommitments query of Item Commitment API |
| itemCommitmentsByIds query of Item Commitment API | |
| GetItemTransactions (paid orders/line items) | orders query of Order API, specifying the listing through the listingId field and including the includeConfirmed field and setting value to true |
| itemCommitments query of Item Commitment API, specifying the listing through the listingId field and including the includeCompleted field and setting value to true | |
| GetItemTransactions (unpaid orders/line items) | itemCommitments query of Item Commitment API, specifying the listing through the listingId field |
Key things to know about the Order API queries:
- These queries are for paid orders only, and will not retrieve unpaid item commitments.
- The dateTimeRange object of the orders query is used to specify a data range for which to retrieve orders, and the dateType field indicates whether the date range applies to order creation date or to the last modification date.
- The filter object contains a listingId field that allows a user to retrieve orders from a specific listing, and numerous boolean fields that control the orders that are returned in regards to order state, such as confirmed, cancelled, or fulfilled orders.
- The sort object allows the user to sort according to order creation date or last modified date.
- The ordersPage object allows the user to set the maximum number of orders returned per page or to pass in a pageCursor string value to retrieve the next or previous page of orders.
- The ordersByIds query can retrieve up to 100 specific orders by passing order ID values into the orderIds array.
- The orderLineItemsByIds query can retrieve up to 100 specific order line items by passing order line item ID values into the lineItemIds array.
Key things to know about the Item Commitment API queries:
- These queries are for unpaid orders only, which are now referred to as item commitments.
- The dateRange object of the itemcommitments query is used to specify a data range for which to retrieve item commitments, and the dateType field indicates whether the date range applies to item commitment creation date or to the last modification date.
- The filter object contains a listingId field that allows a user to retrieve item commitments from a specific listing, and numerous boolean fields that control the item commitments that are returned in regards to state, such as active, cancelled, or completed item commitments.
- The sort object allows the user to sort according to item commitment creation date or last modified date.
- The itemCommitmentsPage object allows the user to set the maximum number of item commitments returned per page or to pass in a pageCursor string value to retrieve the next or previous page of item commitments.
- The itemCommitmentsByIds query can retrieve up to 100 specific item commitments by passing item commitment ID values into the itemCommitmentIds array.
Trading API after-sale calls
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| CompleteSale (mark item commitments as paid) |
markItemCommitmentsPaid of Item Commitment API |
| CompleteSale (mark offline orders as paid) |
markOrdersPaid mutation of Order API. |
| CompleteSale (provide feedback for an order partner) |
leaveFeedback method of Feedback API |
| CompleteSale (provide shipment tracking information) |
createShippingFulfillment method of Fulfillment API |
| CompleteSale (provide shipment tracking information for INR inquiry) |
provideShipmentInfoForItemNotReceivedInquiry mutation of Order Inquiry API |
| AddOrder | createPurchaseQuote mutation of Purchase Quote API |
| SendInvoice | createPurchaseQuote mutation of Purchase Quote API |
| bulkupdatepurchasequotes mutation of Purchase Quote API |
Key things to know about the Purchase Quote API mutation:
- The createPurchaseQuote mutation can be used to:
- combine multiple unpaid line items into one purchase quote requiring one payment from the buyer
- remind the buyer about payment for a single line item order
- provide the buyer with an update about any cost adjustments for a single or multiple line item order ,
- The item commitment(s) that will be in the new purchase quote are identified through the itemCommitmentId array of the createPurchaseQuote mutation
- The bulkupdatepurchasequotes mutation is used to update one or more purchase quotes, and the purchase quote is identified through the purchasequoteid field
- The fields of the bulkupdatepurchasequotes mutation are basically the same as the createPurchaseQuote mutation. Below are some of the fields that are used:
- Use the logisticsOptions.shipping array to provide the shipping cost for the order and the shipping service option that will be used
- Use the total object to add any additional shipping/handling related charges and/or any applicable shipping discounts
- Use the messageToBuyer field to provide a custom message about combining the line items into one order
Post-Order Cancellation APIs
With the exception of a single query to retrieve a specific Cancellation request, all buyer-facing Post-Order API Cancellation operations will not get migrated to any new modern APIs. Additionally, some low-usage APIs that could be used by sellers or buyers have also been decommissioned or are scheduled for decommission. See the Decommissioned methods section for a full list of methods that have decommissioned since the start of 2025.
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| Approve Cancellation | approveContractCancellation mutation of the Cancellation API |
| Check Cancellation Eligibility | None If an item is not eligible for a cancellation, a business error will occur when the user attempts to create a cancellation request through any of the new GraphQL cancellation mutations. |
| Create Cancellation Request | createItemCommitmentCancellation mutation of Cancellation API |
| createOrderCancellation mutation of Cancellation API | |
| createPurchaseQuoteCancellation mutation of Cancellation API | |
| Get Cancellation | contractCancellation query of the Cancellation API |
| Reject Cancellation | declineContractCancellation mutation of Cancellation API |
| Search Cancellations | sellerContractCancellations query of Cancellation API |
Post-Order Return APIs
With the exception of a single query to retrieve a specific Return Request, all buyer-facing Post-Order API Return operations will not get migrated to any new modern APIs. Additionally, some low-usage APIs that could be used by sellers or buyers have also been decommissioned or are scheduled for decommission. See the Decommissioned methods section for a full list of methods that have decommissioned since the start of 2025.
There will no longer be a Case entity but both the Return and Order Inquiry APIs will have mutations to escalate a return request or an Item Not Received (INR) inquiry to eBay, respectively, or to appeal an eBay decision on a case.
Post-Order Case APIs
A separate Case entity is not being migrated to the new GraphQL APIs, but instead, INR inquiry cases are being migrated to the Order Inquiry API, and return cases are being migrated to the Return API.
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| Appeal Case Decision (INR case) |
submitOrderInquiryReferral mutation of Order Inquiry API. |
| Appeal Case Decision (Return case) |
submitReturnReferral mutation of Return API |
| Get Case (INR case) |
orderInquiry query of Order Inquiry API. Case information is returned if there is a case filed against the inquiry |
| Get Case (Return case) |
orderReturn query of Return API. Case information is returned if there is a case filed against the return |
| Issue Case Refund (INR case) |
processOrderInquiryRefund mutation of Order Inquiry API |
| Issue Case Refund (Return case) |
processReturnRefund mutation of Return API |
| Provide Case Shipment Info | provideShipmentInfoForItemNotReceivedInquiry mutation of Order Inquiry API |
| Provides Return Address | None No direct equivalent, and alternative return addresses can only be added in My eBay. |
| Search Cases (INR case) |
sellerOrderInquiries query of Order Inquiry API. Case information is returned if there is a case filed against the inquiry |
| Search Cases (Return case) |
sellerOrderReturns query of Return API. Case information is returned if there is a case filed against the return |
Post-Order Inquiry APIs
With the exception of a single query to retrieve a specific INR inquiry, all buyer-facing Post-Order API operations will not get migrated to any new modern APIs. Additionally, some low-usage APIs that could be used by sellers or buyers have also been decommissioned or are scheduled for decommission. See the Decommed methods section for the full list of methods that have decommissioned since the start of 2025.
There will no longer be a Case entity but both the Return and Order Inquiry APIs will have mutations to escalate a return request or an Item Not Received (INR) inquiry to eBay, respectively, or to appeal an eBay decision on a case.
| Traditional API(s) | Modern Replacement(s) |
|---|---|
| Escalate Inquiry | submitOrderInquiryReferral mutation of Order Inquiry API. |
| Get Inquiry | orderInquiry query of Order Inquiry API. |
| Issue Inquiry Refund | processOrderInquiryRefund method of Order Inquiry API. |
| Provide Inquiry Refund Info | None No direct equivalent for this method, but seller can use the sendOrderInquiryMessage mutation of Order Inquiry API.to update buyer that a refund has been issued |
| Provide Inquiry Shipment Info | provideShipmentInfoForItemNotReceivedInquiry mutation of Order Inquiry API. |
| Search Inquiries | sellerOrderInquiries query of Order Inquiry API. |
| Send Inquiry Message | sendOrderInquiryMessage mutation of Order Inquiry API. |
Account Management APIs
eBay Store calls
The APIs covered in this section include GetUser, GetAccount, GetBidderList, eBay Store calls, seller preferences calls, sales tax calls, and user note calls.
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetStore (Retrieve name, description, logo, URL, and last opened time) |
getStore method of Stores API |
| GetStore (Retrieve the full eBay store category hierarchy.) |
getStoreCategories method of Stores API |
| GetStoreCategoryUpdateStatus | getStoreTask method of Stores API Key behaviors/changes:
|
| SetStoreCategories (Add store category) |
addStoreCategory,method of Stores API Key behaviors/changes:
|
| SetStoreCategories (Move store category) |
moveStoreCategory method of Stores API Key behaviors/changes:
|
| SetStoreCategories ( Rename store category) |
renameStoreCategory method of Stores API Key behaviors/changes:
|
| SetStoreCategories (Delete store category) |
deleteStoreCategory method of Stores API Key behaviors/changes:
|
eBay Seller Preferences calls
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetUserPreferences | getUserPreferences method of Account API v2 Key behaviors/changes:
|
| SetUserPreferences | setUserPreferences method of Account API v2 Key behaviors/changes:
|
Sales tax calls
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetTaxTable | getSalesTaxes method of Account v1 API Key behaviors/changes:
|
| SetTaxTable (Set or modify sales tax settings for one jurisdiction) |
createOrReplaceSalesTax method of Account v1 API Key behaviors/changes:
|
| SetTaxTable (Set or modify sales tax settings for multiple jurisdictions) |
bulkCreateOrReplaceSalesTax method of Account v1 API Key behaviors/changes:
|
Other Account Management calls
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetUser | user query of User API. Key behaviors/changes:
|
| getUser method of Identity API Key behaviors/changes: |
|
| GetUserContactDetails | None; to be decommissioned This call retrieves Personally Identifiable Information (PII) for another eBay user, and that will not be supported.in modern APIs |
| GetAccount | getBillingActivities method of Finances API. Key behaviors/changes:
|
| SetUserNotes (Add or update note) |
createOrReplaceUserNote method of User Note API Key behaviors/changes:
|
| SetUserNotes (Delete note) |
deleteUserNote method of User Note API Key behaviors/changes:
|
| GetBidderList | userBiddingActivity query of Auction API Key behaviors/changes:
|
Marketing and Discount APIs
The following table has the modern API replacements and any relevant notes for each Shipping Discount call. Shipping Discount Profiles are now called Combined Shipping Rules, and the new API methods reflect that name change:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetShippingDiscountProfiles | getCombinedShippingRules method of Account API v2 Key behaviors/changes:
|
| SetShippingDiscountProfiles (Create one or more calculated shipping rules) |
createCalculatedShippingRules method of,Account API v2 Key behaviors/changes:
|
| SetShippingDiscountProfiles (Create one or more flat shipping rules) |
createFlatShippingRules method of,Account API v2 Key behaviors/changes:
|
| SetShippingDiscountProfiles (Create a promotional shipping rule) |
createPromotionalShippingRule method of,Account API v2 Key behaviors/changes:
|
| SetShippingDiscountProfiles (Update one or more calculated shipping rules) |
updateCalculatedShippingRules method of,Account API v2 Key behaviors/changes:
|
| SetShippingDiscountProfiles (Update one or more flat shipping rules) |
updateFlatShippingRules method of,Account API v2 Key behaviors/changes:
|
| SetShippingDiscountProfiles (Update a promotional shipping rule) |
updatePromotionalShippingRule method of,Account API v2 Key behaviors/changes:
|
| SetShippingDiscountProfiles (Update combined payments duration) |
updateCombinedPayments method of,Account API v2 Key behaviors/changes:
|
Communication APIs
Messaging APIs
The alternatives to all Messaging calls in the Trading API will be the new REST-based Message API. Please note that eBay InBox/messaging has changed within the last couple of years, and every message is grouped into a conversation object, even if the conversation only has one message in it. The following table has the modern API replacements for each Messaging call:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| AddMemberMessageAAQToPartner | sendMessage method of Message API Key behaviors/changes:
|
| AddMemberMessageRTQ | |
| AddMemberMessagesAAQToBidder | |
| GetMyMessages | getConversations method of Message API Key behaviors/changes:
|
| getConversation method of Message API Key behaviors/changes:
|
|
| GetMemberMessages | getConversations method of Message API Key behaviors/changes:
|
| getConversation method of Message API Key behaviors/changes:
|
|
| ReviseMyMessages | bulkUpdateConversation method of Message API Key behaviors/changes:
|
| updateConversation method of Message API Key behaviors/changes:
|
|
| DeleteMyMessages | bulkUpdateConversation method of Message API Key behaviors/changes:
|
| updateConversation method of Message API Key behaviors/changes:
|
|
| GetMessagePreferences and SetMessagePreferences | None; to be decommissioned Custom Ask Seller Question topics are no longer supported by eBay, so these two methods will be decommissioned with no alternatives |
| ReviseMyMessagesFolders | None; to be decommissioned eBay InBox folder management will not be available through modern APIs |
Feedback APIs
The alternatives to all Feedback calls in the Trading API will be the new REST-based Feedback API. The following table has the modern API replacements and any relevant notes for each Feedback call:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetItemsAwaitingFeedback | getItemsAwaitingFeedback method of Feedback API Key behaviors/changes:
|
| GetFeedback (Retrieve user feedback entries) |
getFeedback method of Feedback API Key behaviors/changes:
|
| GetFeedback (Retrieve user feedback metrics) |
getFeedbackRatingSummary method of Feedback API Key behaviors/changes:
|
| LeaveFeedback | leaveFeedback method of Feedback API Key behaviors/changes:
|
| RespondToFeedback | respondToFeedback method of Feedback API Key behaviors/changes:
|
Offers and Leads APIs
The following table has the modern API replacements and any relevant notes for each Best Offer and classified ad lead call:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetBestOffers | sellerNegotiationHistory query of Offer API Key behaviors/changes:
|
| RespondToBestOffer (Accept buyer's offer or counter offer) |
acceptOffer mutation of Offer API Key behaviors/changes: |
| RespondToBestOffer (Counter a buyer's offer or counter offer) |
counterOffer mutation of Offer API Key behaviors/changes:
|
| RespondToBestOffer (Decline a buyer's offer or counter offer) |
declineOffer mutation of Offer API Key behaviors/changes: |
| GetAdFormatLeads (Search for classified ad leads) |
getAllClassifiedLeads method of Leads API Key behaviors/changes:
|
| GetAdFormatLeads (Retrieve ad leads for a listing) |
getClassifiedLeadsByItemId method of Leads API Key behaviors/changes:
|
Buy APIs
The buying-focused APIs are covered over the next several sections. Some of these APIs can only be used on behalf of buyers, and some might have use cases for both buyers and sellers.
- Buying and Bidding APIs
- Inventory Discovery APIs
- Order Management APIs
- Account Management APIs
- Communication APIs
- Marketing and Discounts APIs
- Marketplace Metadata APIs
Buying and Bidding APIs
The following table has the modern API replacements and any relevant notes for each buying and bidding-related call:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| PlaceOffer (Accept seller's counteroffer) |
acceptOffer mutation of GraphQL-based Offer API Key behaviors/changes: |
| PlaceOffer (Place max bid on auction) |
placeProxyBid method of REST-based Offer API. Key behaviors/changes:
|
| PlaceOffer (Counter seller's counter offer) |
counterOffer mutation of GraphQL-based Offer API Key behaviors/changes:
|
| PlaceOffer (Decline seller's counter offer) |
declineOffer mutation of GraphQL-based Offer API Key behaviors/changes: |
| PlaceOffer (Make best offer) |
makeOffer mutation of GraphQL-based Offer API Key behaviors/changes:
|
| PlaceOffer (Commit to purchase fixed price item) |
commitToPurchase mutation of Item Commitment API. Key behaviors/changes:
|
| GetBestOffers | buyerNegotiationHistory query of GraphQL-based Offer API Key behaviors/changes:
|
| RespondToBestOffer (Accept seller's counter offer) |
acceptOffer mutation of Offer API Key behaviors/changes: |
| RespondToBestOffer (Counter seller's counter offer) |
counterOffer mutation of Offer API Key behaviors/changes:
|
| RespondToBestOffer (Decline seller's counter offer) |
declineOffer mutation of Offer API Key behaviors/changes: |
| GetMyeBayBuying (Retrieve BestOfferList) |
buyerNegotiationHistory query of GraphQL-based Offer API Key behaviors/changes:
|
| GetMyeBayBuying (Retrieve BidList) |
userBiddingActivity query of Auction API Key behaviors/changes:
|
| GetMyeBayBuying (Retrieve BuyingSummary) |
buyerNegotiationHistory query of GraphQL-based Offer API retrieves negotiationCount, which is the equivalent of BestOfferCount |
| userBiddingActivity query of Auction API retrieves other fields of BuyingSummary | |
| GetMyeBayBuying (Retrieve DeletedFromLostList) |
No replacement No longer supported in My eBay |
| GetMyeBayBuying (Retrieve DeletedFromWonList) |
No replacement No longer supported in My eBay |
| GetMyeBayBuying (Retrieve FavoriteSearches) |
userSavedSearches query of Follow API Key behaviors/changes:
|
| GetMyeBayBuying (Retrieve FavoriteSellers) |
userSavedSellers query of Follow API Key behaviors/changes:
|
| GetMyeBayBuying (Retrieve LostList) |
No replacement No longer supported in My eBay |
| GetMyeBayBuying (Retrieve SecondChanceOffer) |
No replacement Will not migrate |
| GetMyeBayBuying (Retrieve UserDefinedList) |
userCustomLists query of Watchlist API Key behaviors/changes:
|
| GetMyeBayBuying (Retrieve WatchList) |
userWatchList query of Watchlist API |
| GetMyeBayBuying (Retrieve WonList) |
No replacement No longer supported in My eBay |
| GetItemShipping | getItem family of methods in Browse API Key behaviors/changes:
|
Inventory Discovery APIs
The following table has the modern API replacements and any relevant notes for GetItem (buy side use case) and for each WatchList call:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetItem | getItem family of methods in Browse API See the Discover and retrieve eBay items using the Browse API use case in the Inventory Discovery and Refresh Guide |
| AddToWatchList | addToWatchList mutation of Watchlist API |
| RemoveFromWatchList (Remove one or more items from Watchlist) |
removeFromWatchList mutation of Watchlist API Key behaviors/changes:
|
| RemoveFromWatchList (Remove all items from Watchlist) |
removeAllFromWatchList mutation of Watchlist API Key behaviors/changes:
|
Order Management APIs
The two order management calls in the Trading API are GetOrders and GetItemTransactions. The Post-Order API has quite a few cancellation, return, inquiry, and case methodm available to them currently, but many of them will not be migrated to the buy side due to these Post-Order API methods having very little to zero usage. The buyer-facing Post-Order capabilities that will still be available to use on behalf of buyers are shown in the table below, but the complete list of Post-Order API methods that will not be migrated can be seen in the table in the Sell Post-Order APIs section.
The following table has the modern API replacements and any relevant notes for each order management and Post-Order API operation (that will be migrated):
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetOrders (paid orders/line items) |
orders query of Order API |
| ordersByIds query of Order API | |
| orderLineItemsByIds query of Order API | |
| getOrders and getOrder methods of Fulfillment API | |
| GetOrders (unpaid orders/line items) |
itemCommitments query of Item Commitment API |
| itemCommitmentsByIds query of Item Commitment API | |
| GetItemTransactions (paid orders/line items) | orders query of Order API, specifying the listing through the listingId field and including the includeConfirmed field and setting value to true |
| itemCommitments query of Item Commitment API, specifying the listing through the listingId field and including the includeCompleted field and setting value to true | |
| GetItemTransactions (unpaid orders/line items) | itemCommitments query of Item Commitment API, specifying the listing through the listingId field |
| Get Cancellation | contractCancellation query of the Cancellation API |
| Get Return | orderReturn query of Return API |
| Get Inquiry | orderInquiry query of Order Inquiry API |
See the Trading API order retrieval calls section for more information about the Order API and Item Commitment API queries.
Account Management APIs
The APIs covered in this section include GetUser, GetBidderList, and user note calls. The following table has the modern API replacements and any relevant notes for each account management call in Trading API:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetUser | user query of User API. Key behaviors/changes:
|
| getUser method of Identity API Key behaviors/changes: |
|
| GetUserContactDetails | None; to be decommissioned This call retrieves Personally Identifiable Information (PII) for another eBay user, and that will not be supported.in modern APIs |
| SetUserNotes (Add or update note) |
createOrReplaceUserNote mutation of User Note API Key behaviors/changes:
|
| SetUserNotes (Delete note) |
deleteUserNote mutation of User Note API Key behaviors/changes:
|
| GetBidderList | userBiddingActivity query of Auction API Key behaviors/changes:
|
Communication APIs
Messaging APIs
The alternatives to all Messaging calls in the Trading API will be the new REST-based Message API . Please note that eBay InBox/messaging has changed within the last couple of years, and every message is grouped into a conversation object, even if the conversation only has one message in it. The following table has the modern API replacements and any relevant notes for each Messaging call:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetMyMessages | getConversations method of Message API Key behaviors/changes:
|
| getConversation method of Message API Key behaviors/changes:
|
|
| GetMemberMessages | getConversations method of Message API Key behaviors/changes:
|
| getConversation method of Message API Key behaviors/changes:
|
|
| ReviseMyMessages | bulkUpdateConversation method of Message API Key behaviors/changes:
|
| updateConversation method of Message API Key behaviors/changes:
|
|
| DeleteMyMessages | bulkUpdateConversation method of Message API Key behaviors/changes:
|
| updateConversation method of Message API Key behaviors/changes:
|
|
| ReviseMyMessagesFolders | None; to be decommissioned eBay InBox folder management will not be available through modern APIs |
Feedback APIs
The alternatives to all Feedback calls in the Trading API will be the new REST-based Feedback API. The following table has the modern API replacements and any relevant notes for each Feedback call:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetItemsAwaitingFeedback | getItemsAwaitingFeedback method of Feedback API Key behaviors/changes:
|
| GetFeedback (Retrieve user feedback entries) |
getFeedback method of Feedback API Key behaviors/changes:
|
| GetFeedback (Retrieve user feedback metrics) |
getFeedbackRatingSummary method of Feedback API Key behaviors/changes:
|
| LeaveFeedback | leaveFeedback method of Feedback API Key behaviors/changes:
|
| RespondToFeedback | respondToFeedback method of Feedback API Key behaviors/changes:
|
Marketing and Discounts APIs
The following table captures the Merchandising API calls and the new alternatives for each one:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| getMostWatchedItems | getMostWatchedItems method of Buy Marketing v1 API Key behaviors/changes:
|
| getRelatedCategoryItems | No replacement; will not be migrated |
| getSimilarItems | getSimilarItems method of Buy Marketing v1 API Key behaviors/changes:
|
| getVersion | No replacement; will not be migrated |
Marketplace Metadata APIs
This section discussed metadata calls that have relevance for buying flows. These include GetCategories, eBay Catalog calls, and Parts Compatibility calls.
For buyers using GetCategories, the REST API equivalent is the getDefaultCategoryTreeId getCategoryTree and getCategorySubtree methods of Taxonomy API. See the Retrieving eBay category information with Taxonomy API use case for more information on getting started with the Taxonomy API.
eBay catalog calls
| Traditional API(s) | Modern Replacement(s) |
| findProducts | search method of Catalog API |
| getProductDetails | getProduct method of Catalog API. The eBay Product ID (ePID) is passed in as path parameter |
Parts compatibility calls
| Traditional API(s) | Modern Replacement(s) |
| getCompatibilitySearchNames | getCompatibilityPropertyNames method of Metadata API |
| getCompatibilitySearchValues | getCompatibilityPropertyValues method of Metadata API |
| getCompatibilitySearchValuesBulk | getMultiCompatibilityPropertyValues method of Metadata API |
| getProductCompatibilities | getProductCompatibilities method of Metadata API |
| getCompatibilitySearchDataVersion | No direct replacement, but both the getCompatibilitySearchValues and getCompatibilitySearchValuesBulk return a metadataVersion value in the response. |
- Step-by-Step Flowchart: Visual representation of the workflow.
- Process Description:
- Authenticate with the API (e.g., Obtain API Key).
- Send a request (e.g., HTTP GET request for fetching data).
- Handle the response (e.g., JSON parsing).
- Implement action based on the response (e.g., store in a database, display on UI).
Platform Notifications migration
Platform Notification event types and the notification API calls in the Trading API will be replaced by notification topics and the Notification API.
Traditional and modern API mappings
See the Subscribing to and receiving notifications topic for more information on using the Notification API to subscribe to and receive notifications.
The following table captures all of the traditional notification calls and the new alternatives for each one:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| GetNotificationPreferences | getSubscriptions method of Notification API Instead of event types, topics that the user is subscribed to are returned |
| SetNotificationPreferences (Setting notification destination) |
createDestination and updateDestination methods of the Notification API configure the endpoint that will receive notifications for topics that are subscribed to |
| SetNotificationPreferences (Set/update alert email) |
updateConfig method of Notification API adds/modifies the alert email used and getConfigmethod returns the current alert email |
| SetNotificationPreferences (Managing subscriptions) |
The createSubscription, updateSubscription, deleteSubscription, disableSubscription, and enableSubscription methods of Notification API are used to subscribe to, update, disable, or enable topic subscriptions |
| GetNotificationsUsage | None; to be decommissioned |
Platform notification events to notification topics
The following sections show all active platform notification events applicable to only sellers, events applicable to only buyers, and events applicable to both buyers and sellers.
Seller-based events
The following table shows the active platform notifications events that can be subscribed to by sellers, and the new topics that can be used as new alternatives:
| Platform Notification Event | Notification API Topic Replacements and Notes |
|---|---|
| AskSellerQuestion | BUYER_QUESTION Seller receives this notification when a potential buyer/bidder asks question on an active listing |
| BestOffer | OFFER_ACTIVITY This new notification topic covers multiple events related to offers between buyers and sellers. The BestOffer notification is sent to the seller when a Best Offer is proposed by the buyer. If this action occurs, the seller will see BUYER_OFFER as the OfferType value and PENDING as the OfferStatus value. |
| BidReceived | AUCTION_ACTIVITY This new notification topic covers multiple events related to bidding on auction listings The BidReceived notification is sent to the seller when the seller receives a bid on an auction item. If this action occurs, the buyer will see BID_RECEIVED as the AuctionActivity value. |
| CheckoutBuyerRequestsTotal | BUYER_REQUESTED_PURCHASE_QUOTE This notification is sent to a seller when a buyer requests the total price of one or more item commitments before paying. |
| FixedPriceTransaction | ORDER_CONFIRMATION This notification is sent to a seller when the buyer completes the checkout process and payment clears for a fixed price or auction listing. |
| ItemClosed | LISTING This new notification topic covers multiple events related to listing states. When a listing ends, the seller will receive this notification and the reason field will have a value of ENDED. |
| ItemListed | LISTING This new notification topic covers multiple events related to listing states. When a listing ends, the seller will receive this notification and the reason field will have a value of CREATED. |
| ItemRevised | LISTING This new notification topic covers multiple events related to listing states. When a listing ends, the seller will receive this notification and the reason field will have a value of UPDATED. |
| ItemSold | No direct migration for this one, but sellers can subscribe to LISTING topic to see when a listing ends, and subscribe to the ORDER_CONFIRMATION topic to see when the item is paid for by the buyer, |
| BuyerCancelRequested | ORDER_CANCELLATION_ACTIVITY, ITEM_COMMITMENT_CANCELLATION_ACTIVITY, and/or PURCHASE_QUOTE_CANCELLATION_ACTIVITY A seller's account can be subscribed to one or all of these new notification topics to be notified when a buyer requests cancellation of an order, item commitment, or purchase quote. Each of the three notification topics cover multiple events related to cancellation states. When a buyer requests a cancellation of an order, item commitment, or purchase quote, the seller will receive the related notification and the activityType field for each of the notification topics will have a value of CANCELLATION_REQUESTED. |
| OrderInquiryReminderForEscalation | ORDER_INQUIRY_ACTIVITY A seller's account can be subscribed to ORDER_INQUIRY_ACTIVITY to be alerted that the seller must respond to an item not received inquiry or the buyer may escalate that inquiry. When an item not received inquiry is in this state, the seller will receive this notification and the activityType field will have a value of SELLER_RESPONSE_REMINDER. |
| ReturnRefundOverdue | ORDER_RETURN_ACTIVITY A seller's account can be subscribed to ORDER_RETURN_ACTIVITY to be alerted that the seller's refund to the buyer for a return is overdue. In the ORDER_RETURN_ACTIVITY notification, the activityType field will have a value of SELLER_RESPONSE_REMINDER, and one of the primary or secondary actions under the sellerAvailableActions will be PROCESS_RETURN_REFUND. |
| ReturnSellerInfoOverdue | ORDER_RETURN_ACTIVITY A seller's account can be subscribed to ORDER_RETURN_ACTIVITY to be alerted when the seller is expected provide the buyer with the Return Merchandise Authorization (RMA) number or other return shipping address information. In the ORDER_RETURN_ACTIVITY notification, the activityType field will have a value of SELLER_RESPONSE_REMINDER, and one of the primary or secondary actions under the sellerAvailableActions will be PROVIDE_RMA_NUMBER or PROVIDE_SHIPMENT_INFO. |
| The following platform notifications will not be migrated due to either low usage or due to no longer being applicable | |
| ItemRevisedAddCharity | WatchedItemEndingSoon |
| EBPMyPaymentDue | EBPPaymentDone |
| INRBuyerRespondedToDispute | ItemExtended |
| ItemUnsold | |
| The migration plans have yet to be finalized for the following platform notifications | |
| ItemSuspended | ItemOutOfStock |
Events for both sellers and buyers
The following table shows the active platform notifications events that can be subscribed to by sellers or buyers, and the new topics that can be used as new alternatives:
| Platform Notification Event | Notification API Topic Replacements and Notes |
|---|---|
| AuctionCheckoutComplete | AUCTION_ENDED This notification is sent to the seller and bidders as soon as an auction listing ends, with or without a winning bidder. |
| CounterOfferReceived | OFFER_ACTIVITY This new notification topic covers multiple events related to offers between buyers and sellers. The CounterOfferReceived notification is sent to a seller or buyer when their offer partner proposes a counteroffer to their offer or counteroffer. If this action occurs:
|
| EndOfAuction | AUCTION_ENDED This notification is sent to the seller and bidders as soon as an auction listing ends, with or without a winning bidder. |
| FeedbackLeft | FEEDBACK_LEFT This notification is sent to a seller or buyer when the feedback they have left for their order partner for a line item has been recorded |
| FeedbackReceived | FEEDBACK_RECEIVED This notification is sent to a seller or buyer when their order partner has left them feedback for a line item |
| FeedbackStarChanged | FEEDBACK_STAR_RATING This notification is sent to a seller or buyer when their feedback star rating has changed |
| ItemMarkedShipped | ITEM_MARKED_SHIPPED This notification is shipped to the seller and buyer involved in an order when the seller has marked the order as being shipped. |
| M2MMessageStatusChange | No direct migration for this one, but buyers and sellers will each get a notification for each new message that starts or continues a conversation between members. The NEW_MESSAGE topic should be subscribed to. |
| MyMessageseBayMessage | NEW_MESSAGE Sellers or buyers subscribed to this topic will get a notification each time another member or eBay sends them a new message that starts or continues a conversation. |
| MyMessagesM2MMessage | NEW_MESSAGE Sellers or buyers subscribed to this topic will get a notification each time another member or eBay sends them a new message that starts or continues a conversation. |
| ReturnClosed | ORDER_RETURN_ACTIVITY Subscribe to the ORDER_RETURN_ACTIVITY topic to be alerted when a return request is closed. In the ORDER_RETURN_ACTIVITY notification, the activityType field will have a value of RETURN_CLOSED. |
| ReturnCreated | ORDER_RETURN_ACTIVITY Subscribe to the ORDER_RETURN_ACTIVITY topic to be alerted when a return request is created. In the ORDER_RETURN_ACTIVITY notification, the activityType field will have a value of RETURN_REQUESTED. The sellerAvailableActions container can be checked to see which actions a seller may take next, such as APPROVE_RETURN. |
| ReturnDelivered | ORDER_RETURN_ACTIVITY Subscribe to the ORDER_RETURN_ACTIVITY topic to be alerted when a returned item has been received by the seller. In the ORDER_RETURN_ACTIVITY notification, the activityType field will have a value of RETURN_FULFILLMENT_COMPLETED. The sellerAvailableActions container can be checked to see which actions a seller may take next, such as PROCESS_RETURN_REFUND. |
| ReturnEscalated | ORDER_RETURN_ACTIVITY Subscribe to the ORDER_RETURN_ACTIVITY topic to be alerted when a return request is referred to eBay. In the ORDER_RETURN_ACTIVITY notification, the activityType field will have a value of RETURN_REFERRAL_CREATED. The sellerAvailableActions container can be checked to see which actions a seller may take next. |
| ReturnShipped | ORDER_RETURN_ACTIVITY Subscribe to the ORDER_RETURN_ACTIVITY topic to be alerted when the buyer has shipped the return item. In the ORDER_RETURN_ACTIVITY notification, the activityType field will have a value of RETURN_FULFILLMENT_INITIATED. The sellerAvailableActions container can be checked to see which actions a seller may take next. |
| TokenRevocation | Subscribe to the AUTHORIZATION_REVOCATION topic to be alerted when an eBay user token has been revoked. In the ORDER_RETURN_ACTIVITY notification, the revokeReason field may be checked to see why the token was revoked. |
| EBPAppealedCase | ORDER_INQUIRY_ACTIVITY Subscribe to the ORDER_INQUIRY_ACTIVITY topic to be alerted when the buyer or seller has initiated an appeal on a case decision made by eBay. When an item not received inquiry is in this state, the seller will receive this notification and the activityType field will have a value of INQUIRY_REFERRAL_ON_HOLD and the inquiryCase.status field will have a value of ON_HOLD. The sellerAvailableActions can be checked on behalf of the seller to see if there any available actions for the seller to take. |
| EBPClosedAppeal | ORDER_INQUIRY_ACTIVITY Subscribe to the ORDER_INQUIRY_ACTIVITY topic to be alerted when the appeal on a case decision made by eBay has been closed. When an item not received inquiry is in this state, the seller will receive this notification and the activityType field will have a value of INQUIRY_REFERRAL_DECIDED and the inquiryCase.status field will have a value of CLOSED. |
| EBPClosedCase | ORDER_INQUIRY_ACTIVITY Subscribe to the ORDER_INQUIRY_ACTIVITY topic to be alerted when a referred order inquiry has been closed. When an item not received inquiry is in this state, the seller will receive this notification and the activityType field will have a value of INQUIRY_REFERRAL_DECIDED and the inquiryCase.status field will have a value of CLOSED. |
| EBPEscalatedCase | ORDER_INQUIRY_ACTIVITY Subscribe to the ORDER_INQUIRY_ACTIVITY topic to be alerted when an order inquiry has been referred to eBay. When an item not received inquiry is in this state, the seller will receive this notification and the activityType field will have a value of INQUIRY_REFERRAL_CREATED and the inquiryCase.status field will have a value of OPEN. |
| EBPOnHoldCase | ORDER_INQUIRY_ACTIVITY Subscribe to the ORDER_INQUIRY_ACTIVITY topic to be alerted when a referred order inquiry is on hold. When an item not received inquiry is in this state, the seller will receive this notification and the activityType field will have a value of INQUIRY_REFERRAL_ON_HOLD and the inquiryCase.status field will have a value of ON_HOLD. |
| The following platform notifications will not be migrated due to either low usage or due to no longer being applicable | |
| Feedback (use FeedbackReceived or FeedbackLeft instead) | MyMessagesHighPriorityMessageHeader |
| MyMessageseBayMessageHeader | MyMessagesM2MMessageHeader |
| MyMessagesHighPriorityMessage | ItemMarkedPaid |
| EBPMyResponseDue | EBPOtherPartyResponseDue |
Buyer-based events
The following table shows the active platform notifications events that can be subscribed to by buyers, and the new topics that can be used as new alternatives:
| Platform Notification Event | Notification API Topic Replacements and Notes |
|---|---|
| BestOfferDeclined | OFFER_ACTIVITY This new notification topic covers multiple events related to offers between buyers and sellers. The BestOfferDeclined notification is sent to the buyer when the buyer's Best Offer is declined by the seller. If this action occurs, the buyer will see BUYER_OFFER as the OfferType value and DECLINED as the OfferStatus value. |
| BestOfferPlaced | OFFER_ACTIVITY This new notification topic covers multiple events related to offers between buyers and sellers. The BestOfferPlaced notification is sent to the buyer when the buyer successfully submits a Best Offer on a listing . If this action occurs, the buyer will see BUYER_OFFER as the OfferType value and PENDING as the OfferStatus value. |
| BidPlaced | AUCTION_ACTIVITY This new notification topic covers multiple events related to bidding on auction listings The BidPlaced notification is sent to the buyer when the buyer successfully placed a bid on an auction item . If this action occurs, the buyer will see BID_PLACED as the AuctionActivity value. |
| ItemAddedToWatchList | WATCHLIST_REVISION ITEM_WATCHED is returned as the WatchlistRevision value and the listing is identified through the itemId field. |
| ItemRemovedFromWatchList | WATCHLIST_REVISION ITEM_UNWATCHED is returned as the WatchlistRevision value and the listing is identified through the itemId field. |
| ItemWon | AUCTION_ACTIVITY This new notification topic covers multiple events related to bidding on auction listings The ItemWon notification is sent to the buyer when the buyer is the winning bidder on an auction item. If this action occurs, the buyer will see AUCTION_WON as the AuctionActivity value. |
| OutBid | AUCTION_ACTIVITY This new notification topic covers multiple events related to bidding on auction listings The OutBid notification is sent to the buyer when the buyer is outbid by another bidder on an auction item. If this action occurs, the buyer will see OUTBID as the AuctionActivity value. |
| The following platform notifications will not be migrated due to either low usage or due to no longer being applicable | |
| BidItemEndingSoon | SecondChanceOffer |
| ItemReadyForPickup | ShoppingCartItemEndingSoon |
| The migration plans have yet to be finalized for the following platform notifications | |
| ItemLost | PaymentReminder |
Authentication migration
Auth'n'Auth authentication will be fully replaced by OAuth tokens with scopes. In some cases, the traditional authentication calls will have OAuth replacements, but other calls will not due to the differences in the types of authentication. The following table captures all of the traditional authentication calls and what's the future plan for each call:
| Traditional API(s) | Modern API Replacement(s) |
|---|---|
| ConfirmIdentity | None; to be decommissioned This functionality is not needed as a part of OAuth |
| FetchToken | None; to be decommissioned This functionality is not needed as a part of OAuth |
| GetSessionID | None; to be decommissioned This functionality is not needed as a part of OAuth |
| GetTokenStatus | The capability of this call will be migrated to OAuth tokens. More details to follow. |
| RevokeToken | The capability of this call will be migrated to OAuth tokens. More details to follow. |
Please use the code samples section to provide code snippets for use cases.
Decommissioned methods
This table covers all of the methods that have been decommissioned since the start of 2025. These methods are listed by API and in chronological order according to the decommission date.
| API | Decomm Date | Method | Replacement/Reason |
|---|---|---|---|
| Trading API | 2025/06/02 | GetCategoryMappings | getExpiredCategories call of the Taxonomy API. |
| 2025/07/28 | ExtendSiteHostedPictures | eBay no longer supports extending the life of unused EPS URLs beyond 30 days. | |
| 2026/02/02 | GetVeROReportStatus | VeRO API | |
| 2026/02/02 | GetVeROReasonCodeDetails | VeRO API | |
| 2026/02/02 | VeROReportItems | VeRO API | |
| Post-Order API | 2026/01/20 | Cancel Return Request | Buyer-facing |
| 2026/01/20 | Check Return Eligibility | Buyer-facing | |
| 2026/01/20 | Check Shipping Label Print Eligibility | Buyer-facing | |
| 2026/01/20 | Create Return Draft | Buyer-facing | |
| 2026/01/20 | Delete Return Request Draft File | Buyer-facing | |
| 2026/01/20 | Get Return Draft | Buyer-facing | |
| 2026/01/20 | Get Return Request Draft Files | Buyer-facing | |
| 2026/01/20 | Initiate Return Shipping Label | No longer supported | |
| 2026/01/20 | Mark Return Refund Received | Buyer-facing | |
| 2026/01/20 | Mark Return Refund Sent | Low usage | |
| 2026/01/20 | Mark Return Shipped | Buyer-facing | |
| 2026/01/20 | Send Return Shipping Label | attachReturnShipmentLabel | |
| 2026/01/20 | Update Shipment Tracking Info | recordReturnLabelSentOffline | |
| 2026/01/20 | Update Return Draft | Buyer-facing | |
| 2026/01/20 | Upload Return Request Draft File | Buyer-facing | |
| 2026/01/20 | Void Shipping Label | No longer supported | |
| 2026/02/02 | Get Return Estimate | Buyer-facing | |
| 2026/02/02 | Get Return Shipping Label | Buyer-facing | |
| 2026/02/02 | Submit Return File | Buyer-facing | |
| 2026/02/02 | Check Inquiry Eligibility | Buyer-facing | |
| 2026/03/02 | Confirm Cancellation Refund | Buyer-facing | |
| 2026/03/02 | Close Case | Buyer-facing | |
| 2026/03/16 | Close Inquiry | Buyer-facing | |
| 2026/03/16 | Confirm Inquiry Refund | Buyer-facing | |
| 2026/03/16 | Create Inquiry | Buyer-facing | |
| 2026/03/16 | Create Return Request | Buyer-facing | |
| Product API | 2025/08/11 | findCompatibilitiesBySpecification | getCompatibilitiesBySpecification |