# Modern APIs Migration Guide **Guide Group:** 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 .custom-width { min-width: auto !important; width: 46em; } .disabled-link { pointer-events: none; /\* \[cite: 7\] \*/ cursor: default; /\* \[cite: 8\] \*/ color: #888888; /\* \[cite: 9\] \*/ text-decoration: none; /\* \[cite: 10\] \*/ } This section is focused on APIs used to support selling flows on eBay. * [Listing Management APIs](#listing_management) * [Listing Metadata APIs](#listing_metadata) * [Order Management APIs](#sell_order_management) * [Account Management APIs](#sell_account_management) * [Marketing and Discount APIs](#sell_marketing) * [Communication APIs](#sell_communication) * [Offers and Leads APIs](#sell_offers) ##### Listing Management APIs The next several sections cover APIs categorized as Listing Management APIs * [AddItem family of calls](#additem_family) * [ReviseItem family of calls](#reviseitem_family) * [RelistItem family of calls](#relistitem_family) * [Second Chance Offer calls](#second_chance_offer) * [EndItem calls](#enditem_calls) * [GetItem family of calls](#getitem_family) * [Other Listing Management call](#other_listing_management) ###### AddItem family of calls Traditional API(s) Modern Replacement(s) [AddFixedPriceItem](/devzone/xml/docs/Reference/eBay/AddFixedPriceItem.html) [createListing](/develop/api/sell/listing#sell-listing-mutation-createlisting) mutation of the [Listing API](/develop/api/sell/listing) [AddItem](/devzone/xml/docs/Reference/eBay/AddItem.html) [AddItems](/devzone/xml/docs/Reference/eBay/AddItems.html) [VerifyAddFixedPriceItem](/devzone/xml/docs/Reference/eBay/VerifyAddFixedPriceItem.html) [VerifyAddItem](/devzone/xml/docs/Reference/eBay/VerifyAddItem.html) **Key things to know about** [createListing](/develop/api/sell/listing#sell-listing-mutation-createlisting) **mutation:** * The [marketplace](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistinginput.marketplace) field is required to specify the listing marketplace. * The [listingFormat](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingtermsinput.listingformat) field controls whether the listing will be an **auction**, **fixed price**, or **classified ad** listing. * The [listingDurationInDays](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistinglifecycletermsinput.listingdurationindays) field controls the **duration** of the listing. * The [title](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.title) field sets the **title** of the listing. * The [description](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.description) field sets the **description** of the listing. * The [categories](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.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](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.imageurls) array is used to provide one or more **images** for the listing. * The [itemCondition](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.itemcondition) object is used to set the **condition** of the item. * The [product.aspects](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.aspects) array is used to set the aspect name-value pairs (aka **item specifics**) for the product. * The [items](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingitemsinput.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](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingitemsinput.items) array, and a [sku](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingiteminput.sku) value and the unique [traits](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingitemproductinput.traits) for each variation are required. * For a **multiple-SKU listing**, the [listingVariations](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistinginput.listingvariations) object is used to provide information on each unique variation within the listing. * The **location** of the item is specified through the [itemLocation](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingtermsinput.itemlocation) object. * Like with the [Trading API](/devzone/xml/docs/Reference/eBay/StandardListingIndex.html#addlisting), 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](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingtermsinput.paymentterms) object, shipping business policy IDs or shipping fields within the request are set through the [shippingTerms](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingfulfillmenttermsinput.shippingterms) object, and return policy business policy IDs or return policy fields within the request are set through the [returnTerms](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingtermsinput.returnterms) object. * The [options](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistinginput.options) field can be used to validate the input without actually creating the listing. The [options](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistinginput.options) field is included and set to `VALIDATE` to run the operation in validation mode. This is an alternative to using the [VerifyAddFixedPriceItem](/devzone/xml/docs/Reference/eBay/VerifyAddFixedPriceItem.html) or [VerifyAddItem](/devzone/xml/docs/Reference/eBay/VerifyAddItem.html) calls. **Note**: Initially, the [createListing](/develop/api/sell/listing#sell-listing-mutation-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](/api-docs/sell/feed/resources/methods) can be considered. See the [Creating listings in bulk with the Sell Feed API](/develop/guides-v2/listing-creation/listing-creation#bulk-listings-sell-feed) 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](/devzone/xml/docs/Reference/eBay/ReviseFixedPriceItem.html) [updateListing](/develop/api/sell/listing#sell-listing-mutation-updatelisting) mutation of the [Listing API](/develop/api/sell/listing) [ReviseItem](/devzone/xml/docs/Reference/eBay/ReviseItem.html) [ReviseInventoryStatus](/devzone/xml/docs/Reference/eBay/ReviseInventoryStatus.html) [bulkUpdateInventory](/develop/api/sell/listing#sell-listing-mutation-bulkupdateinventory) mutation of the [Listing API](/develop/api/sell/listing) [AddToItemDescription](/Devzone/XML/docs/Reference/eBay/AddToItemDescription.html) **None**. The capability of the [AddToItemDescription](/Devzone/XML/docs/Reference/eBay/AddToItemDescription.html) 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](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.description) field of the [updateListing](/develop/api/sell/listing#sell-listing-mutation-updatelisting) mutation to make any change to the description. **Key things to know about** [updateListing](/develop/api/sell/listing#sell-listing-mutation-updatelisting) **mutation:** * The [listingIdentifier](/develop/api/sell/listing#sell-listing-mutation-updatelisting.updatelistinginput.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](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.imageurls) array and the [product.aspects](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.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](https://www.ebay.com/help/selling/listings/creating-managing-listings/revising-listing?id=4356) help topic is a very good resource to view these restrictions on revisions. **Key things to know about** [bulkUpdateInventory](/develop/api/sell/listing#sell-listing-mutation-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](/devzone/xml/docs/Reference/eBay/RelistFixedPriceItem.html) [relistListing](/develop/api/sell/listing#sell-listing-mutation-relistlisting) mutation of the [Listing API](/develop/api/sell/listing) [RelistItem](/devzone/xml/docs/Reference/eBay/RelistItem.html) [VerifyRelistItem](/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html) **Key things to know about** [relistListing](/develop/api/sell/listing#sell-listing-mutation-relistlisting) mutation: * The [listingIdentifier](/develop/api/sell/listing#sell-listing-mutation-updatelisting.updatelistinginput.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](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.imageurls) array and the [product.aspects](/develop/api/sell/listing#sell-listing-mutation-createlisting.createlistingproductinput.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](/devzone/xml/docs/Reference/eBay/VerifyRelistItem.html), the [operationMode](/develop/api/sell/listing#sell-listing-mutation-relistlisting.listingoptionsinput.operationmode) field must be included and set to `VALIDATE`. ###### Second Chance Offer calls Traditional API(s) Modern Replacement(s) [AddSecondChanceItem](/devzone/xml/docs/Reference/eBay/AddSecondChanceItem.html) [createSecondChanceListing](/develop/api/sell/listing#sell-listing-mutation-createsecondchancelisting) mutation of the [Listing API](/develop/api/sell/listing) [VerifyAddSecondChanceItem](/Devzone/XML/docs/Reference/eBay/VerifyAddSecondChanceItem.html) **Key things to know about** [createSecondChanceListing](/develop/api/sell/listing#sell-listing-mutation-createsecondchancelisting) mutation: * The [listingIdentifier](/develop/api/sell/listing#sell-listing-mutation-createsecondchancelisting.createsecondchancelistinginput.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](/develop/api/sell/listing#sell-listing-mutation-createsecondchancelisting.createsecondchancelistinginput.listingterms) object. * The user is identified through the [recipientUserId](/develop/api/sell/listing#sell-listing-mutation-createsecondchancelisting.createsecondchancelistinginput.recipientuserid) field. * To replicate the behavior of [VerifyAddSecondChanceItem](/Devzone/XML/docs/Reference/eBay/VerifyAddSecondChanceItem.html), the [operationMode](/develop/api/sell/listing#sell-listing-mutation-createsecondchancelisting.listingoptionsinput.operationmode) field must be included and set to `VALIDATE`. ###### End Item calls Traditional API(s) Modern Replacement(s) [EndItem](/Devzone/XML/docs/Reference/eBay/EndItem.html) [endListing](/develop/api/sell/listing#sell-listing-mutation-endlisting) mutation of the [Listing API](/develop/api/sell/listing) [EndFixedPriceItem](/Devzone/XML/docs/Reference/eBay/EndFixedPriceItem.html) [EndItems](/Devzone/XML/docs/Reference/eBay/EndItems.html) **Key things to know about** [endListing](/develop/api/sell/listing#sell-listing-mutation-endlisting) mutation: * The [listingIdentifier](/develop/api/sell/listing#sell-listing-mutation-endlisting.endlistinginput.listingidentifierinput) object is used to identify the listing to end * The reason why the seller is ending the listing should be provided in the [endListingReason](/develop/api/sell/listing#sell-listing-mutation-endlisting.endlistinginput.endlistingreason) field **Note**: Initially, the [endListing](/develop/api/sell/listing#sell-listing-mutation-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](/api-docs/sell/feed/resources/methods) can be considered. See the [Ending listings in bulk using Sell Feed API](/develop/guides-v2/listing-management#api-use-case) 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](/Devzone/XML/docs/Reference/eBay/GetItem.html) [sellerListings](/develop/api/sell/listing#sell-listing-query-sellerlistings) query of the [Listing API](/develop/api/sell/listing) [GetMyeBaySelling](/Devzone/XML/docs/Reference/eBay/GetMyeBaySelling.html) [sellerListingSearch](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch) query of the [Listing API](/develop/api/sell/listing) [GetSellerList](/Devzone/XML/docs/Reference/eBay/GetSellerList.html) [GetSellerEvents](/Devzone/XML/docs/Reference/eBay/GetSellerEvents.html) **Key things to know about** [sellerListings](/develop/api/sell/listing#sell-listing-query-sellerlistings) query: * The [listingId](/develop/api/sell/listing#sell-listing-query-sellerlistings.sellerlistinginput.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](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch) query: * Three different date range filters are available. Use [startAtRange](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchfilterinput.startatrange) filter to search for listings that started within a date range, use [modifiedAtRange](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchfilterinput.modifiedatrange) filter to search for listings that were last modified within a date range, and use [endAtRange](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchfilterinput.endatrange) filter to search for listings that were ended within a date range. * The [formatType](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchfilterinput.formattype) filter is used to retrieve only listings of a specific format. * The [primaryCategoryIds](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchfilterinput.primarycategoryids) array is used to retrieve only listings listed in one more specific eBay categories. * The [listingIds](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchfilterinput.listingids) and [skus](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchfilterinput.skus) array are used to retrieve one or more specific listings. If these filters are used, other filters should not be used. * [Pagination](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchinput.pagination) and [sort](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.selleractivelistingsearchinput.sort) options are available. * In the response, listings that match the filter criteria are categorized into [activeListings](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.sellerlistingsearchoutput.activelistings), [endedListings](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.sellerlistingsearchoutput.endedListings), and [scheduledListings](/develop/api/sell/listing#sell-listing-query-sellerlistingsearch.sellerlistingsearchoutput.scheduledlistings) arrays. ###### Other Listing Management calls Traditional API(s) Modern Replacement(s) [UploadSiteHostedPictures](/Devzone/XML/docs/Reference/eBay/UploadSiteHostedPictures.html) [createImageFromFile](/api-docs/commerce/media/resources/image/methods/createImageFromFile) method of [Media API](/api-docs/commerce/media/resources/methods) [createImageFromUrl](/api-docs/commerce/media/resources/image/methods/createImageFromUrl) method of [Media API](/api-docs/commerce/media/resources/methods) [GetAllBidders](/devzone/xml/docs/Reference/eBay/GetAllBidders.html) **itemBiddingActivity** query of **Auction API** [GetDescriptionTemplates](/devzone/xml/docs/Reference/eBay/GetDescriptionTemplates.html) **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](/api-docs/commerce/media/resources/image/methods/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](/api-docs/commerce/media/resources/image/methods/createImageFromFile#response.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](/api-docs/commerce/media/resources/image/methods/getImage) URI in the Location header. The **imageId** value for the uploaded image will be included in the [getImage](/api-docs/commerce/media/resources/image/methods/getImage) URI, and it is strongly recommended that developers save/store this [getImage](/api-docs/commerce/media/resources/image/methods/getImage) UR or **imageId** value because [getImage](/api-docs/commerce/media/resources/image/methods/getImage) will need to be called to get the [imageUrl](/api-docs/commerce/media/resources/image/methods/createImageFromFile#response.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](/api-docs/commerce/media/resources/image/methods/createImageFromUrl) method: * With this method, an [imageUrl](/api-docs/commerce/media/resources/image/methods/createImageFromUrl#request.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](/api-docs/commerce/media/resources/image/methods/createImageFromUrl#response.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](/api-docs/commerce/media/resources/image/methods/getImage) URI in the Location header. The **imageId** value for the uploaded image will be included in the [getImage](/api-docs/commerce/media/resources/image/methods/getImage) URI, and it is strongly recommended that developers save/store this [getImage](/api-docs/commerce/media/resources/image/methods/getImage) UR or **imageId** value because [getImage](/api-docs/commerce/media/resources/image/methods/getImage) will need to be called to get the [imageUrl](/api-docs/commerce/media/resources/image/methods/createImageFromFile#response.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](/devzone/xml/docs/Reference/eBay/GetAllBidders.html#Request.IncludeBiddingSummary) and [CallMode](/devzone/xml/docs/Reference/eBay/GetAllBidders.html#Request.CallMode) fields in [GetAllBidders](/devzone/xml/docs/Reference/eBay/GetAllBidders.html), 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](#taxonomy_calls) * [Category feature calls](#category_feature_calls) * [Site-level metadata calls](#site_metadata) * [eBay Catalog calls](#sell_catalog) * [Parts compatibility calls](#sell_compatibility) ###### Taxonomy calls Traditional API(s) Modern Replacement(s) **GetCategories** (Decommissioned April 15, 2026) [getDefaultCategoryTreeId](/api-docs/sell/taxonomy/resources/category_tree/methods/getDefaultCategoryTreeId) method of [Taxonomy API](/api-docs/sell/taxonomy/resources/methods) to get category tree ID [getCategoryTree](/api-docs/sell/taxonomy/resources/category_tree/methods/getCategoryTree) method of [Taxonomy API](/api-docs/sell/taxonomy/resources/methods) to get full category tree [getCategorySubtree](/api-docs/sell/taxonomy/resources/category_tree/methods/getCategorySubtree) method of [Taxonomy API](/api-docs/sell/taxonomy/resources/methods) to get a subset of the category tree, starting at any category level [getCategoryPolicies](/api-docs/sell/metadata/resources/marketplace/methods/getCategoryPolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) for all site-level data points. **Note:** See the [GetCategories Migration Guide](/api-docs/user-guides/static/trading-user-guide/migration-gc.html) for more details and full mappings. ###### Category feature calls Traditional API(s) Modern Replacement(s) **GetCategoryFeatures** (Decommissioned on June 4, 2026) [getItemConditionPolicies](/api-docs/sell/metadata/resources/marketplace/methods/getItemConditionPolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to get item condition information for leaf categories on a marketplace [getListingTypePolicies](/api-docs/sell/metadata/resources/marketplace/methods/getListingTypePolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to get supported durations for different listing types [getReturnPolicies](/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to get return policy metadata for leaf categories on a marketplace [getListingStructurePolicies](/api-docs/sell/metadata/resources/marketplace/methods/getListingStructurePolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to see which leaf categories on a marketplace support variations [getNegotiatedPricePolicies](/api-docs/sell/metadata/resources/marketplace/methods/getNegotiatedPricePolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to see which leaf categories on a marketplace support Best Offers [getMotorsListingPolicies](/api-docs/sell/metadata/resources/marketplace/methods/getMotorsListingPolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to get Motors-related metadata for leaf categories on a marketplace [getAutomotivePartsCompatibilityPolicies](/api-docs/sell/metadata/resources/marketplace/methods/getAutomotivePartsCompatibilityPolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to get compatibility-related metadata for leaf categories on a marketplace [getClassifiedAdPolicies](/api-docs/sell/metadata/resources/marketplace/methods/getClassifiedAdPolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to get classified ad-related metadata for leaf categories on a marketplace [getSiteVisibilityPolicies](/api-docs/sell/metadata/resources/marketplace/methods/getSiteVisibilityPolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to see which leaf categories support exposing listings on other marketplaces for a fee [getItemAspectsForCategory](/api-docs/sell/taxonomy/resources/category_tree/methods/getItemAspectsForCategory) method (or use [fetchItemAspects](/api-docs/sell/taxonomy/resources/category_tree/methods/fetchItemAspects) method with [Taxonomy SDK](https://github.com/eBay/taxonomy-sdk)) of [Taxonomy API](/api-docs/sell/taxonomy/resources/methods) can be used to get see which leaf categories require a specific GTIN value or Brand/MPN **Note:** See the [GetCategoryFeatures Migration Guide](/api-docs/user-guides/static/trading-user-guide/migration-gcf.html) 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](/api-docs/sell/metadata/resources/methods) 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](/api-docs/static/rest-request-components.html#marketpl) table. * The default behavior the [Metadata API](/api-docs/sell/metadata/resources/methods) methods is to retrieve metadata from all leaf categories on the specified marketplace, but users can use the [filter](/api-docs/sell/metadata/resources/marketplace/methods/getCategoryPolicies#uri.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](/api-docs/sell/taxonomy/resources/methods) methods: * Both the [getItemAspectsForCategory](/api-docs/sell/taxonomy/resources/category_tree/methods/getItemAspectsForCategory) and [fetchItemAspects](/api-docs/sell/taxonomy/resources/category_tree/methods/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](/api-docs/sell/taxonomy/resources/category_tree/methods/getDefaultCategoryTreeId) method. * The [getItemAspectsForCategory](/api-docs/sell/taxonomy/resources/category_tree/methods/getItemAspectsForCategory) method can only retrieve metadata on one leaf category per operation, and this leaf category is specified through the [category\_id](/api-docs/sell/taxonomy/resources/category_tree/methods/getItemAspectsForCategory#uri.category_id) query parameter. * A successful [fetchItemAspects](/api-docs/sell/taxonomy/resources/category_tree/methods/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](/api-docs/sell/taxonomy/resources/category_tree/methods/fetchItemAspects) method can be paired together with the open source [Taxonomy SDK](https://github.com/eBay/taxonomy-sdk) to compare the aspect metadata that is returned in this response for each subsequent [fetchItemAspects](/api-docs/sell/taxonomy/resources/category_tree/methods/fetchItemAspects) operation. The [Taxonomy SDK](https://github.com/eBay/taxonomy-sdk) uses the [fetchItemAspects](/api-docs/sell/taxonomy/resources/category_tree/methods/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** Traditional API(s) Modern Replacement(s) [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getShippingServices](/api-docs/sell/metadata/resources/shipping:marketplace/methods/getShippingServices) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to retrieve metadata equivalent to [ShippingServiceDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingServiceDetails) and [ShippingPackageDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingPackageDetails) in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getShippingCarriers](/api-docs/sell/metadata/resources/shipping:marketplace/methods/getShippingCarriers) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to retrieve metadata equivalent to [ShippingCarrierDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingCarrierDetails) in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getShippingLocations](/api-docs/sell/metadata/resources/shipping:marketplace/methods/getShippingLocations) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to retrieve metadata equivalent to [ShippingLocationDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.ShippingLocationDetails) in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getExcludeShippingLocations](/api-docs/sell/metadata/resources/shipping:marketplace/methods/getExcludeShippingLocations) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to retrieve metadata equivalent to [ExcludeShippingLocationDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.ExcludeShippingLocationDetails) in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getHandlingTimes](/api-docs/sell/metadata/resources/shipping:marketplace/methods/getHandlingTimes) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to retrieve metadata equivalent to [DispatchTimeMaxDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.DispatchTimeMaxDetails) in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getCurrencies](/api-docs/sell/metadata/resources/marketplace/methods/getCurrencies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to retrieve data tied to [CurrencyDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.CurrencyDetails) in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getMinimumListingPricePolicies](/api-docs/sell/metadata/resources/marketplace/methods/getMinimumListingPricePolicies) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to retrieve data tied to [ListingStartPriceDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.ListingStartPriceDetails) in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getSalesTaxJurisdictions](/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions) method of [Metadata API](/api-docs/sell/metadata/resources/methods) to retrieve data tied to [TaxJurisdiction](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.TaxJurisdiction) containers in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) Use [getDefaultCategoryTreeId](/api-docs/sell/taxonomy/resources/category_tree/methods/getDefaultCategoryTreeId) method of [Taxonomy API](/api-docs/sell/taxonomy/resources/methods) to retrieve data tied to [SiteDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html#Response.SiteDetails) containers in [GeteBayDetails](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) **Key things to know about the [Metadata API](/api-docs/sell/metadata/resources/methods) 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](/api-docs/static/rest-request-components.html#marketpl) table. * The [getSalesTaxJurisdictions](/api-docs/sell/metadata/resources/country/methods/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](/devzone/xml/docs/Reference/eBay/GeteBayDetails.html) 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](/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](/Devzone/Product/CallRef/findProducts.html) (To be decommissioned on August 17, 2026) [search](/api-docs/sell/catalog/resources/product_summary/methods/search) method of [Catalog API](/api-docs/sell/catalog/resources/methods) [getProductDetails](/Devzone/Product/CallRef/getProductDetails.html) (To be decommissioned on August 17, 2026) [getProduct](/api-docs/sell/catalog/resources/product/methods/getProduct) method of [Catalog API](/api-docs/sell/catalog/resources/methods). The eBay Product ID (ePID) is passed in as path parameter **Key things to know about the [search](/api-docs/sell/catalog/resources/product_summary/methods/search) method:** * The [q](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.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](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.gtin) query parameter can be used to specify that GTIN ID to see if an eBay catalog product match is found. * The [mpn](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.mpn) query parameter can also be used to specify a Manufacturer Part Number, but this filter must be paired up with the [q](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.q) query parameter, where the user will generally pass in the brand of the part. * The [aspect\_filter](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.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](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.category_ids) query parameter is used to retrieve only products associated with specific eBay categories. * The [fieldgroups](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.fieldgroups) query parameter is used to control the type and amount of data that is retrieved for products. * The [limit](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.limit) query parameter is used to control the maximum number of products retrieved per page of data, and the [offset](/api-docs/sell/catalog/resources/product_summary/methods/search#uri.offset) query parameter determines which page of data is retrieved. ###### Parts compatibility calls Traditional API(s) Modern Replacement(s) [getCompatibilitySearchNames](/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) [getCompatibilityPropertyNames](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames) method of [Metadata API](/api-docs/sell/metadata/resources/methods) [getCompatibilitySearchValues](/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) [getCompatibilityPropertyValues](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues) method of [Metadata API](/api-docs/sell/metadata/resources/methods) [getCompatibilitySearchValuesBulk](/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) [getMultiCompatibilityPropertyValues](/api-docs/sell/metadata/resources/compatibilities/methods/getMultiCompatibilityPropertyValues) method of [Metadata API](/api-docs/sell/metadata/resources/methods) [getProductCompatibilities](/Devzone/Product/CallRef/getProductCompatibilities.html) [getProductCompatibilities](/api-docs/sell/metadata/resources/compatibilities/methods/getProductCompatibilities) method of [Metadata API](/api-docs/sell/metadata/resources/methods) [getCompatibilitySearchDataVersion](/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) No direct replacement, but both the [getCompatibilityPropertyValues](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues) and [getMultiCompatibilityPropertyValues](/api-docs/sell/metadata/resources/compatibilities/methods/getMultiCompatibilityPropertyValues) return a [metadataVersion](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues#response.metadataVersion) value in the response. **Key things to know about the methods under the compatibilities resource of the** [Metadata API](/api-docs/sell/metadata/resources/methods): * 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](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames#request.categoryId) field. * With the [getCompatibilitySearchValues](/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) method, a property name such as Make or Model must be input into the [propertyName](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues#request.propertyName) field to retrieve the values for that property name on that marketplace. * The [propertyFilters](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues#request.propertyFilters) array in the [getCompatibilitySearchValues](/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) 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](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues#request.propertyFilters.propertyName) field and set it to “Year” and include the [propertyValue](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues#request.propertyFilters.propertyValue) field and set it to “1957”. * The [getCompatibilitySearchValuesBulk](/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) method works similarly to the [getCompatibilitySearchValues](/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) method, except that multiple property names such as Make, Model, and Year can be specified through the [propertyNames](/api-docs/sell/metadata/resources/compatibilities/methods/getMultiCompatibilityPropertyValues#request.propertyNames) array, and then each vehicle that matches the specified attributes is returned under a separate [compatibilityDetails](/api-docs/sell/metadata/resources/compatibilities/methods/getMultiCompatibilityPropertyValues#response.compatibilities.compatibilityDetails) node. * The [getProductCompatibilities](/Devzone/Product/CallRef/getProductCompatibilities.html) method requires that a motor vehicle part or accessory is identified through the [productIdentifier](/api-docs/sell/metadata/resources/compatibilities/methods/getProductCompatibilities#request.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](#order_retrieval) * [Trading API after-sale calls](#after_sale) * [Post-Order Cancellation APIs](#postorder_cancel) * [Post-Order Return APIs](#postorder_return) * [Post-Order Case APIs](#postorder_case) * [Post-Order Inquiry APIs](#postorder_inquiry) ###### Post-Order Cancellation APIs ###### Trading API order retrieval calls Traditional API(s) Modern Replacement(s) [GetOrders](/devzone/xml/docs/Reference/eBay/GetOrders.html) and [GetSellerTransactions](/devzone/xml/docs/Reference/eBay/GetSellerTransactions.html) (paid orders/line items) [orders](/develop/api/sell/sell_order#sell-sell_order-query-orders) query of [Order API](/develop/api/sell/sell_order) [ordersByIds](/develop/api/sell/sell_order#sell-sell_order-query-ordersbyids) query of [Order API](/develop/api/sell/sell_order) [orderLineItemsByIds](/develop/api/sell/sell_order#sell-sell_order-query-orderlineitemsbyids) query of [Order API](/develop/api/sell/sell_order) [getOrders](/api-docs/sell/fulfillment/resources/order/methods/getOrders) and [getOrder](/api-docs/sell/fulfillment/resources/order/methods/getOrder) methods of [Fulfillment API](/api-docs/sell/fulfillment/resources/methods) [GetOrders](/devzone/xml/docs/Reference/eBay/GetOrders.html) and [GetSellerTransactions](/devzone/xml/docs/Reference/eBay/GetSellerTransactions.html) (unpaid orders/line items) [itemCommitments](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments) query of [Item Commitment API](/develop/api/sell/sell_item_commitment) [itemCommitmentsByIds](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitmentsbyids) query of [Item Commitment API](/develop/api/sell/sell_item_commitment) [GetItemTransactions](/devzone/xml/docs/Reference/eBay/GetItemTransactions.html) (paid orders/line items) [orders](/develop/api/sell/sell_order#sell-sell_order-query-orders) query of [Order API](/develop/api/sell/sell_order), specifying the listing through the [listingId](/develop/api/sell/sell_order#sell-sell_order-query-orders.ordersfilterinput.listingid) field and including the [includeConfirmed](/develop/api/sell/sell_order#sell-sell_order-query-orders.ordersfilterinput.includeconfirmed) field and setting value to true [itemCommitments](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments) query of [Item Commitment API](/develop/api/sell/sell_item_commitment), specifying the listing through the [listingId](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsfilterinput.listingid) field and including the [includeCompleted](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsfilterinput.includecompleted) field and setting value to true [GetItemTransactions](/devzone/xml/docs/Reference/eBay/GetItemTransactions.html) (unpaid orders/line items) [itemCommitments](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments) query of [Item Commitment API](/develop/api/sell/sell_item_commitment), specifying the listing through the [listingId](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsfilterinput.listingid) field **Key things to know about the [Order API](/develop/api/sell/sell_order) queries:** * These queries are for paid orders only, and will not retrieve unpaid item commitments. * The [dateTimeRange](/develop/api/sell/sell_order#sell-sell_order-query-orders.ordersdaterangeinput.datetimerange) object of the [orders](/develop/api/sell/sell_order#sell-sell_order-query-orders) query is used to specify a data range for which to retrieve orders, and the [dateType](/develop/api/sell/sell_order#sell-sell_order-query-orders.ordersdaterangeinput.datetype) field indicates whether the date range applies to order creation date or to the last modification date. * The [filter](/develop/api/sell/sell_order#sell-sell_order-query-orders.ordersfirstfilterinput.filter) object contains a [listingId](/develop/api/sell/sell_order#sell-sell_order-query-orders.ordersfilterinput.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](/develop/api/sell/sell_order#sell-sell_order-query-orders.ordersfirstfilterinput.sort) object allows the user to sort according to order creation date or last modified date. * The [ordersPage](/develop/api/sell/sell_order#sell-sell_order-query-orders.ordersinput.orderspage) object allows the user to set the maximum number of orders returned per page or to pass in a [pageCursor](/develop/api/sell/sell_order#sell-sell_order-query-orders.pageinfoinput.pagecursor) string value to retrieve the next or previous page of orders. * The [ordersByIds](/develop/api/sell/sell_order#sell-sell_order-query-ordersbyids) query can retrieve up to 100 specific orders by passing order ID values into the [orderIds](/develop/api/sell/sell_order#sell-sell_order-query-ordersbyids.ordersbyidsinput.orderids) array. * The [orderLineItemsByIds](/develop/api/sell/sell_order#sell-sell_order-query-orderlineitemsbyids) query can retrieve up to 100 specific order line items by passing order line item ID values into the [lineItemIds](/develop/api/sell/sell_order#sell-sell_order-query-orderlineitemsbyids.orderlineitemsbyidsinput.lineitemids) array. **Key things to know about the [Item Commitment API](/develop/api/sell/sell_item_commitment) queries:** * These queries are for unpaid orders only, which are now referred to as item commitments. * The [dateRange](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsfirstfilterinput.daterange) object of the [itemcommitments](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments) query is used to specify a data range for which to retrieve item commitments, and the [dateType](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsdaterangeinput.datetype) field indicates whether the date range applies to item commitment creation date or to the last modification date. * The [filter](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsfirstfilterinput.filter) object contains a [listingId](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsfilterinput.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](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsfirstfilterinput.sort) object allows the user to sort according to item commitment creation date or last modified date. * The [itemCommitmentsPage](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.itemcommitmentsinput.itemcommitmentspage) object allows the user to set the maximum number of item commitments returned per page or to pass in a [pageCursor](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitments.pageinfoinput.pagecursor) string value to retrieve the next or previous page of item commitments. * The [itemCommitmentsByIds](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitmentsbyids) query can retrieve up to 100 specific item commitments by passing item commitment ID values into the [itemCommitmentIds](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-query-itemcommitmentsbyids.itemcommitmentsbyidsinput.itemcommitmentids) array. ###### Trading API after-sale calls Traditional API(s) Modern Replacement(s) [CompleteSale](/Devzone/XML/docs/Reference/eBay/CompleteSale.html) (mark item commitments as paid) [markItemCommitmentsPaid](/develop/api/sell/sell_item_commitment#sell-sell_item_commitment-mutation-markitemcommitmentspaid) of [Item Commitment API](/develop/api/sell/sell_item_commitment) [CompleteSale](/Devzone/XML/docs/Reference/eBay/CompleteSale.html) (mark offline orders as paid) [markOrdersPaid](/develop/api/sell/sell_order#sell-sell_order-mutation-markorderspaid) mutation of [Order API](/develop/api/sell/sell_order). [CompleteSale](/Devzone/XML/docs/Reference/eBay/CompleteSale.html) (provide feedback for an order partner) [leaveFeedback](/api-docs/commerce/feedback/resources/feedback/methods/leaveFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) [CompleteSale](/Devzone/XML/docs/Reference/eBay/CompleteSale.html) (provide shipment tracking information) [createShippingFulfillment](/api-docs/sell/fulfillment/resources/order/shipping_fulfillment/methods/createShippingFulfillment) method of [Fulfillment API](/api-docs/sell/fulfillment/resources/methods) [CompleteSale](/Devzone/XML/docs/Reference/eBay/CompleteSale.html) (provide shipment tracking information for INR inquiry) [provideShipmentInfoForItemNotReceivedInquiry](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-provideshipmentinfoforitemnotreceivedinquiry) mutation of [Order Inquiry API](/develop/api/sell/sell_order_inquiry) [AddOrder](/Devzone/XML/docs/Reference/eBay/AddOrder.html) [createPurchaseQuote](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-createpurchasequote) mutation of [Purchase Quote API](/develop/api/sell/sell_purchase_quote) [SendInvoice](/Devzone/XML/docs/Reference/eBay/SendInvoice.html) [createPurchaseQuote](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-createpurchasequote) mutation of [Purchase Quote API](/develop/api/sell/sell_purchase_quote) [bulkupdatepurchasequotes](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-bulkupdatepurchasequotes) mutation of [Purchase Quote API](/develop/api/sell/sell_purchase_quote) **Key things to know about the [Purchase Quote API](/develop/api/sell/sell_purchase_quote) mutation:** * The [createPurchaseQuote](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-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](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-createpurchasequote.purchasequoteiteminput.itemcommitmentid) array of the [createPurchaseQuote](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-createpurchasequote) mutation * The [bulkupdatepurchasequotes](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-bulkupdatepurchasequotes) mutation is used to update one or more purchase quotes, and the purchase quote is identified through the [purchasequoteid](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-bulkupdatepurchasequotes.updatepurchasequoteinput.purchasequoteid) field * The fields of the [bulkupdatepurchasequotes](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-bulkupdatepurchasequotes) mutation are basically the same as the [createPurchaseQuote](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-createpurchasequote) mutation. Below are some of the fields that are used: * Use the [logisticsOptions.shipping](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-createpurchasequote.purchasequotelogisticsoptioninput.shipping) array to provide the shipping cost for the order and the shipping service option that will be used * Use the [total](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-createpurchasequote.createpurchasequoteinput.total) object to add any additional shipping/handling related charges and/or any applicable shipping discounts * Use the [messageToBuyer](/develop/api/sell/sell_purchase_quote#sell-sell_purchase_quote-mutation-createpurchasequote.createpurchasequoteinput.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](/devzone/post-order/index.html) 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](#decommed) section for a full list of methods that have decommissioned since the start of 2025. Traditional API(s) Modern Replacement(s) [Approve Cancellation](/Devzone/post-order/post-order_v2_cancellation-cancelid_approve__post.html) [approveContractCancellation](/develop/api/sell/sell_cancellation#sell-sell_cancellation-mutation-approvecontractcancellation) mutation of the [Cancellation API](/develop/api/sell/sell_cancellation) [Check Cancellation Eligibility](/Devzone/post-order/post-order_v2_cancellation_check_eligibility__post.html) **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](/Devzone/post-order/post-order_v2_cancellation__post.html) [createItemCommitmentCancellation](/develop/api/sell/sell_cancellation#sell-sell_cancellation-mutation-createitemcommitmentcancellation) mutation of [Cancellation API](/develop/api/sell/sell_cancellation) [createOrderCancellation](/develop/api/sell/sell_cancellation#sell-sell_cancellation-mutation-createordercancellation) mutation of [Cancellation API](/develop/api/sell/sell_cancellation) [createPurchaseQuoteCancellation](/develop/api/sell/sell_cancellation#sell-sell_cancellation-mutation-createpurchasequotecancellation) mutation of [Cancellation API](/develop/api/sell/sell_cancellation) [Get Cancellation](/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) [contractCancellation](/develop/api/sell/sell_cancellation#sell-sell_cancellation-query-contractcancellation) query of the [Cancellation API](/develop/api/sell/sell_cancellation) [Reject Cancellation](/Devzone/post-order/post-order_v2_cancellation-cancelid_reject__post.html) [declineContractCancellation](/develop/api/sell/sell_cancellation#sell-sell_cancellation-mutation-declinecontractcancellation) mutation of [Cancellation API](/develop/api/sell/sell_cancellation) [Search Cancellations](/Devzone/post-order/post-order_v2_cancellation_search__get.html) [sellerContractCancellations](/develop/api/sell/sell_cancellation#sell-sell_cancellation-query-sellercontractcancellations) query of [Cancellation API](/develop/api/sell/sell_cancellation) ###### Post-Order Return APIs With the exception of a single query to retrieve a specific Return Request, all buyer-facing [Post-Order API](/devzone/post-order/index.html) 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](#decommed) 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. Traditional API(s) Modern Replacement(s) [Add Shipping Label Info](/Devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) (Attach downloadable shipping label) [attachReturnShipmentLabel](/develop/api/sell/sell_return#sell-sell_return-mutation-attachreturnshipmentlabel) mutation of [Return API](/develop/api/sell/sell_return). The new [uploadPostOrderDocument](/api-docs/commerce/media/resources/post_order/methods/uploadPostOrderDocument) method of [Media API](/api-docs/commerce/media/resources/methods) can be used to upload the shipping label to seller's account [Add Shipping Label Info](/Devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) (Provide tracking information) [recordReturnLabelSentOffline](/develop/api/sell/sell_return#sell-sell_return-mutation-recordreturnlabelsentoffline) mutation of [Return API](/develop/api/sell/sell_return). Shipping carrier and tracking number provided through [trackings](/develop/api/sell/sell_return#sell-sell_return-mutation-recordreturnlabelsentoffline.recordreturnlabelsentofflineinput.trackings) array [Add Shipping Label Info](/Devzone/post-order/post-order_v2_return-returnid_add_shipping_label__post.html) (Provide return label by other means) [recordReturnLabelSentOffline](/develop/api/sell/sell_return#sell-sell_return-mutation-recordreturnlabelsentoffline) mutation of [Return API](/develop/api/sell/sell_return). The [offlineReturnLabelChannel](/develop/api/sell/sell_return#sell-sell_return-mutation-recordreturnlabelsentoffline.recordreturnlabelsentofflineinput.offlinereturnlabelchannel) field is included and set to either `COMMUNICATED_TO_BUYER` or `RETURN_LABEL_IN_THE_BOX` [Escalate Return](/Devzone/post-order/post-order_v2_return-returnid_escalate__post.html) [submitReturnReferral](/develop/api/sell/sell_return#sell-sell_return-mutation-submitreturnreferral) method of [Return API](/develop/api/sell/sell_return) [Get Return](/Devzone/post-order/post-order_v2_return-returnid__get.html) [orderReturn](/develop/api/sell/sell_return#sell-sell_return-query-orderreturn) query of [Return API](/develop/api/sell/sell_return) [Get Return Files](/Devzone/post-order/post-order_v2_return-returnid_files__get.html) [orderReturn](/develop/api/sell/sell_return#sell-sell_return-query-orderreturn) query of [Return API](/develop/api/sell/sell_return). Documents are returned under [returnCreationDocuments](/develop/api/sell/sell_return#sell-sell_return-query-orderreturn.returnlineitem.returncreationdocuments) array if associated with a return request [Get Return Preferences](/Devzone/post-order/post-order_v2_return_preference__get.html) [sellerReturnPreference](/develop/api/sell/return_rules#sell-return_rules-query-sellerreturnpreference) query of [Return API](/develop/api/sell/sell_return) [Get Shipment Tracking Info](/Devzone/post-order/post-order_v2_return-returnid_tracking__get.html) [orderReturn](/develop/api/sell/sell_return#sell-sell_return-query-orderreturn) query of [Return API](/develop/api/sell/sell_return). Shipment tracking information for the return item is returned under **tracking** object if available [Issue Return Refund](/Devzone/post-order/post-order_v2_return-returnid_issue_refund__post.html) [processReturnRefund](/develop/api/sell/sell_return#sell-sell_return-mutation-processreturnrefund) mutation of [Return API](/develop/api/sell/sell_return) [Mark Return Received](/Devzone/post-order/post-order_v2_return-returnid_mark_as_received__post.html) [recordReturnReceived](/develop/api/sell/sell_return#sell-sell_return-mutation-recordreturnreceived) mutation of [Return API](/develop/api/sell/sell_return) [Process Return Request](/Devzone/post-order/post-order_v2_return-returnid_decide__post.html) (Approve request) [approveReturn](/develop/api/sell/sell_return#sell-sell_return-mutation-approvereturn) mutation of [Return API](/develop/api/sell/sell_return) [Process Return Request](/Devzone/post-order/post-order_v2_return-returnid_decide__post.html) (Decline request) [declineReturn](/develop/api/sell/sell_return#sell-sell_return-mutation-declinereturn) mutation of [Return API](/develop/api/sell/sell_return) [Process Return Request](/Devzone/post-order/post-order_v2_return-returnid_decide__post.html) (Offer partial refund) [proposeKeepItemWithPartialRefund](/develop/api/sell/sell_return#sell-sell_return-mutation-proposekeepitemwithpartialrefund) mutation of [Return API](/develop/api/sell/sell_return) [Process Return Request](/Devzone/post-order/post-order_v2_return-returnid_decide__post.html) (Provide RMA) [provideRmaNumber](/develop/api/sell/sell_return#sell-sell_return-mutation-providermanumber) mutation of [Return API](/develop/api/sell/sell_return) [Search Returns](/Devzone/post-order/post-order_v2_return_search__get.html) [sellerOrderReturns](/develop/api/sell/sell_return#sell-sell_return-query-sellerorderreturns) query of [Return API](/develop/api/sell/sell_return) [Send Return Message](/Devzone/post-order/post-order_v2_return-returnid_send_message__post.html) [sendReturnMessage](/develop/api/sell/sell_return#sell-sell_return-mutation-sendreturnmessage) mutation of [Return API](/develop/api/sell/sell_return) [Set Return Preferences](/Devzone/post-order/post-order_v2_return_preference__post.html) [updateSellerRmaPreference](/develop/api/sell/sell_return#sell-sell_return-mutation-updatesellerrmapreference) mutation of [Return API](/develop/api/sell/sell_return) [Upload Return File](/Devzone/post-order/post-order_v2_return-returnid_file_upload__post.html) [uploadPostOrderDocument](/api-docs/commerce/media/resources/post_order/methods/uploadPostOrderDocument) method of [Media API](/api-docs/commerce/media/resources/methods) ###### 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](/develop/api/sell/sell_return#api-sell_order_inquiry), and return cases are being migrated to the [Return API](/develop/api/sell/sell_return). Traditional API(s) Modern Replacement(s) [Appeal Case Decision](/Devzone/post-order/post-order_v2_casemanagement-caseid_appeal__post.html) (INR case) [submitOrderInquiryReferral](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-submitorderinquiryreferral) mutation of [Order Inquiry API](/develop/api/sell/sell_order_inquiry). [Appeal Case Decision](/Devzone/post-order/post-order_v2_casemanagement-caseid_appeal__post.html) (Return case) [submitReturnReferral](/develop/api/sell/sell_return#sell-sell_return-mutation-submitreturnreferral) mutation of [Return API](/develop/api/sell/sell_return) [Get Case](/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) (INR case) [orderInquiry](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-query-orderinquiry) query of [Order Inquiry API](/develop/api/sell/sell_order_inquiry). Case information is returned if there is a case filed against the inquiry [Get Case](/Devzone/post-order/post-order_v2_casemanagement-caseid__get.html) (Return case) [orderReturn](/develop/api/sell/sell_return#sell-sell_return-query-orderreturn) query of [Return API](/develop/api/sell/sell_return). Case information is returned if there is a case filed against the return [Issue Case Refund](/Devzone/post-order/post-order_v2_casemanagement-caseid_issue_refund__post.html) (INR case) [processOrderInquiryRefund](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-processorderinquiryrefund) mutation of [Order Inquiry API](/develop/api/sell/sell_order_inquiry) [Issue Case Refund](/Devzone/post-order/post-order_v2_casemanagement-caseid_issue_refund__post.html) (Return case) [processReturnRefund](/develop/api/sell/sell_return#sell-sell_return-mutation-processreturnrefund) mutation of [Return API](/develop/api/sell/sell_return) [Provide Case Shipment Info](/Devzone/post-order/post-order_v2_casemanagement-caseid_provide_shipment_info__post.html) [provideShipmentInfoForItemNotReceivedInquiry](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-provideshipmentinfoforitemnotreceivedinquiry) mutation of [Order Inquiry API](/develop/api/sell/sell_order_inquiry) [Provides Return Address](/Devzone/post-order/post-order_v2_casemanagement-caseid_provide_return_address__post.html) **None** No direct equivalent, and alternative return addresses can only be added in My eBay. [Search Cases](/Devzone/post-order/post-order_v2_casemanagement_search__get.html) (INR case) [sellerOrderInquiries](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-query-sellerorderinquiries) query of [Order Inquiry API](/develop/api/sell/sell_order_inquiry). Case information is returned if there is a case filed against the inquiry [Search Cases](/Devzone/post-order/post-order_v2_casemanagement_search__get.html) (Return case) [sellerOrderReturns](/develop/api/sell/sell_return#sell-sell_return-query-sellerorderreturns) query of [Return API](/develop/api/sell/sell_return). 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](/devzone/post-order/index.html) 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](#decommed) 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](/Devzone/post-order/post-order_v2_inquiry-inquiryid_escalate__post.html) [submitOrderInquiryReferral](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-submitorderinquiryreferral) mutation of [Order Inquiry API](/develop/api/sell/sell_order_inquiry). [Get Inquiry](/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) [orderInquiry](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-query-orderinquiry) query of [Order Inquiry API](/develop/api/sell/sell_order_inquiry). [Issue Inquiry Refund](/Devzone/post-order/post-order_v2_inquiry-inquiryid_issue_refund__post.html) [processOrderInquiryRefund](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-processorderinquiryrefund) method of [Order Inquiry API](/develop/api/sell/sell_order_inquiry). [Provide Inquiry Refund Info](/Devzone/post-order/post-order_v2_inquiry-inquiryid_provide_refund_info__post.html) **None** No direct equivalent for this method, but seller can use the [sendOrderInquiryMessage](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-sendorderinquirymessage) mutation of [Order Inquiry API](/develop/api/sell/sell_order_inquiry).to update buyer that a refund has been issued [Provide Inquiry Shipment Info](/Devzone/post-order/post-order_v2_inquiry-inquiryid_provide_shipment_info__post.html) [provideShipmentInfoForItemNotReceivedInquiry](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-provideshipmentinfoforitemnotreceivedinquiry) mutation of [Order Inquiry API](/develop/api/sell/sell_order_inquiry). [Search Inquiries](/Devzone/post-order/post-order_v2_inquiry_search__get.html) [sellerOrderInquiries](/develop/api/sell/sell_order_inquiry#method-query-sellerOrderInquiries) query of [Order Inquiry API](/develop/api/sell/sell_order_inquiry#api-sell_order_inquiry). [Send Inquiry Message](/Devzone/post-order/post-order_v2_inquiry-inquiryid_send_message__post.html) [sendOrderInquiryMessage](/develop/api/sell/sell_order_inquiry#sell-sell_order_inquiry-mutation-sendorderinquirymessage) mutation of [Order Inquiry API](/develop/api/sell/sell_order_inquiry). ##### Account Management APIs * [eBay Store calls](/keystone/guides/ebay_store) * [eBay Seller Preferences calls](/keystone/guides/seller_preferences) * [Sales tax calls](/keystone/guides/sales_tax) * [Other Account Management calls](/keystone/guides/other_account_management) ###### eBay Store calls The APIs covered in this section include [GetUser](/Devzone/XML/docs/Reference/eBay/GetUser.html), [GetAccount](/Devzone/XML/docs/Reference/eBay/GetAccount.html), [GetBidderList](/devzone/xml/docs/Reference/eBay/GetBidderList.html), eBay Store calls, seller preferences calls, sales tax calls, and user note calls. Traditional API(s) Modern API Replacement(s) [GetStore](/Devzone/XML/docs/Reference/eBay/GetStore.html) (Retrieve name, description, logo, URL, and last opened time) [getStore](/api-docs/sell/stores/resources/store/methods/getStore) method of [Stores API](/api-docs/sell/stores/resources/methods) [GetStore](/Devzone/XML/docs/Reference/eBay/GetStore.html) (Retrieve the full eBay store category hierarchy.) [getStoreCategories](/api-docs/sell/stores/resources/store/methods/getStoreCategories) method of [Stores API](/api-docs/sell/stores/resources/methods) [GetStoreCategoryUpdateStatus](/devzone/xml/docs/Reference/eBay/GetStoreCategoryUpdateStatus.html) [getStoreTask](/api-docs/sell/stores/resources/store/methods/getStoreTask) method of [Stores API](/api-docs/sell/stores/resources/methods) **Key behaviors/changes**: * A **taskId** value is returned in the **Location** response header for an add, move, rename, and delete operation and [getStoreTask](/api-docs/sell/stores/resources/store/methods/getStoreTask) takes this ID as a path parameter. * [getStoreTasks](/api-docs/sell/stores/resources/store/methods/getStoreTasks) is an additional method that returns all recent completed, pending and failed tasks [SetStoreCategories](/devzone/xml/docs/Reference/eBay/SetStoreCategories.html) (Add store category) [addStoreCategory](/api-docs/sell/stores/resources/store/methods/addStoreCategory),method of [Stores API](/api-docs/sell/stores/resources/methods) **Key behaviors/changes**: * The [destinationParentCategoryId](/api-docs/sell/stores/resources/store/methods/addStoreCategory#request.destinationParentCategoryId) field is used to specify the parent store category that the new category will belong to. If this field is omitted, the new category becomes a top-level store category * The [listingDestinationCategoryId](/api-docs/sell/stores/resources/store/methods/addStoreCategory#request.listingDestinationCategoryId) field is needed if the specified parent category is a leaf category with active listings, and those active listings will be moved to the category specified here. If this field is omitted, the active listings in the parent category move to the new category * This operation is processed asynchronously and a [getStoreTask](/api-docs/sell/stores/resources/store/methods/getStoreTask) URI with the task ID is returned in the Location response header so that the user can check status after the add operation [SetStoreCategories](/devzone/xml/docs/Reference/eBay/SetStoreCategories.html) (Move store category) [moveStoreCategory](/api-docs/sell/stores/resources/store/methods/moveStoreCategory) method of [Stores API](/api-docs/sell/stores/resources/methods) **Key behaviors/changes**: * The [destinationParentCategoryId](/api-docs/sell/stores/resources/store/methods/moveStoreCategory#request.destinationParentCategoryId) field is used to specify the parent store category that the category will move to. If this field is omitted, the category becomes a top-level store category * The [listingDestinationCategoryId](/api-docs/sell/stores/resources/store/methods/moveStoreCategory#request.listingDestinationCategoryId) field is needed if the category being moved is a leaf category with active listings but will become a non-leaf category after this move. Those active listings will be moved to the category specified here. * This operation is processed asynchronously and a [getStoreTask](/api-docs/sell/stores/resources/store/methods/getStoreTask) URI with the task ID is returned in the Location response header so that the user can check status after the move operation [SetStoreCategories](/devzone/xml/docs/Reference/eBay/SetStoreCategories.html) ( Rename store category) [renameStoreCategory](/api-docs/sell/stores/resources/store/methods/renameStoreCategory) method of [Stores API](/api-docs/sell/stores/resources/methods) **Key behaviors/changes**: * The store category to rename is specified through the **category\_id** path parameter * The new name of the category is specified through the [categoryName](/api-docs/sell/stores/resources/store/methods/renameStoreCategory#request.categoryName) field * This name change is processed synchronously if the operation is successful [SetStoreCategories](/devzone/xml/docs/Reference/eBay/SetStoreCategories.html) (Delete store category) [deleteStoreCategory](/api-docs/sell/stores/resources/store/methods/deleteStoreCategory) method of [Stores API](/api-docs/sell/stores/resources/methods) **Key behaviors/changes**: * The store category to delete is specified through the **category\_id** path parameter * The [listingDestinationCategoryId](/api-docs/sell/stores/resources/store/methods/deleteStoreCategory#request.listingDestinationCategoryId) field is needed if the category being deleted or any existing child categories are leaf categories with active listings. Those active listings will be moved to the category specified here. * This operation is processed asynchronously and a [getStoreTask](/api-docs/sell/stores/resources/store/methods/getStoreTask) URI with the task ID is returned in the **Location** response header so that the user can check status after the move operation ###### eBay Seller Preferences calls Traditional API(s) Modern API Replacement(s) [GetUserPreferences](/devzone/xml/docs/Reference/eBay/GetUserPreferences.html) [getUserPreferences](/api-docs/sell/account/v2/resources/user_preferences/methods/getUserPreferences) method of [Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * The default behavior is to retrieve all seller preferences. The boolean fields in [Trading API](/devzone/xml/docs/Reference/eBay/index.html) call are replaced by a [fieldgroups](/api-docs/sell/account/v2/resources/user_preferences/methods/getUserPreferences#uri.fieldgroups) query parameter that supports multiple comma-delimited values. * The [ShowBidderNoticePreferences](/devzone/xml/docs/Reference/eBay/GetUserPreferences.html#Request.ShowBidderNoticePreferences) boolean will not be migrated as feature is no longer supported * The [ShoweBayPLUSPreference](/devzone/xml/docs/Reference/eBay/GetUserPreferences.html#Request.ShoweBayPLUSPreference) boolean will not be migrated as seller no longer has control over eBay Plus eligibility * The [ShowSellerFavoriteItemPreference](/devzone/xml/docs/Reference/eBay/GetUserPreferences.html#Request.ShowSellerFavoriteItemPreferences) boolean will not be migrated as feature is no longer supported * The [ShowSellerPaymentPreferences](/devzone/xml/docs/Reference/eBay/GetUserPreferences.html#Request.ShowSellerPaymentPreferences) boolean field will be repurposed and renamed to [shippingCarrierRatePreferences](/api-docs/sell/account/v2/resources/user_preferences/methods/getUserPreferences#response.shippingCarrierRatePreferences) as legacy payment method preferences are no longer applicable with eBay-managed payments, but FedEx and UPS shipping rate options still apply * The [ShowSellerProfilePreferences](/devzone/xml/docs/Reference/eBay/GetUserPreferences.html#Request.ShowSellerProfilePreferences) boolean will be migrated, but only the Business Policies opt-in boolean field will be returned and not individual business policies. The **Account v1 API** can be used to retrieve individual business policies * The [ShowSellerReturnPreferences](/devzone/xml/docs/Reference/eBay/GetUserPreferences.html#Request.ShowSellerReturnPreferences) boolean will not be migrated as opt-in to eBay-manager returns is no longer optional. [SetUserPreferences](/devzone/xml/docs/Reference/eBay/SetUserPreferences.html) [setUserPreferences](/api-docs/sell/account/v2/resources/user_preferences/methods/setUserPreferences) method of [Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * The name of [UnpaidItemAssistancePreferences](/devzone/xml/docs/Reference/eBay/SetUserPreferences.html#Request.UnpaidItemAssistancePreferences) container changed to [itemsAwaitingPaymentPreferences](/api-docs/sell/account/v2/resources/user_preferences/methods/setUserPreferences#request.itemsAwaitingPaymentPreferences) as Unpaid Item cases no longer exist * The name of [SellerPaymentPreferences](/devzone/xml/docs/Reference/eBay/SetUserPreferences.html#Request.SellerPaymentPreferences) container changed to [shippingCarrierRatePreferences](/api-docs/sell/account/v2/resources/user_preferences/methods/setUserPreferences#request.shippingCarrierRatePreferences) since only shipping carrier rates are controlled by seller * The [BidderNoticePreferences](/devzone/xml/docs/Reference/eBay/SetUserPreferences.html#Request.BidderNoticePreferences) container will not be migrated as the feature is no longer supported * The [OverrideGSPserviceWithIntlService](/devzone/xml/docs/Reference/eBay/SetUserPreferences.html#Request.OverrideGSPserviceWithIntlService) container will not be migrated as the preference is no longer supported * The [SellerFavoriteItemPreferences](/devzone/xml/docs/Reference/eBay/SetUserPreferences.html#Request.SellerFavoriteItemPreferences) container will not be migrated as the feature is no longer supported ###### Sales tax calls Traditional API(s) Modern API Replacement(s) [GetTaxTable](/devzone/xml/docs/Reference/eBay/GetTaxTable.html) [getSalesTaxes](/api-docs/sell/account/resources/sales_tax/methods/getSalesTaxes) method of [Account v1 API](/api-docs/sell/account/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, an ISO Country Code is passed in through the [country\_code](/api-docs/sell/account/resources/sales_tax/methods/getSalesTaxes#uri.country_code) query parameter * Only 5 US territories and Canadian provinces support seller-provided sales tax rates, so only values supported in [country\_code](/api-docs/sell/account/resources/sales_tax/methods/getSalesTaxes#uri.country_code) are US and CA * [getSalesTax](/api-docs/sell/account/resources/sales_tax/methods/getSalesTax) method of [Account v1 API](/api-docs/sell/account/resources/methods) can get sales tax rate settings for a specific tax jurisdiction by passing in a {countryCode) value and a (jurisdictionId} value [SetTaxTable](/devzone/xml/docs/Reference/eBay/SetTaxTable.html) (Set or modify sales tax settings for one jurisdiction) [createOrReplaceSalesTax](/api-docs/sell/account/resources/sales_tax/methods/createOrReplaceSalesTax) method of [Account v1 API](/api-docs/sell/account/resources/methods) **Key behaviors/changes**: * The {countryCode) and (jurisdictionId} path parameters identify the tax jurisdiction where sales tax settings will be added or modified. * The [getSalesTaxJurisdiction](/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions) method of the [Metadata API](/api-docs/sell/metadata/resources/methods) can be used to retrieve valid tax jurisdictions for US or Canada * The two request fields, [salesTaxPercentage](/api-docs/sell/account/resources/sales_tax/methods/createOrReplaceSalesTax#request.salesTaxPercentage) and [shippingAndHandlingTaxed](/api-docs/sell/account/resources/sales_tax/methods/createOrReplaceSalesTax#request.shippingAndHandlingTaxed), must be included even if one of the field's value may not be changing [SetTaxTable](/devzone/xml/docs/Reference/eBay/SetTaxTable.html) (Set or modify sales tax settings for multiple jurisdictions) [bulkCreateOrReplaceSalesTax](/api-docs/sell/account/resources/sales_tax/methods/bulkCreateOrReplaceSalesTax) method of [Account v1 API](/api-docs/sell/account/resources/methods) **Key behaviors/changes**: * A separate node under the [salesTaxInputList](/api-docs/sell/account/resources/sales_tax/methods/bulkCreateOrReplaceSalesTax#request.salesTaxInputList) array is needed for each tax jurisdiction that will get new or modified sales tax settings * The [countryCode](/api-docs/sell/account/resources/sales_tax/methods/bulkCreateOrReplaceSalesTax#request.salesTaxInputList.countryCode) field identifies the country and the [salesTaxJurisdictionId](/api-docs/sell/account/resources/sales_tax/methods/bulkCreateOrReplaceSalesTax#request.salesTaxInputList.salesTaxJurisdictionId) field identifies the tax jurisdiction where sales tax settings will be added or modified. * The [getSalesTaxJurisdiction](/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions) method of the [Metadata API](/api-docs/sell/metadata/resources/methods) can be used to retrieve valid tax jurisdictions for US or Canada * The two other request fields, [salesTaxPercentage](/api-docs/sell/account/resources/sales_tax/methods/createOrReplaceSalesTax#request.salesTaxPercentage) and [shippingAndHandlingTaxed](/api-docs/sell/account/resources/sales_tax/methods/createOrReplaceSalesTax#request.shippingAndHandlingTaxed), must be included even if one of the field's value may not be changing ###### Other Account Management calls Traditional API(s) Modern API Replacement(s) [GetUser](/Devzone/XML/docs/Reference/eBay/GetUser.html) [user](/develop/api/sell/sell_user#sell-sell_user-query-user) query of [User API](/develop/api/sell/sell_user). **Key behaviors/changes**: * Data may only be retrieved for the eBay user associated with OAuth token * More extensive data returned for Business account users * Returned data is controlled by different OAuth scopes * Feedback metrics, Feature Eligibility, Scheduling Info, Seller Payment Address, and Top Rated Seller info not being migrated [getUser](/api-docs/sell/identity/resources/user/methods/getUser) method of [Identity API](/api-docs/sell/identity/resources/methods) **Key behaviors/changes**: * Data may only be retrieved for the eBay user associated with OAuth token * More extensive data returned for Business account users * Returned data is controlled by different OAuth scopes * Less extensive data returned than [user](/develop/api/sell/sell_user#sell-sell_user-query-user) query of [User API](/develop/api/sell/sell_user). [GetUserContactDetails](/devzone/xml/docs/Reference/eBay/GetUserContactDetails.html) **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](/Devzone/XML/docs/Reference/eBay/GetAccount.html) [getBillingActivities](/api-docs/sell/finances/resources/billing_activity/methods/getBillingActivities) method of [Finances API.](/api-docs/sell/finances/resources/methods) **Key behaviors/changes**: * Can filter by order ID, listing ID, and/or date range. * The [getTransactions](/api-docs/sell/finances/resources/transaction/methods/getTransactions) method of [Finances API](/api-docs/sell/finances/resources/methods) can also be used to retrieve listing fees. * Fees can only be sorted by transaction date in descending or ascending order [SetUserNotes](/devzone/xml/docs/Reference/eBay/SetUserNotes.html) (Add or update note) [createOrReplaceUserNote](/develop/api/sell/user_note#sell-user_note-mutation-createorreplaceusernote) method of [User Note API](/develop/api/sell/user_note) **Key behaviors/changes**: * A purchasable item in a single or multiple-variation listing is identified through the [itemid](/develop/api/sell/user_note#sell-user_note-mutation-createorreplaceusernote.createorreplaceusernoteinput.itemid) field * A line item is identified through the [orderlineitemid](/develop/api/sell/user_note#sell-user_note-mutation-createorreplaceusernote.createorreplaceusernoteinput.orderlineitemid) field * If a user note already exists for the specified [itemid](/develop/api/sell/user_note#sell-user_note-mutation-createorreplaceusernote.createorreplaceusernoteinput.itemid) or [orderlineitemid](/develop/api/sell/user_note#sell-user_note-mutation-createorreplaceusernote.createorreplaceusernoteinput.orderlineitemid), that note will be overwritten with the new note * A SKU value is not supported [SetUserNotes](/devzone/xml/docs/Reference/eBay/SetUserNotes.html) (Delete note) [deleteUserNote](/develop/api/sell/user_note#sell-user_note-mutation-deleteusernote) method of [User Note API](/develop/api/sell/user_note) **Key behaviors/changes**: * A purchasable item in a single or multiple-variation listing is identified through the [itemid](/develop/api/sell/user_note#sell-user_note-mutation-deleteusernote.deleteusernoteinput.itemid) field * A line item is identified through the [orderlineitemid](/develop/api/sell/user_note#sell-user_note-mutation-deleteusernote.deleteusernoteinput.orderlineitemid) field [GetBidderList](/devzone/xml/docs/Reference/eBay/GetBidderList.html) [userBiddingActivity](/develop/api/sell/commerce_auction#sell-commerce_auction-query-userbiddingactivity) query of [Auction API](/develop/api/sell/commerce_auction) **Key behaviors/changes**: * This query can only retrieve bidding activity for the eBay user associated with the OAuth token * [ActiveItemsOnly](/devzone/xml/docs/Reference/eBay/GetBidderList.html#Request.ActiveItemsOnly) filter equivalent will not be available * Pagination control is available ##### 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](/devzone/xml/docs/Reference/eBay/GetShippingDiscountProfiles.html) [getCombinedShippingRules](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/getCombinedShippingRules) method of [Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, the eBay marketplace is passed in through the **X-EBAY-C-MARKETPLACE-ID** header * With the exception of the name change from Discount Profile to Shipping Rule, the data returned in the new method is very similar to [GetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/GetShippingDiscountProfiles.html) [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) (Create one or more calculated shipping rules) [createCalculatedShippingRules](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/createCalculatedShippingRules) method of,[Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, the eBay marketplace is passed in through the **X-EBAY-C-MARKETPLACE-ID** header * With the exception of the name change from Discount Profile to Shipping Rule, the request data in the new method is very similar to [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) for calculated shipping discounts [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) (Create one or more flat shipping rules) [createFlatShippingRules](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/createFlatShippingRules) method of,[Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, the eBay marketplace is passed in through the **X-EBAY-C-MARKETPLACE-ID** header * With the exception of the name change from Discount Profile to Shipping Rule, the request data in the new method is very similar to [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) for flat shipping discounts [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) (Create a promotional shipping rule) [createPromotionalShippingRule](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/createPromotionalShippingRule) method of,[Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, the eBay marketplace is passed in through the **X-EBAY-C-MARKETPLACE-ID** header * With the exception of the name change from Discount Profile to Shipping Rule, the request data in the new method is very similar to [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) for promotional shipping discounts [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) (Update one or more calculated shipping rules) [updateCalculatedShippingRules](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/updateCalculatedShippingRules) method of,[Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, the eBay marketplace is passed in through the **X-EBAY-C-MARKETPLACE-ID** header * The shipping rule(s) to update are identified through the [combinedShippingRuleId](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/updateCalculatedShippingRules#request.calculatedShippingRule.combinedShippingRules.combinedShippingRuleId) field * This method is a complete replacement, so all applicable fields should be passed in even if their values are not changing * With the exception of the name change from Discount Profile to Shipping Rule, the request data in the new method is very similar to [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) for calculated shipping discounts [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) (Update one or more flat shipping rules) [updateFlatShippingRules](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/updateFlatShippingRules) method of,[Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, the eBay marketplace is passed in through the **X-EBAY-C-MARKETPLACE-ID** header * The shipping rule(s) to update are identified through the [combinedShippingRuleId](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/updateFlatShippingRules#request.flatShippingRule.combinedShippingRules.combinedShippingRuleId) field * This method is a complete replacement, so all applicable fields should be passed in even if their values are not changing * With the exception of the name change from Discount Profile to Shipping Rule, the request data in the new method is very similar to [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) for flat shipping discounts [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) (Update a promotional shipping rule) [updatePromotionalShippingRule](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/updatePromotionalShippingRule) method of,[Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, the eBay marketplace is passed in through the **X-EBAY-C-MARKETPLACE-ID** header * This method is a complete replacement, so all applicable fields should be passed in even if their values are not changing * With the exception of the name change from Discount Profile to Shipping Rule, the request data in the new method is very similar to [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) for flat shipping discounts [SetShippingDiscountProfiles](/devzone/xml/docs/Reference/eBay/SetShippingDiscountProfiles.html) (Update combined payments duration) [updateCombinedPayments](/api-docs/sell/account/v2/resources/combined_shipping_rules/methods/updateCombinedPayments) method of,[Account API v2](/api-docs/sell/account/v2/resources/methods) **Key behaviors/changes**: * Instead of a Site ID header value, the eBay marketplace is passed in through the **X-EBAY-C-MARKETPLACE-ID** header * This method only updates the combined payments duration period ##### Communication APIs * [Messaging APIs](#sell_messaging) * [Feedback APIs](#sell_feedback) ###### Messaging APIs The alternatives to all Messaging calls in the [Trading API](/devzone/xml/docs/Reference/eBay/index.html) will be the new REST-based [Message API](/api-docs/commerce/message/resources/methods). 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](/devzone/xml/docs/Reference/eBay/AddMemberMessageAAQToPartner.html) [sendMessage](/api-docs/commerce/message/resources/conversation/methods/sendMessage) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * Ask Seller Question topics can no longer be customized * If a conversation already exists between the two eBay users, the [conversationId](/api-docs/commerce/message/resources/conversation/methods/sendMessage#request.conversationId) value is needed * The [reference](/api-docs/commerce/message/resources/conversation/methods/sendMessage#request.reference) container replaces the [ItemID](/devzone/xml/docs/Reference/eBay/AddMemberMessageAAQToPartner.html#Request.ItemID) in the traditional call [AddMemberMessageRTQ](/devzone/xml/docs/Reference/eBay/AddMemberMessageRTQ.html) [AddMemberMessagesAAQToBidder](/devzone/xml/docs/Reference/eBay/AddMemberMessagesAAQToBidder.html) [GetMyMessages](/Devzone/XML/docs/Reference/eBay/GetMyMessages.html) [getConversations](/api-docs/commerce/message/resources/conversation/methods/getConversations) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * This method has a required [conversation\_type](/api-docs/commerce/message/resources/conversation/methods/getConversations#uri.conversation_type) query parameter used to retrieve one or more conversations from either eBay or from other eBay members * The retrieved conversation(s) can be filtered by date range and/or by [conversation\_status](/api-docs/commerce/message/resources/conversation/methods/getConversations#uri.conversation_status) * There are also filters to retrieve conversation(s) between the user and another specific eBay user and a filter combination to retrieve all conversations concerning a specific eBay listing * Pagination control is available * External messages and the [IncludeHighPriorityMessageOnly](/Devzone/XML/docs/Reference/eBay/GetMyMessages.html#Request.IncludeHighPriorityMessageOnly) boolean are not be carried over * Custom folder names are still available in eBay InBox, but will not have API support [getConversation](/api-docs/commerce/message/resources/conversation/methods/getConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * This method retrieves a specific conversation between the authenticated user and either eBay or another eBay user * The **conversation\_id** is passed in as a parth parameter [GetMemberMessages](/Devzone/XML/docs/Reference/eBay/GetMemberMessages.html) [getConversations](/api-docs/commerce/message/resources/conversation/methods/getConversations) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * [GetMemberMessages](/Devzone/XML/docs/Reference/eBay/GetMemberMessages.html) retrieves only message from other eBay members, so the [conversation\_type](/api-docs/commerce/message/resources/conversation/methods/getConversations#uri.conversation_type) query parameter value should be set to FROM\_EBAY * See additional notes for this method in the [GetMyMessages](/Devzone/XML/docs/Reference/eBay/GetMyMessages.html) row above [getConversation](/api-docs/commerce/message/resources/conversation/methods/getConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * See additional notes for this method in the [GetMyMessages](/Devzone/XML/docs/Reference/eBay/GetMyMessages.html) row above [ReviseMyMessages](/Devzone/XML/docs/Reference/eBay/ReviseMyMessages.html) [bulkUpdateConversation](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * This bulk method updates the status of all messages within multiple conversations (up to 10) * The [conversationType](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationType) field is required and specifies whether the conversations to update are from eBay or from other eBay members * The supported [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationStatus) values include ACTIVE, ARCHIVED, DELETED, READ, UNREAD * Only conversations can be acted upon and not specific folders or specific messages [updateConversation](/api-docs/commerce/message/resources/conversation/methods/updateConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * This method updates the status of all messages within one conversation * The [conversationId](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationId) and [conversation\_type](/api-docs/commerce/message/resources/conversation/methods/getConversations#uri.conversation_type) fields are both required, with the former identifying the conversation and the latter specifying whether the conversation to update is from eBay or from another eBay member * The supported [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationStatus) values include ACTIVE, ARCHIVE, and DELETE * The [read](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.read) boolean field is included and set to ‘true' to mark all messages within the conversation as read or ‘false' to mar all messages within the conversation as unread * Only conversations can be acted upon and not specific folders or specific messages [DeleteMyMessages](/Devzone/XML/docs/Reference/eBay/DeleteMyMessages.html) [bulkUpdateConversation](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * Set the [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationStatus) value to DELETE, and the conversations (up to 10) and all messages within each specified conversation will be deleted from the user's InBox * Conversations and all messages can also be archived instead of deleted by setting the [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationStatus) value to ARCHIVE * See additional notes for this method in the [ReviseMyMessages](/Devzone/XML/docs/Reference/eBay/ReviseMyMessages.html) row above [updateConversation](/api-docs/commerce/message/resources/conversation/methods/updateConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * Set the [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationStatus) value to DELETE, and the conversation and all messages within the conversation will be deleted from the user's InBox * Conversations and all messages can also be archived instead of deleted by setting the [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationStatus) value to ARCHIVE * See additional notes for this method in the [ReviseMyMessages](/Devzone/XML/docs/Reference/eBay/ReviseMyMessages.html) row above [GetMessagePreferences](/Devzone/XML/docs/Reference/eBay/GetMessagePreferences.html) and [SetMessagePreferences](/Devzone/XML/docs/Reference/eBay/SetMessagePreferences.html) **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](/Devzone/XML/docs/Reference/eBay/ReviseMyMessagesFolders.html) **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](/devzone/xml/docs/Reference/eBay/index.html) will be the new REST-based [Feedback API](/api-docs/commerce/feedback/resources/methods). The following table has the modern API replacements and any relevant notes for each Feedback call: Traditional API(s) Modern API Replacement(s) [GetItemsAwaitingFeedback](/devzone/xml/docs/Reference/eBay/GetItemsAwaitingFeedback.html) [getItemsAwaitingFeedback](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes**: * The [filter](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback#uri.filter) query parameter allows a user to retrieve items awaiting feedback for a specific listing or from a specific order partner * The [filter](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback#uri.filter) query parameter also allows a user to set their **userRole** as SELLER or BUYER to only retrieve items awaiting feedback from either of those roles * Items can only be sorted by transaction/commitment time * A new [ratingTemplates](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback#response.lineItems.ratingTemplates) is returned to assist buyer in leaving detailed seller ratings for sellers [GetFeedback](/devzone/xml/docs/Reference/eBay/GetFeedback.html) (Retrieve user feedback entries) [getFeedback](/api-docs/commerce/feedback/resources/feedback/methods/getFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes:** * The user to retrieve feedback for is specified through the [user\_id](/api-docs/commerce/feedback/resources/feedback/methods/getFeedback#uri.user_id) query parameter * The [feedback\_type](/api-docs/commerce/feedback/resources/feedback/methods/getFeedback#uri.feedback_type) is also required and is set to either FEEDBACK\_RECEIVED or FEEDBACK\_SENT * The same request filters available through the traditional API are also available through the REST API * Additionally, the [filter](/api-docs/commerce/feedback/resources/feedback/methods/getFeedback#uri.filter) query parameter can be used to retrieve feedback based on certain topics, feedback with associated images, and automated feedback left by eBay * Pagination control supported [GetFeedback](/devzone/xml/docs/Reference/eBay/GetFeedback.html) (Retrieve user feedback metrics) [getFeedbackRatingSummary](/api-docs/commerce/feedback/resources/feedback_rating_summary/methods/getFeedbackRatingSummary) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes:** * The user to retrieve feedback metrics for is specified through the [user\_id](/api-docs/commerce/feedback/resources/feedback_rating_summary/methods/getFeedbackRatingSummary#uri.user_id) query parameter * Multiple filters and filter values are available through the [filter](/api-docs/commerce/feedback/resources/feedback_rating_summary/methods/getFeedbackRatingSummary#uri.filter) query parameter, but the **ratingType** filter must be used, and the supported rating types are defined in the [FeedbackRatingTypeEnum](/api-docs/commerce/feedback/types/fdb:FeedbackRatingTypeEnum) type * The response of this method will vary based on the **ratingType** that is used [LeaveFeedback](/devzone/xml/docs/Reference/eBay/LeaveFeedback.html) [leaveFeedback](/api-docs/commerce/feedback/resources/feedback/methods/leaveFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes:** * New method can associate up to five images with the feedback comment by passing in URL to images * Detailed seller ratings are provided through key-value pairs in the [sellerRatings](/api-docs/commerce/feedback/resources/feedback/methods/leaveFeedback#request.sellerRatings) array * When providing ratings in the [sellerRatings](/api-docs/commerce/feedback/resources/feedback/methods/leaveFeedback#request.sellerRatings) array, the [getItemsAwaitingFeedback](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback) method can be used to see the supported values for detailed seller ratings by looking at the [ratingTemplates](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback#response.lineItems.ratingTemplates) array in the response [RespondToFeedback](/devzone/xml/docs/Reference/eBay/RespondToFeedback.html) [respondToFeedback](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes:** * The [feedbackId](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback#request.feedbackId), [recipientUserId](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback#request.recipientUserId), [responseText](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback#request.responseText), and [responseType](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback#request.responseType) are all specified in the request and are required ##### 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](/devzone/xml/docs/Reference/eBay/GetBestOffers.html) [sellerNegotiationHistory](/develop/api/sell/sell_offer#sell-sell_offer-query-sellernegotiationhistory) query of [Offer API](/develop/api/sell/sell_offer) **Key behaviors/changes:** * Filter by date range, user role, and offer status * Pagination control is available [RespondToBestOffer](/devzone/xml/docs/Reference/eBay/RespondToBestOffer.html) (Accept buyer's offer or counter offer) [acceptOffer](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer) mutation of [Offer API](/develop/api/sell/sell_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.itemid) fields identify the offer and item, respectively * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.message) field is optional [RespondToBestOffer](/devzone/xml/docs/Reference/eBay/RespondToBestOffer.html) (Counter a buyer's offer or counter offer) [**counterOffer**](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer) mutation of [Offer API](/develop/api/sell/sell_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.itemid) fields identify the offer and item, respectively * The proposed counter offer price is set in the [proposedPrice](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.proposedprice) container * The [quantity](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.quantity) field is optional and is only needed if the seller's counter offer involves increasing or decreasing the current quantity of the offer * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.message) field is optional [RespondToBestOffer](/devzone/xml/docs/Reference/eBay/RespondToBestOffer.html) (Decline a buyer's offer or counter offer) [declineOffer](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer) mutation of [Offer API](/develop/api/sell/sell_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.itemid) fields identify the offer and item, respectively * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.message) field is optional [GetAdFormatLeads](/devzone/xml/docs/Reference/eBay/GetAdFormatLeads.html) (Search for classified ad leads) [getAllClassifiedLeads](/api-docs/sell/leads/resources/classified_lead/methods/getAllClassifiedLeads) method of [Leads API](/api-docs/sell/leads/resources/methods) **Key behaviors/changes:** * Retrieve classified ad leads by date range by setting the [startTime](/api-docs/sell/leads/resources/classified_lead/methods/getAllClassifiedLeads#uri.startTime) and [endTime](/api-docs/sell/leads/resources/classified_lead/methods/getAllClassifiedLeads#uri.endTime) dates * Include the [status](/api-docs/sell/leads/resources/classified_lead/methods/getAllClassifiedLeads#uri.status) query parameter if you only want to retrieve answered or unanswered sales leads * Include the [includeMessages](/api-docs/sell/leads/resources/classified_lead/methods/getAllClassifiedLeads#uri.includeMessages) boolean field and set it to true if you only want to retrieve sales leads where potential buyer has left a message [GetAdFormatLeads](/devzone/xml/docs/Reference/eBay/GetAdFormatLeads.html) (Retrieve ad leads for a listing) [getClassifiedLeadsByItemId](/api-docs/sell/leads/resources/classified_lead/methods/getClassifiedLeadsByItemId) method of [Leads API](/api-docs/sell/leads/resources/methods) **Key behaviors/changes:** * Works similarly to [getAllClassifiedLeads](/api-docs/sell/leads/resources/classified_lead/methods/getAllClassifiedLeads) with same query parameters, but only retrieves classified ad leads from a specific listing which is identified through the **{itemId}** path parameter * See previous row for more information on available query parameters ## Buy APIs .custom-width { min-width: auto !important; width: 46em; } .disabled-link { pointer-events: none; /\* \[cite: 7\] \*/ cursor: default; /\* \[cite: 8\] \*/ color: #888888; /\* \[cite: 9\] \*/ text-decoration: none; /\* \[cite: 10\] \*/ } 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](#buying_and_bidding) * [Inventory Discovery APIs](#inventory_discovery) * [Order Management APIs](#buy_order_management) * [Account Management APIs](#buy_account_management) * [Communication APIs](#buy_communication) * [Marketing and Discounts APIs](#buy_marketing) * [Marketplace Metadata APIs](#marketplace_metadata) ##### 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](/devzone/xml/docs/Reference/eBay/PlaceOffer.html) (Accept seller's counteroffer) [acceptOffer](/develop/api/buy/buy_offer#buy-buy_offer-mutation-acceptoffer) mutation of GraphQL-based [Offer API](/develop/api/buy/buy_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.itemid) fields identify the offer and item, respectively * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.message) field is optional [PlaceOffer](/devzone/xml/docs/Reference/eBay/PlaceOffer.html) (Place max bid on auction) [placeProxyBid](/api-docs/buy/offer/resources/bidding/methods/placeProxyBid) method of REST-based [Offer API](/api-docs/buy/offer/resources/methods). **Key behaviors/changes:** * The auction to place a max bid threshold on is identified through the **{item\_id}** path parameter * The max bid threshold is set through the [maxAmount](/api-docs/buy/offer/resources/bidding/methods/placeProxyBid#request.maxAmount) container. The specified currency in the [currency](/api-docs/buy/offer/resources/bidding/methods/placeProxyBid#request.maxAmount.currency) must be the currency of the marketplace and the threshold set in the [value](/api-docs/buy/offer/resources/bidding/methods/placeProxyBid#request.maxAmount.value) must match or exceed the next minimum qualifying bid * A [proxyBidId](/api-docs/buy/offer/resources/bidding/methods/placeProxyBid#response.proxyBidId) value is returned in the response, and this value should be kept handy so the [getBidding](/api-docs/buy/offer/resources/bidding/methods/getBidding) method can be used to track bidding activity and status of the auction listing * If/when the user is outbid, the [highBidder](/api-docs/buy/offer/resources/bidding/methods/getBidding#response.highBidder) boolean field in [getBidding](/api-docs/buy/offer/resources/bidding/methods/getBidding) response will show ‘false'. If the user is still interested in the auction item, the user should reference the [currentPrice](/api-docs/buy/offer/resources/bidding/methods/getBidding#response.currentPrice) value and then consider calling [proxyBidId](/api-docs/buy/offer/resources/bidding/methods/placeProxyBid#response.proxyBidId) again to reset the max bid threshold higher [PlaceOffer](/devzone/xml/docs/Reference/eBay/PlaceOffer.html) (Counter seller's counter offer) [**counterOffer**](/develop/api/buy/buy_offer#buy-buy_offer-mutation-counteroffer) mutation of GraphQL-based [Offer API](/develop/api/buy/buy_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.itemid) fields identify the offer and item, respectively * The proposed counter offer price is set in the [proposedPrice](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.proposedprice) container * The [quantity](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.quantity) field is optional and is only needed if the buyer's counter offer involves increasing or decreasing the current quantity of the offer * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.message) field is optional [PlaceOffer](/devzone/xml/docs/Reference/eBay/PlaceOffer.html) (Decline seller's counter offer) [declineOffer](/develop/api/buy/buy_offer#buy-buy_offer-mutation-declineoffer) mutation of GraphQL-based [Offer API](/develop/api/sell/sell_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.itemid) fields identify the offer and item, respectively * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.message) field is optional [PlaceOffer](/devzone/xml/docs/Reference/eBay/PlaceOffer.html) (Make best offer) [makeOffer](/develop/api/buy/buy_offer#buy-buy_offer-mutation-makeoffer) mutation of GraphQL-based [Offer API](/develop/api/buy/buy_offer) **Key behaviors/changes:** * The [itemid](/develop/api/buy/buy_offer#buy-buy_offer-mutation-makeoffer.makeofferinput.itemid) field identifies the item to make an offer on * The proposed offer price is set in the [proposedPrice](/develop/api/buy/buy_offer#buy-buy_offer-mutation-makeoffer.makeofferinput.proposedprice) container * The [quantity](/develop/api/buy/buy_offer#buy-buy_offer-mutation-makeoffer.makeofferinput.quantity) field is optional and defaults to 1 if not included * The [message](/develop/api/buy/buy_offer#buy-buy_offer-mutation-makeoffer.makeofferinput.message) field is optional [PlaceOffer](/devzone/xml/docs/Reference/eBay/PlaceOffer.html) (Commit to purchase fixed price item) [commitToPurchase](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-mutation-committopurchase) mutation of [Item Commitment API](/develop/api/buy/buy_item_commitment). **Key behaviors/changes:** * The [itemid](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-mutation-committopurchase.committopurchaseinput.itemid) field identifies the item to make a purchase commitment * The purchase price is specified through the [price](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-mutation-committopurchase.committopurchaseinput.price) container. The currency specified in the [currency](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-mutation-committopurchase.amountinput.currency) field should match the currency of the listing marketplace and the price input into the [value](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-mutation-committopurchase.amountinput.value) field should match the ‘Buy it Now' price of the item at execution time or operation will fail * The [quantity](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-mutation-committopurchase.committopurchaseinput.quantity) field is optional and defaults to 1 if not included * The buyer will need to follow up to make payment on the item commitment [GetBestOffers](/devzone/xml/docs/Reference/eBay/GetBestOffers.html) [buyerNegotiationHistory](/develop/api/buy/buy_offer#buy-buy_offer-query-buyernegotiationhistory) query of GraphQL-based [Offer API](/develop/api/buy/buy_offer) **Key behaviors/changes:** * Filter by date range, user role, and offer status * Pagination control is available [RespondToBestOffer](/devzone/xml/docs/Reference/eBay/RespondToBestOffer.html) (Accept seller's counter offer) [acceptOffer](/develop/api/buy/buy_offer#buy-buy_offer-mutation-acceptoffer) mutation of [Offer API](/develop/api/buy/buy_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.itemid) fields identify the offer and item, respectively * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.message) field is optional [RespondToBestOffer](/devzone/xml/docs/Reference/eBay/RespondToBestOffer.html) (Counter seller's counter offer) [counterOffer](/develop/api/buy/buy_offer#buy-buy_offer-mutation-counteroffer) mutation of [Offer API](/develop/api/buy/buy_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.itemid) fields identify the offer and item, respectively * The proposed counter offer price is set in the [proposedPrice](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.proposedprice) container * The [quantity](/develop/api/sell/sell_offer#sell-sell_offer-mutation-counteroffer.counterofferinput.quantity) field is optional and is only needed if the buyer's counter offer involves increasing or decreasing the current quantity of the offer * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-acceptoffer.acceptofferinput.message) field is optional [RespondToBestOffer](/devzone/xml/docs/Reference/eBay/RespondToBestOffer.html) (Decline seller's counter offer) [declineOffer](/develop/api/buy/buy_offer#buy-buy_offer-mutation-declineoffer) mutation of [Offer API](/develop/api/buy/buy_offer) **Key behaviors/changes:** * The [offerid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.offerid) and [itemid](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.itemid) fields identify the offer and item, respectively * The [message](/develop/api/sell/sell_offer#sell-sell_offer-mutation-declineoffer.declineofferinput.message) field is optional [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [BestOfferList](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.BestOfferList)) [buyerNegotiationHistory](/develop/api/buy/buy_offer#buy-buy_offer-query-buyernegotiationhistory) query of GraphQL-based [Offer API](/develop/api/buy/buy_offer) **Key behaviors/changes:** * Filter by date range, user role, and offer status * Pagination control is available [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [BidList](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.BidList)) [userBiddingActivity](/develop/api/sell/auction#sell-auction-query-userbiddingactivity) query of [Auction API](/develop/api/sell/auction) **Key behaviors/changes**: * This query can only retrieve bidding activity for the eBay user associated with the OAuth token * List can be filtered by date range * Pagination control is available [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [BuyingSummary](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.BuyingSummary)) [buyerNegotiationHistory](/develop/api/buy/buy_offer#buy-buy_offer-query-buyernegotiationhistory) query of GraphQL-based [Offer API](/develop/api/buy/buy_offer) retrieves [negotiationCount](/develop/api/buy/buy_offer#buy-buy_offer-query-buyernegotiationhistory.itemofferoverview.negotiationcount), which is the equivalent of [BestOfferCount](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.BuyingSummary.BestOfferCount) [userBiddingActivity](/develop/api/sell/auction#sell-auction-query-userbiddingactivity) query of [Auction API](/develop/api/sell/auction) retrieves other fields of [BuyingSummary](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.BuyingSummary) [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [DeletedFromLostList](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.DeletedFromLostList)) **No replacement** No longer supported in My eBay [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [DeletedFromWonList](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.DeletedFromWonList)) **No replacement** No longer supported in My eBay [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [FavoriteSearches](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.FavoriteSearches)) [userSavedSearches](/develop/api/buy/buy_follow#method-Query-userSavedSearches) query of [Follow API](/develop/api/buy/buy_follow#api-buy_follow) **Key behaviors/changes**: * Retrieves an eBay user's saved searches * Pagination control is available [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [FavoriteSellers](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.FavoriteSellers)) [userSavedSellers](/develop/api/buy/buy_follow#buy-buy_follow-query-usersavedsellers) query of [Follow API](/develop/api/buy/buy_follow) **Key behaviors/changes**: * Retrieves an eBay user's saved sellers * Pagination control and sort options are available [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [LostList](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.LostList)) **No replacement** No longer supported in My eBay [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [SecondChanceOffer](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.SecondChanceOffer)) **No replacement** Will not migrate [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [UserDefinedList](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.UserDefinedList)) [userCustomLists](/develop/api/buy/buy_watch_list#buy-buy_watch_list-query-usercustomlists) query of [Watchlist API](/develop/api/buy/buy_watch_list) **Key behaviors/changes**: * Retrieves all user-defined lists if no filter is used * The [customlistids](/develop/api/buy/buy_watch_list#buy-buy_watch_list-query-usercustomlists.usercustomlistfilter.customlistids) array can be used to retrieve one or more specific user-defined lists [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [WatchList](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.WatchList)) [userWatchList](/develop/api/buy/buy_watch_list#buy-buy_watch_list-query-userwatchlist) query of [Watchlist API](/develop/api/buy/buy_watch_list) [GetMyeBayBuying](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html) (Retrieve [WonList](/devzone/xml/docs/Reference/eBay/GetMyeBayBuying.html#Response.WonList)) **No replacement** No longer supported in My eBay [GetItemShipping](/devzone/xml/docs/Reference/eBay/GetItemShipping.html) [getItem](/api-docs/buy/browse/resources/item/methods/getItem) family of methods in [Browse API](/api-docs/buy/browse/resources/methods) **Key behaviors/changes**: * The [quantity\_for\_shipping\_estimate](/api-docs/buy/browse/resources/item/methods/getItem#uri.quantity_for_shipping_estimate) query parameter is used to specify the quantity that will be shipped, * The [shippingOptions](/api-docs/buy/browse/resources/item/methods/getItem#response.shippingOptions) array shows the estimated shipping costs and delivery windows ##### 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](/Devzone/XML/docs/Reference/eBay/GetItem.html) [getItem](/api-docs/buy/browse/resources/item/methods/getItem) family of methods in [Browse API](/api-docs/buy/browse/resources/methods) See the [Discover and retrieve eBay items using the Browse API](/develop/guides-v2/inventory-discovery-and-refresh/inventory-discovery-and-refresh-guide#api-use-cases-) use case in the **Inventory Discovery and Refresh Guide** [AddToWatchList](/devzone/xml/docs/Reference/eBay/AddToWatchList.html) [addToWatchList](/develop/api/buy/buy_watch_list#method-Mutation-addToWatchList) mutation of [Watchlist API](/develop/api/buy/buy_watch_list#api-buy_watch_list) [RemoveFromWatchList](/devzone/xml/docs/Reference/eBay/RemoveFromWatchList.html) (Remove one or more items from Watchlist) [removeFromWatchList](/develop/api/buy/buy_watch_list#buy-buy_watch_list-mutation-removefromwatchlist) mutation of [Watchlist API](/develop/api/buy/buy_watch_list) **Key behaviors/changes**: * The [watchListCount](/develop/api/buy/buy_watch_list#buy-buy_watch_list-mutation-removefromwatchlist.removefromwatchlistsuccess.watchlistcount) and [watchListMaximum](/develop/api/buy/buy_watch_list#buy-buy_watch_list-mutation-removefromwatchlist.removefromwatchlistsuccess.watchlistmaximum) are returned in response * For different reasons, it is possible that some or all of the specified items fail to be removed from the Watchlist and an error message will indicate why any item was not successfully removed [RemoveFromWatchList](/devzone/xml/docs/Reference/eBay/RemoveFromWatchList.html) (Remove all items from Watchlist) [removeAllFromWatchList](/develop/api/buy/buy_watch_list#buy-buy_watch_list-mutation-removeallfromwatchlist) mutation of [Watchlist API](/develop/api/buy/buy_watch_list) **Key behaviors/changes**: * The [watchListCount](/develop/api/buy/buy_watch_list#buy-buy_watch_list-mutation-removefromwatchlist.removefromwatchlistsuccess.watchlistcount) and [watchListMaximum](/develop/api/buy/buy_watch_list#buy-buy_watch_list-mutation-removefromwatchlist.removefromwatchlistsuccess.watchlistmaximum) are returned in response * For different reasons, it is possible that some or all of the specified items fail to be removed from the Watchlist and an error message will indicate why any item was not successfully removed ##### Order Management APIs The two order management calls in the [Trading API](/devzone/xml/docs/Reference/eBay/index.html) are [GetOrders](/devzone/xml/docs/Reference/eBay/GetOrders.html#GetOrders) and [GetItemTransactions](/devzone/xml/docs/Reference/eBay/GetItemTransactions.html#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](/devzone/xml/docs/Reference/eBay/GetOrders.html) (paid orders/line items) [orders](/develop/api/buy/buy_order#buy-buy_order-query-orders) query of [Order API](/develop/api/buy/buy_order) [ordersByIds](/develop/api/buy/buy_order#buy-buy_order-query-ordersbyids) query of [Order API](/develop/api/buy/buy_order) [orderLineItemsByIds](/develop/api/buy/buy_order#buy-buy_order-query-orderlineitemsbyids) query of [Order API](/develop/api/buy/buy_order) [getOrders](/api-docs/sell/fulfillment/resources/order/methods/getOrders) and [getOrder](/api-docs/sell/fulfillment/resources/order/methods/getOrder) methods of [Fulfillment API](/api-docs/sell/fulfillment/resources/methods) [GetOrders](/devzone/xml/docs/Reference/eBay/GetOrders.html) (unpaid orders/line items) [itemCommitments](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-query-itemcommitments) query of [Item Commitment API](/develop/api/buy/buy_item_commitment) [itemCommitmentsByIds](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-query-itemcommitmentsbyids) query of [Item Commitment API](/develop/api/buy/buy_item_commitment) [GetItemTransactions](/devzone/xml/docs/Reference/eBay/GetItemTransactions.html) (paid orders/line items) [orders](/develop/api/buy/buy_order#buy-buy_order-query-orders) query of [Order API](/develop/api/buy/buy_order), specifying the listing through the [listingId](/develop/api/buy/buy_order#buy-buy_order-query-orders.ordersfilterinput.listingid) field and including the [includeConfirmed](/develop/api/buy/buy_order#buy-buy_order-query-orders.ordersfilterinput.includeconfirmed) field and setting value to true [itemCommitments](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-query-itemcommitments) query of [Item Commitment API](/develop/api/buy/buy_item_commitment), specifying the listing through the [listingId](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-query-itemcommitments.itemcommitmentsfilterinput.listingid) field and including the [includeCompleted](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-query-itemcommitments.itemcommitmentsfilterinput.includecompleted) field and setting value to true [GetItemTransactions](/devzone/xml/docs/Reference/eBay/GetItemTransactions.html) (unpaid orders/line items) [itemCommitments](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-query-itemcommitments) query of [Item Commitment API](/develop/api/buy/buy_item_commitment), specifying the listing through the [listingId](/develop/api/buy/buy_item_commitment#buy-buy_item_commitment-query-itemcommitments.itemcommitmentsfilterinput.listingid) field [Get Cancellation](/Devzone/post-order/post-order_v2_cancellation-cancelid__get.html) [contractCancellation](/develop/api/buy/buy_cancellation#buy-buy_cancellation-query-contractcancellation) query of the [Cancellation API](/develop/api/buy/buy_cancellation) [Get Return](/Devzone/post-order/post-order_v2_return-returnid__get.html) [orderReturn](/develop/api/buy/buy_return#buy-buy_return-query-orderreturn) query of [Return API](/develop/api/buy/buy_return) [Get Inquiry](/Devzone/post-order/post-order_v2_inquiry-inquiryid__get.html) [orderInquiry](/develop/api/buy/buy_order_inquiry#buy-buy_order_inquiry-query-orderinquiry) query of [Order Inquiry API](/develop/api/buy/buy_order_inquiry) See the **Trading API order retrieval calls** section for more information about the [Order API](/develop/api/sell/sell_order) and [Item Commitment API](/develop/api/sell/sell_item_commitment) queries. ##### Account Management APIs The APIs covered in this section include [GetUser](/Devzone/XML/docs/Reference/eBay/GetUser.html), [GetBidderList](/devzone/xml/docs/Reference/eBay/GetBidderList.html), 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](/Devzone/XML/docs/Reference/eBay/GetUser.html) [user](/develop/api/buy/sell_user#buy-sell_user-query-user) query of [User API](/develop/api/buy/sell_user). **Key behaviors/changes**: * Data may only be retrieved for the eBay user associated with OAuth token * Returned data is controlled by different OAuth scopes [getUser](/api-docs/sell/identity/resources/user/methods/getUser) method of [Identity API](/api-docs/sell/identity/resources/methods) **Key behaviors/changes**: * Data may only be retrieved for the eBay user associated with OAuth token * Returned data is controlled by different OAuth scopes * Less extensive data returned than [user](/develop/api/buy/sell_user#buy-sell_user-query-user) query of [User API](/develop/api/buy/sell_user). [GetUserContactDetails](/devzone/xml/docs/Reference/eBay/GetUserContactDetails.html) **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](/devzone/xml/docs/Reference/eBay/SetUserNotes.html) (Add or update note) [createOrReplaceUserNote](/develop/api/buy/commerce_user_note#buy-commerce_user_note-mutation-createorreplaceusernote) mutation of [User Note API](/develop/api/buy/commerce_user_note) **Key behaviors/changes**: * A purchasable item in a single or multiple-variation listing is identified through the [itemid](/develop/api/buy/commerce_user_note#buy-commerce_user_note-mutation-createorreplaceusernote.createorreplaceusernoteinput.itemid) field * A line item is identified through the [orderlineitemid](/develop/api/buy/commerce_user_note#buy-commerce_user_note-mutation-createorreplaceusernote.createorreplaceusernoteinput.orderlineitemid) field * If a user note already exists for the specified [itemid](/develop/api/buy/commerce_user_note#buy-commerce_user_note-mutation-createorreplaceusernote.createorreplaceusernoteinput.itemid) or [orderlineitemid](/develop/api/buy/commerce_user_note#buy-commerce_user_note-mutation-createorreplaceusernote.createorreplaceusernoteinput.orderlineitemid), that note will be overwritten with the new note * A SKU value is not supported [SetUserNotes](/devzone/xml/docs/Reference/eBay/SetUserNotes.html) (Delete note) [deleteUserNote](/develop/api/buy/commerce_user_note#buy-commerce_user_note-mutation-deleteusernote) mutation of [User Note API](/develop/api/buy/commerce_user_note) **Key behaviors/changes**: * A purchasable item in a single or multiple-variation listing is identified through the [itemid](/develop/api/buy/commerce_user_note#buy-commerce_user_note-mutation-deleteusernote.deleteusernoteinput.itemid) field * A line item is identified through the [orderlineitemid](/develop/api/buy/commerce_user_note#buy-commerce_user_note-mutation-deleteusernote.deleteusernoteinput.orderlineitemid) field [GetBidderList](/devzone/xml/docs/Reference/eBay/GetBidderList.html) [userBiddingActivity](/develop/api/sell/auction#sell-auction-query-userbiddingactivity) query of [Auction API](/develop/api/sell/auction) **Key behaviors/changes**: * This query can only retrieve bidding activity for the eBay user associated with the OAuth token * [ActiveItemsOnly](/devzone/xml/docs/Reference/eBay/GetBidderList.html#Request.ActiveItemsOnly) filter equivalent will not be available * Pagination control is available ##### Communication APIs ###### Messaging APIs The alternatives to all Messaging calls in the [Trading API](/devzone/xml/docs/Reference/eBay/index.html) will be the new REST-based [Message API](/api-docs/commerce/message/resources/methods) . 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](/Devzone/XML/docs/Reference/eBay/GetMyMessages.html) [getConversations](/api-docs/commerce/message/resources/conversation/methods/getConversations) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * This method has a required [conversation\_type](/api-docs/commerce/message/resources/conversation/methods/getConversations#uri.conversation_type) query parameter used to retrieve one or more conversations from either eBay or from other eBay members * The retrieved conversation(s) can be filtered by date range and/or by [conversation\_status](/api-docs/commerce/message/resources/conversation/methods/getConversations#uri.conversation_status) * There are also filters to retrieve conversation(s) between the user and another specific eBay user and a filter combination to retrieve all conversations concerning a specific eBay listing * Pagination control is available * External messages and the [IncludeHighPriorityMessageOnly](/Devzone/XML/docs/Reference/eBay/GetMyMessages.html#Request.IncludeHighPriorityMessageOnly) boolean are not be carried over * Custom folder names are still available in eBay InBox, but will not have API support [getConversation](/api-docs/commerce/message/resources/conversation/methods/getConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * This method retrieves a specific conversation between the authenticated user and either eBay or another eBay user * The **conversation\_id** is passed in as a parth parameter [GetMemberMessages](/Devzone/XML/docs/Reference/eBay/GetMemberMessages.html) [getConversations](/api-docs/commerce/message/resources/conversation/methods/getConversations) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * [GetMemberMessages](/Devzone/XML/docs/Reference/eBay/GetMemberMessages.html) retrieves only message from other eBay members, so the [conversation\_type](/api-docs/commerce/message/resources/conversation/methods/getConversations#uri.conversation_type) query parameter value should be set to FROM\_EBAY * See additional notes for this method in the [GetMyMessages](/Devzone/XML/docs/Reference/eBay/GetMyMessages.html) row above [getConversation](/api-docs/commerce/message/resources/conversation/methods/getConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * See additional notes for this method in the [GetMyMessages](/Devzone/XML/docs/Reference/eBay/GetMyMessages.html) row above [ReviseMyMessages](/Devzone/XML/docs/Reference/eBay/ReviseMyMessages.html) [bulkUpdateConversation](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * This bulk method updates the status of all messages within multiple conversations (up to 10) * The [conversationType](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationType) field is required and specifies whether the conversations to update are from eBay or from other eBay members * The supported [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationStatus) values include ACTIVE, ARCHIVED, DELETED, READ, UNREAD * Only conversations can be acted upon and not specific folders or specific messages [updateConversation](/api-docs/commerce/message/resources/conversation/methods/updateConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * This method updates the status of all messages within one conversation * The [conversationId](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationId) and [conversation\_type](/api-docs/commerce/message/resources/conversation/methods/getConversations#uri.conversation_type) fields are both required, with the former identifying the conversation and the latter specifying whether the conversation to update is from eBay or from another eBay member * The supported [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationStatus) values include ACTIVE, ARCHIVE, and DELETE * The [read](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.read) boolean field is included and set to ‘true' to mark all messages within the conversation as read or ‘false' to mar all messages within the conversation as unread * Only conversations can be acted upon and not specific folders or specific messages [DeleteMyMessages](/Devzone/XML/docs/Reference/eBay/DeleteMyMessages.html) [bulkUpdateConversation](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * Set the [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationStatus) value to DELETE, and the conversations (up to 10) and all messages within each specified conversation will be deleted from the user's InBox * Conversations and all messages can also be archived instead of deleted by setting the [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationStatus) value to ARCHIVE * See additional notes for this method in the [ReviseMyMessages](/Devzone/XML/docs/Reference/eBay/ReviseMyMessages.html) row above [updateConversation](/api-docs/commerce/message/resources/conversation/methods/updateConversation) method of [Message API](/api-docs/commerce/message/resources/methods) **Key behaviors/changes**: * Set the [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationStatus) value to DELETE, and the conversation and all messages within the conversation will be deleted from the user's InBox * Conversations and all messages can also be archived instead of deleted by setting the [conversationStatus](/api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationStatus) value to ARCHIVE * See additional notes for this method in the [ReviseMyMessages](/Devzone/XML/docs/Reference/eBay/ReviseMyMessages.html) row above [ReviseMyMessagesFolders](/Devzone/XML/docs/Reference/eBay/ReviseMyMessagesFolders.html) **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](/devzone/xml/docs/Reference/eBay/index.html) will be the new REST-based [Feedback API](/api-docs/commerce/feedback/resources/methods). The following table has the modern API replacements and any relevant notes for each Feedback call: Traditional API(s) Modern API Replacement(s) [GetItemsAwaitingFeedback](/devzone/xml/docs/Reference/eBay/GetItemsAwaitingFeedback.html) [getItemsAwaitingFeedback](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes**: * The [filter](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback#uri.filter) query parameter allows a user to retrieve items awaiting feedback for a specific listing or from a specific order partner * The [filter](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback#uri.filter) query parameter also allows a user to set their **userRole** as SELLER or BUYER to only retrieve items awaiting feedback from either of those roles * Items can only be sorted by transaction/commitment time * A new [ratingTemplates](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback#response.lineItems.ratingTemplates) is returned to assist buyer in leaving detailed seller ratings for sellers [GetFeedback](/devzone/xml/docs/Reference/eBay/GetFeedback.html) (Retrieve user feedback entries) [getFeedback](/api-docs/commerce/feedback/resources/feedback/methods/getFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes:** * The user to retrieve feedback for is specified through the [user\_id](/api-docs/commerce/feedback/resources/feedback/methods/getFeedback#uri.user_id) query parameter * The [feedback\_type](/api-docs/commerce/feedback/resources/feedback/methods/getFeedback#uri.feedback_type) is also required and is set to either FEEDBACK\_RECEIVED or FEEDBACK\_SENT * The same request filters available through the traditional API are also available through the REST API * Additionally, the [filter](/api-docs/commerce/feedback/resources/feedback/methods/getFeedback#uri.filter) query parameter can be used to retrieve feedback based on certain topics, feedback with associated images, and automated feedback left by eBay * Pagination control supported [GetFeedback](/devzone/xml/docs/Reference/eBay/GetFeedback.html) (Retrieve user feedback metrics) [getFeedbackRatingSummary](/api-docs/commerce/feedback/resources/feedback_rating_summary/methods/getFeedbackRatingSummary) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes:** * The user to retrieve feedback metrics for is specified through the [user\_id](/api-docs/commerce/feedback/resources/feedback_rating_summary/methods/getFeedbackRatingSummary#uri.user_id) query parameter * Multiple filters and filter values are available through the [filter](/api-docs/commerce/feedback/resources/feedback_rating_summary/methods/getFeedbackRatingSummary#uri.filter) query parameter, but the **ratingType** filter must be used, and the supported rating types are defined in the [FeedbackRatingTypeEnum](/api-docs/commerce/feedback/types/fdb:FeedbackRatingTypeEnum) type * The response of this method will vary based on the **ratingType** that is used [LeaveFeedback](/devzone/xml/docs/Reference/eBay/LeaveFeedback.html) [leaveFeedback](/api-docs/commerce/feedback/resources/feedback/methods/leaveFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes:** * New method can associate up to five images with the feedback comment by passing in URL to images * Detailed seller ratings are provided through key-value pairs in the [sellerRatings](/api-docs/commerce/feedback/resources/feedback/methods/leaveFeedback#request.sellerRatings) array * When providing ratings in the [sellerRatings](/api-docs/commerce/feedback/resources/feedback/methods/leaveFeedback#request.sellerRatings) array, the [getItemsAwaitingFeedback](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback) method can be used to see the supported values for detailed seller ratings by looking at the [ratingTemplates](/api-docs/commerce/feedback/resources/awaiting_feedback/methods/getItemsAwaitingFeedback#response.lineItems.ratingTemplates) array in the response [RespondToFeedback](/devzone/xml/docs/Reference/eBay/RespondToFeedback.html) [respondToFeedback](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback) method of [Feedback API](/api-docs/commerce/feedback/resources/methods) **Key behaviors/changes:** * The [feedbackId](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback#request.feedbackId), [recipientUserId](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback#request.recipientUserId), [responseText](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback#request.responseText), and [responseType](/api-docs/commerce/feedback/resources/respond_to_feedback/methods/respondToFeedback#request.responseType) are all specified in the request and are required ##### 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](/devzone/merchandising/docs/CallRef/getMostWatchedItems.html) [getMostWatchedItems](/develop/api/buy/buy_marketing_api#buy-buy_marketing_api-most_watched_items-getmostwatcheditems) method of [Buy Marketing v1 API](/develop/api/buy/buy_marketing_api#api-buy_marketing_api) **Key behaviors/changes:** * The leaf category to discover Most Watched Items is specified through the [category\_id](/develop/api/buy/buy_marketing_api#buy-buy_marketing_api-most_watched_items-getmostwatcheditems-param-category_id) query parameter * By default, 20 of the Most Watched Items are returned in the response, but the [max\_results](/develop/api/buy/buy_marketing_api#buy-buy_marketing_api-most_watched_items-getmostwatcheditems-param-max_results) query parameter can be used to specify as little as one item or up to 50 items [getRelatedCategoryItems](/devzone/merchandising/docs/CallRef/getRelatedCategoryItems.html) **No replacement**; will not be migrated [getSimilarItems](/devzone/merchandising/docs/CallRef/getSimilarItems.html) [getSimilarItems](/develop/api/buy/buy_marketing_api#method-similar_items-getSimilarItems) method of [Buy Marketing v1 API](/develop/api/buy/buy_marketing_api#api-buy_marketing_api) **Key behaviors/changes:** * The listing to retrieve similar items for is specified through the [item\_id](/develop/api/buy/buy_marketing_api#buy-buy_marketing_api-similar_items-getsimilaritems-param-item_id) query parameter * The [buying\_option](/develop/api/buy/buy_marketing_api#buy-buy_marketing_api-similar_items-getsimilaritems-param-buying_option) query parameter may be used to retrieve similar items listed in a specific listing format * The [excluded\_category\_ids](/develop/api/buy/buy_marketing_api#buy-buy_marketing_api-similar_items-getsimilaritems-param-excluded_category_ids) query parameter may be used to exclude up to three eBay categories from the search * The [filter](/develop/api/buy/buy_marketing_api#buy-buy_marketing_api-similar_items-getsimilaritems-param-filter) query sets a date range filter according to listing end time * By default, 20 Similar Items are returned in the response, but the [max\_results](/develop/api/buy/buy_marketing_api#buy-buy_marketing_api-similar_items-getsimilaritems-param-max_results) query parameter can be used to specify as little as one item or up to 50 items [getVersion](/devzone/merchandising/docs/CallRef/getVersion.html) **No replacement**; will not be migrated ##### Marketplace Metadata APIs This section discussed metadata calls that have relevance for buying flows. These include [GetCategories](/devzone/xml/docs/Reference/eBay/GetCategories.html), eBay Catalog calls, and Parts Compatibility calls. For buyers using [GetCategories](/devzone/xml/docs/Reference/eBay/GetCategories.html), the REST API equivalent is the [getDefaultCategoryTreeId](/api-docs/buy/taxonomy/resources/category_tree/methods/getDefaultCategoryTreeId) [getCategoryTree](/api-docs/buy/taxonomy/resources/category_tree/methods/getCategoryTree) and [getCategorySubtree](/api-docs/buy/taxonomy/resources/category_tree/methods/getCategorySubtree) methods of [Taxonomy API](/api-docs/sell/taxonomy/resources/methods). See the [Retrieving eBay category information with Taxonomy API](/develop/guides-v2/marketplace-metadata/marketplace-metadata-guide#categoryinformation) use case for more information on getting started with the [Taxonomy API](/api-docs/sell/taxonomy/resources/methods). ###### eBay catalog calls Traditional API(s) Modern Replacement(s) [findProducts](/Devzone/Product/CallRef/findProducts.html) [search](/api-docs/sell/catalog/resources/product_summary/methods/search) method of [Catalog API](/api-docs/sell/catalog/resources/methods) [getProductDetails](/Devzone/Product/CallRef/getProductDetails.html) [getProduct](/api-docs/sell/catalog/resources/product/methods/getProduct) method of [Catalog API](/api-docs/sell/catalog/resources/methods). The eBay Product ID (ePID) is passed in as path parameter ###### Parts compatibility calls Traditional API(s) Modern Replacement(s) [getCompatibilitySearchNames](/Devzone/product-metadata/CallRef/getCompatibilitySearchNames.html) [getCompatibilityPropertyNames](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames) method of [Metadata API](/api-docs/sell/metadata/resources/methods) [getCompatibilitySearchValues](/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) [getCompatibilityPropertyValues](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues) method of [Metadata API](/api-docs/sell/metadata/resources/methods) [getCompatibilitySearchValuesBulk](/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) [getMultiCompatibilityPropertyValues](/api-docs/sell/metadata/resources/compatibilities/methods/getMultiCompatibilityPropertyValues) method of [Metadata API](/api-docs/sell/metadata/resources/methods) [getProductCompatibilities](/Devzone/Product/CallRef/getProductCompatibilities.html) [getProductCompatibilities](/api-docs/sell/metadata/resources/compatibilities/methods/getProductCompatibilities) method of [Metadata API](/api-docs/sell/metadata/resources/methods) [getCompatibilitySearchDataVersion](/Devzone/product-metadata/CallRef/getCompatibilitySearchDataVersion.html) No direct replacement, but both the [getCompatibilitySearchValues](/Devzone/product-metadata/CallRef/getCompatibilitySearchValues.html) and [getCompatibilitySearchValuesBulk](/Devzone/product-metadata/CallRef/getCompatibilitySearchValuesBulk.html) return a [metadataVersion](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyValues#response.metadataVersion) value in the response. * **Step-by-Step Flowchart**: Visual representation of the workflow. * **Process Description**: 1. Authenticate with the API (e.g., Obtain API Key). 2. Send a request (e.g., HTTP GET request for fetching data). 3. Handle the response (e.g., JSON parsing). 4. Implement action based on the response (e.g., store in a database, display on UI). ## Platform Notifications migration .custom-width { min-width: auto !important; width: 46em; } Platform Notification event types and the notification API calls in the [Trading API](/devzone/xml/docs/Reference/eBay/index.html) will be replaced by notification topics and the [Notification API](/api-docs/sell/notification/resources/methods). ##### Traditional and modern API mappings See the [Subscribing to and receiving notifications](/develop/guides-v2/communications/sell-communications-guide#retrievingeBaynotifications) topic for more information on using the [Notification API](/api-docs/sell/notification/resources/methods) 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](/devzone/xml/docs/Reference/eBay/GetNotificationPreferences.html) [getSubscriptions](/develop/api/sell/notification_api#sell-notification_api-subscription-getsubscriptions) method of [Notification API](/develop/api/sell/notification_api) Instead of event types, topics that the user is subscribed to are returned [SetNotificationPreferences](/devzone/xml/docs/Reference/eBay/SetNotificationPreferences.html) (Setting notification destination) [createDestination](/develop/api/sell/notification_api#sell-notification_api-destination-createdestination) and [updateDestination](/develop/api/sell/notification_api#sell-notification_api-destination-updatedestination) methods of the [Notification API](/develop/api/sell/notification_api) configure the endpoint that will receive notifications for topics that are subscribed to [SetNotificationPreferences](/devzone/xml/docs/Reference/eBay/SetNotificationPreferences.html) (Set/update alert email) [updateConfig](/develop/api/sell/notification_api#sell-notification_api-config-updateconfig) method of [Notification API](/develop/api/sell/notification_api) adds/modifies the alert email used and [getConfig](/develop/api/sell/notification_api#sell-notification_api-config-getconfig)method returns the current alert email [SetNotificationPreferences](/devzone/xml/docs/Reference/eBay/SetNotificationPreferences.html) (Managing subscriptions) The [createSubscription](/develop/api/sell/notification_api#sell-notification_api-subscription-createsubscription), [updateSubscription](/develop/api/sell/notification_api#sell-notification_api-subscription-updatesubscription), [deleteSubscription](/develop/api/sell/notification_api#sell-notification_api-subscription-deletesubscription), [disableSubscription](/develop/api/sell/notification_api#sell-notification_api-subscription-disablesubscription), and [enableSubscription](/develop/api/sell/notification_api#sell-notification_api-subscription-enablesubscription) methods of [Notification API](/develop/api/sell/notification_api) are used to subscribe to, update, disable, or enable topic subscriptions [GetNotificationsUsage](/devzone/xml/docs/Reference/eBay/GetNotificationsUsage.html) **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](#seller_events) * [Events for both sellers and buyers](#buyers_and_sellers) * [Buyer-based events](#buyer_events) ###### 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](/develop/api/sell/notification_events#sell-notification-events-communication-buyer_question) Seller receives this notification when a potential buyer/bidder asks question on an active listing BestOffer [OFFER\_ACTIVITY](/develop/api/sell/notification_events#sell-notification-events-offers-and-leads-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](/develop/api/sell/notification_events#sell-notification-events-account-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-listing-management-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](/develop/api/sell/notification_events#sell-notification-events-listing-management-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](/develop/api/sell/notification_events#sell-notification-events-listing-management-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](/develop/api/sell/notification_events#sell-notification-events-listing-management-listing) topic to see when a listing ends, and subscribe to the [ORDER\_CONFIRMATION](/develop/api/sell/notification_events#sell-notification-events-order-management-order_confirmation) topic to see when the item is paid for by the buyer, BuyerCancelRequested [ORDER\_CANCELLATION\_ACTIVITY](/develop/api/sell/notification_events#sell-notification-events-order-management-order_cancellation_activity), [ITEM\_COMMITMENT\_CANCELLATION\_ACTIVITY](/develop/api/sell/notification_events#sell-notification-events-order-management-item_commitment_cancellation_activity), and/or [PURCHASE\_QUOTE\_CANCELLATION\_ACTIVITY](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-account-management-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](/develop/api/sell/notification_events#sell-notification-events-offers-and-leads-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: * a seller will see BUYER\_COUNTER\_OFFER as the **OfferType** value and PENDING as the **OfferStatus** value. * a buyer will see SELLER\_COUNTER\_OFFER as the **OfferType** value and PENDING as the **OfferStatus** value. EndOfAuction [AUCTION\_ENDED](/develop/api/sell/notification_events#sell-notification-events-account-management-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](/develop/api/sell/notification_events#sell-notification-events-communication-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](/develop/api/sell/notification_events#sell-notification-events-communication-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](/develop/api/sell/notification_events#sell-notification-events-account-management-feedback_star_rating) This notification is sent to a seller or buyer when their feedback star rating has changed ItemMarkedShipped [ITEM\_MARKED\_SHIPPED](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-communication-new_message) topic should be subscribed to. MyMessageseBayMessage [NEW\_MESSAGE](/develop/api/sell/notification_events#sell-notification-events-communication-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](/develop/api/sell/notification_events#sell-notification-events-communication-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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.](/develop/api/sell/notification_events#sell-notification-events-account-management-authorization_revocation) EBPAppealedCase [ORDER\_INQUIRY\_ACTIVITY](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-order-management-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](/develop/api/sell/notification_events#sell-notification-events-offers-and-leads-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](/develop/api/sell/notification_events#sell-notification-events-offers-and-leads-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](/develop/api/sell/notification_events#sell-notification-events-account-management-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](/develop/api/sell/notification_events#sell-notification-events-account-management-watchlist_revision) `ITEM_WATCHED` is returned as the **WatchlistRevision** value and the listing is identified through the **itemId** field. ItemRemovedFromWatchList [WATCHLIST\_REVISION](/develop/api/sell/notification_events#sell-notification-events-account-management-watchlist_revision) `ITEM_UNWATCHED` is returned as the **WatchlistRevision** value and the listing is identified through the **itemId** field. ItemWon [AUCTION\_ACTIVITY](/develop/api/sell/notification_events#sell-notification-events-account-management-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](/develop/api/sell/notification_events#sell-notification-events-account-management-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 .custom-width { min-width: auto !important; width: 46em; } 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](/devzone/xml/docs/Reference/eBay/ConfirmIdentity.html) **None**; to be decommissioned This functionality is not needed as a part of OAuth [FetchToken](/devzone/xml/docs/Reference/eBay/FetchToken.html) **None**; to be decommissioned This functionality is not needed as a part of OAuth [GetSessionID](/devzone/xml/docs/Reference/eBay/GetSessionID.html) **None**; to be decommissioned This functionality is not needed as a part of OAuth [GetTokenStatus](/devzone/xml/docs/Reference/eBay/GetTokenStatus.html) The capability of this call will be migrated to OAuth tokens. More details to follow. [RevokeToken](/devzone/xml/docs/Reference/eBay/RevokeToken.html) 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 .custom-width { min-width: auto !important; width: 46em; } 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](/Devzone/XML/docs/Reference/eBay/index.html) 2025/06/02 GetCategoryMappings [getExpiredCategories](/api-docs/commerce/taxonomy/resources/category_tree/methods/getExpiredCategories) call of the [Taxonomy API.](/api-docs/commerce/taxonomy/resources/methods) 2025/07/28 ExtendSiteHostedPictures eBay no longer supports extending the life of unused EPS URLs beyond 30 days. 2026/02/02 GetVeROReportStatus [VeRO API](/api-docs/commerce/vero/resources/methods) 2026/02/02 GetVeROReasonCodeDetails [VeRO API](/api-docs/commerce/vero/resources/methods) 2026/02/02 VeROReportItems [VeRO API](/api-docs/commerce/vero/resources/methods) [Post-Order API](/Devzone/post-order/index.html) 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](/develop/api/sell/sell_return#method-Mutation-attachReturnShipmentLabel) 2026/01/20 Update Shipment Tracking Info [recordReturnLabelSentOffline](/develop/api/sell/sell_return#method-Mutation-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](/Devzone/product/CallRef/index.html) 2025/08/11 findCompatibilitiesBySpecification [getCompatibilitiesBySpecification](/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilitiesBySpecification)