Return Management API Release Notes
Note: The Return Management API is no longer recommended. Instead, current users of the Return Management API should make plans to migrate to, and use the Return operations of the Post-Order API. New users interested is programmatically managing return requests, should also make plans to integrate with the Post-Order API. The Return Management API was developed to be used by sellers who had opted in to "Hassle-free Returns". Hassle-free Returns have been replaced by a new Returns Platform, where sellers fully or partially automate the processing of return requests through Return Automation Rules. The Return Management API does not support all features and logic of the new Returns Platform, and this API will be deprecated in the near future.
You can find links to the Return Management API documentation in the top navigation bar. Information about the schema location is in the Schema Location section of the "Making an API Call" topic.
The following describes how to join the eBay Developer Network:
The following links provide useful information for beginners:
- How to Join the eBay Developer Network
- eBay Developer Documentation Center
- eBay APIs - Quick Start
- eBay Trading API Guide
Version 1.1.0
Index of Changed Calls - 1.1.0
Documentation Changes and Errata - 1.1.0
For a current list of known issues, see Site Status Updates and the Knowledge Base.
Index of Changed Calls - 1.1.0
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
New Calls
Changed Calls
Schema Changes - 1.1.0
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
| Name | Part of Schema | Type of Change |
|---|---|---|
ProvideTrackingInfoRequest |
Complex type | New |
ProvideTrackingInfoResponse |
Complex type | New |
SetItemAsReceivedRequest |
Complex type | New |
SetItemAsReceivedResponse |
Complex type | New |
ReturnType |
Enumerated type | New |
TrackingStatusType |
Enumerated type | New |
ReturnDetailType.shipmentInfo |
Element | New |
ReturnSummaryType.ReturnType |
Element | New |
ActivityOptionType.SELLER_MARK_AS_RECEIVED |
Enum | New |
ActivityOptionType.SELLER_PRINT_SHIPPING_LABEL |
Enum | New |
ActivityOptionType.SELLER_PROVIDE_TRACKING_INFO |
Enum | New |
Announcements - 1.1.0
Change Requests
See the Site Status Updates for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
New Features - 1.1.0
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1.1.0.
Replacement Items Now Supported
In the eBay Return Center, the buyer has the option to request a refund for an item or to request a Replacement item. Due to the fact that there are now two options, the ReturnType enumerated type was added to distinguish between refunds and replacement items. For the Replacement Item option to be available to the buyer, the seller must enable "Money Back or Replacement" in the Return Policy at listing time.
Two New Calls Added to Support Replacement Items
Two new calls, provideTrackingInfo and setItemAsReceived, were added to support the Replacement item use case. The provideTrackingInfo call allows the seller to provide shipment tracking information to the buyer, and the setItemAsReceived call allows the seller to mark the replacement item as received.
Three New Activity Options Added to Support Replacement Items
Three new activity options may be returned in the activityOptions field of the getActivityOptions response. If the seller receives the 'SELLER_PROVIDE_TRACKING_INFO' activity option, the next logical step is to call provideTrackingInfo and provide shipment tracking information to the buyer for the replacement item. If the seller receives the 'SELLER_MARK_AS_RECEIVED' activity option, the next logical step is to call setItemAsReceived to mark the replacement item as received by the buyer. The 'SELLER_PRINT_SHIPPING_LABEL' activity option indicates that a shipping label is available for the seller to print out.
Changed Functionality - 1.1.0
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
shipmentInfo Container Replaces buyerReturnShipment Container
The buyerReturnShipment container has been replaced by the shipmentInfo container. The buyerReturnShipment container will no longer be returned in the getReturnDetail response. The shipmentInfo container essentially serves the same purpose as the buyerReturnShipment container except that the data in the shipmentInfo container can represent a buyer's return shipment or a seller replacement item shipment.
Documentation Changes and Errata - 1.1.0
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1.1.0 and Changed Functionality - 1.1.0.
None for this release.
Version 1.0.0
This is the first release of the Return Management API.
For a current list of known issues, see Site Status Updates and the Knowledge Base.
Index of Changed Calls - 1.0.0
These calls are included in the initial release of the Return Manaement API.
New Calls
- getActivityOptions
- getReturnDetail
- getReturnMetadata
- getUserReturns
- getVersion
- issueRefund
- provideSellerInfo