Resolution Case Management API Release Notes
You can find links to the Resolution Case 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.
Are you just getting started with the Resolutions API?
The following describes how to join the eBay Developers Program:
The following links provide useful information for beginners:
- How to Join the eBay Developer's Program
- eBay Developer Documentation Center
- eBay APIs - Quick Start
- eBay Trading API Guide
| Version | Release Date |
|---|---|
| 1.3.0 | 2011-05-27 |
| 1.2.0 | 2011-02-16 |
| 1.1.0 | 2010-12-08 |
| 1.0.0 | 2010-09-17 |
Version 1.3.0
Index of Changed Calls - 1.3.0
Documentation Changes and Errata - 1.3.0
For a current list of known issues, see API Status Updates and the Knowledge Base.
Index of Changed Calls - 1.3.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
- issuePartialRefund
- offerPartialRefund
- offerRefundUponReturn
- provideRefundInfo
- provideReturnInfo
- provideShippingInfo
- uploadDocuments
Changed Calls
Schema Changes - 1.3.0
| Writer | Name | Part of Schema | Type of Change |
|---|---|---|---|
EBPCaseDocumentInfoType |
Complex type | New | |
IssuePartialRefundRequest |
Complex type | New | |
IssuePartialRefundResponse |
Complex type | New | |
Money |
Complex type | New | |
OfferPartialRefundRequest |
Complex type | New | |
OfferPartialRefundResponse |
Complex type | New | |
OfferRefundUponReturnRequest |
Complex type | New | |
OfferRefundUponReturnResponse |
Complex type | New | |
ProvideRefundInfoRequest |
Complex type | New | |
ProvideRefundInfoResponse |
Complex type | New | |
ProvideReturnInfoRequest |
Complex type | New | |
ProvideReturnInfoResponse |
Complex type | New | |
ProvideShippingInfoRequest |
Complex type | New | |
ProvideShippingInfoResponse |
Complex type | New | |
UploadDocumentInfoType |
Complex type | New | |
UploadDocumentsRequest |
Complex type | New | |
UploadDocumentsResponse |
Complex type | New | |
IsoCurrencyCode |
Enumerated type | New | |
ProofType |
Enumerated type | New | |
EBPCaseDetailType.caseDocumentInfo |
Element | New | |
EBPCaseDetailType.returnMerchandiseAuthorization |
Element | New | |
ProvideShippingInfoOptionType.carrierUsed |
Element | New | |
ProvideShippingInfoOptionType.shippedDate |
Element | New |
Announcements - 1.3.0
Change Requests
See the API Status Updates for bug fixes related to this release.
New Features - 1.3.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.3.0.
issuePartialRefund Call Added
This call allows the seller to issue a partial refund to the buyer for a Significantly Not As Described item.
offerPartialRefund Call Added
This call allows the seller to offer a partial refund to the buyer for a Significantly Not As Described item.
offerRefundUponReturn Call Added
This call allows the seller to inform the buyer that the Significantly Not As Described item must be returned in order to receive a full refund.
provideRefundInfo Call Added
This call allows a German seller to provide a customized message to the buyer regarding an item refund.
provideReturnInfo Call Added
This call allows a seller to provide an alternative shipping address to the buyer.
provideShippingInfo Call Added
This call allows a seller to provide the shipping carrier and shipped date to the buyer.
uploadDocuments Call Added
This call allows a German seller to upload one to five documents that serve as proof of shipping or proof of a refund to buyer.
Return Merchandise Authorization Number Returned in getEBPCaseDetail
The Return Merchandise Authorization number for an item is returned in getEBPCaseDetail if provided to the buyer by the seller.
Information on Proof Documents Returned in getEBPCaseDetail
Any proof documents that are associated with the case are returned in getEBPCaseDetail. This feature is currently only applicable to the Germany site.
Changed Functionality - 1.3.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.
None for this release.
Documentation Changes and Errata - 1.3.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.3.0 and Changed Functionality - 1.3.0.
Enabling eBay Buyer Protection Platform Notifications
Added note to Platform Notifications for eBay Buyer Protection Cases section in User Guide stating that you must pass in 'eBP notification' in the UserData.ExternalUserData input field of the SetNotificationPreferences Trading API call to enable and receive eBay Buyer Protection platform notifications.
Version 1.2.0
Index of Changed Calls - 1.2.0
Documentation Changes and Errata - 1.2.0
For a current list of known issues, see API Status Updates and the Knowledge Base.
Index of Changed Calls - 1.2.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
- appealToCustomerSupport
- escalateToCustomerSupport
- getActivityOptions
- issueFullRefund
- offerOtherSolution
- provideTrackingInfo
Changed Calls
Schema Changes - 1.2.0
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
| Name | Part of Schema | Type of Change |
|---|---|---|
ActivityDetailType |
Complex type | New |
ActivityOptionListType |
Complex type | New |
AppealToCustomerSupportOptionType |
Complex type | New |
AppealToCustomerSupportRequest |
Complex type | New |
AppealToCustomerSupportResponse |
Complex type | New |
BaseActivityOptionType |
Complex type | New |
ContactCustomerSupportOptionType |
Complex type | New |
DecisionReasonDetailType |
Complex type | New |
DetailStatusInfoType |
Complex type | New |
EnumerationDetailType |
Complex type | New |
EscalateToCustomerSupportOptionType |
Complex type | New |
EscalateToCustomerSupportRequest |
Complex type | New |
EscalateToCustomerSupportResponse |
Complex type | New |
EscalationReasonType |
Complex type | New |
GetActivityOptionsRequest |
Complex type | New |
GetActivityOptionsResponse |
Complex type | New |
InitialBuyerExpectationDetailType |
Complex type | New |
IssueFullRefundOptionType |
Complex type | New |
IssueFullRefundRequest |
Complex type | New |
IssueFullRefundResponse |
Complex type | New |
IssuePartialRefundOptionType |
Complex type | New |
OfferOtherSolutionOptionType |
Complex type | New |
OfferOtherSolutionRequest |
Complex type | New |
OfferOtherSolutionResponse |
Complex type | New |
OnHoldReasonDetailType |
Complex type | New |
ProvideRefundInfoOptionType |
Complex type | New |
ProvideShippingInfoOptionType |
Complex type | New |
ProvideShippingOrTrackingInfoOptionType |
Complex type | New |
ProvideTrackingInfoOptionType |
Complex type | New |
ProvideTrackingInfoRequest |
Complex type | New |
ProvideTrackingInfoResponse |
Complex type | New |
RequestBuyerToReturnOptionType |
Complex type | New |
AppealReasonType |
Enumerated type | New |
BuyerINREscalationReasonType |
Enumerated type | New |
BuyerSNADEscalationReasonType |
Enumerated type | New |
RefundStatusType |
Enumerated type | New |
SellerINREscalationReasonType |
Enumerated type | New |
SellerSNADEscalationReasonType |
Enumerated type | New |
AppealType.decisionReasonDetail |
Element | New |
EBPCaseDetailType.decisionReasonDetail |
Element | New |
EBPCaseDetailType.detailStatusInfo |
Element | New |
EBPCaseDetailType.initialBuyerExpectationDetail |
Element | New |
EBPCaseResponseHistoryType.activityDetail |
Element | New |
NotificationEventNameType.EBPOnHoldCase |
Enum | New |
Announcements - 1.2.0
See the API Status Updates for bug fixes related to this release.
New Features - 1.2.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.2.0.
appealToCustomerSupport Call Added
This call allows the seller to appeal a decision made on an eBay Buyer Protection Item Not Received or Significantly Not as Described case.
escalateToCustomerSupport Call Added
This call allows the seller to escalate an open eBay Buyer Protection Item Not Received or Significantly Not as Described case to eBay customer support.
getActivityOptions Call Added
A seller can use this call to return one or more possible actions that can be performed on an eBay Buyer Protection Item Not Received or Significantly Not as Described case.
issueFullRefund Call Added
Sellers use this call to provide a full refund to the buyer.
offerOtherSolution Call Added
This call allows the seller to offer an alternative solution to the buyer in order to settle the case.
provideTrackingInfo Call Added
Call used by the seller to provide new or verify existing tracking information for a package that is enroute to the buyer.
New EBPCaseOnHold Platform Notification
The EBPCaseOnHold notification is sent to the subscriber when a case has placed on hold. For more information on eBay Buyer Protection platform notifications, see eBay Buyer Protection Notifications
Changed Functionality - 1.2.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.
Description of Case and Appeal Decisions Returned in getEBPCaseDetail
The decisionReasonDetail container is now returned in the getEBPCaseDetail response after a decision has been made on a case or an appeal. The decisionReasonDetail container includes a code value and a description of the decision reason. The decisionReasonDetail container can be considered an alternative to decisionReason, which only returns a code value.
Description of Case Status Returned in getEBPCaseDetail
The detailStatusInfo container is now returned in the getEBPCaseDetail response. The detailStatusInfo container includes a code value and a description of the case status. The detailStatusInfo container can be considered an alternative to detailStatus, which only returns a code value.
Description of Initial Buyer Expectation Returned in getEBPCaseDetail
The initialBuyerExpectationDetail container is now returned in the getEBPCaseDetail response. The initialBuyerExpectationDetail container includes a code value and a description of the initial buyer expectation. The initialBuyerExpectationDetail container can be considered an alternative to initialBuyerExpectation, which only returns a code value.
Description of Case Activity Returned in getEBPCaseDetail
The activityDetail container is now returned in the getEBPCaseDetail response. The activityDetail container includes a code value and a description of the case activity. The activityDetail container can be considered an alternative to caseDetail.responseHistory.activity, which only returns a code value.
Description of On Hold Reason Returned in getEBPCaseDetail
The onholdReasonDetail container is now returned in the getEBPCaseDetail response if a case is put on hold. The onholdReasonDetail container includes a code value and a description of the on hold reason. The onholdReasonDetail container can be considered an alternative to onholdReason, which only returns a code value.
Documentation Changes and Errata - 1.2.0
None for this release.
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 API 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
No new calls in this release.
Changed Calls
Schema Changes - 1.1.0
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
| Name | Part of Schema | Type of Change |
|---|---|---|
ResponseHistoryAttributesType |
Complex type | New |
EBPCaseDetailType.detailStatus |
Element | New |
EBPCaseDetailType.initialBuyerExpectation |
Element | New |
EBPCaseResponseHistoryType.attributes |
Element | New |
AppealType[id] |
Attribute | New |
Announcements - 1.1.0
See the API Status Updates for bug fixes related to this release.
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.
Reason for Case Decision is Returned Upon Case Closure
Once a decision has been made on an eBay Buyer Protection case, the reason for the decision is returned in the caseDetail.decisionReason field of the getEBPCaseDetail request.
Reason for Appeal Decision is Returned
Once a decision has been made on an appeal to an eBay Buyer Protection case, the reason for the decision is returned in the caseDetail.appeal.decisionReason field of the getEBPCaseDetail request.
Initial Buyer Expectation is Returned in getEBPCaseDetail
The buyer's initial expectation upon filing the case is returned in the caseDetail.initialBuyerExpecation field of the getEBPCaseDetail request.
Current Status of Case is Returned in getEBPCaseDetail
The high-level status of an eBay Buyer Protection case is returned in the caseDetail.detailStatus field of the getEBPCaseDetail request.
New Flag to Indicate if a Case Decision Affects Seller's Performance
The caseDetail.notCountedInBuyerProtectionCases flag indicates whether or not a closed eBay Buyer Protection case will count against the seller's performance standards.
Case Activities Linked to Appeals and Money Movement Transactions
If a case activity returned in caseDetail.responseHistory is associated with an appeal and/or a money movement transaction, the caseDetail.responseHistory.attributes.appealRef and caseDetail.responseHistory.attributes.moneyMovementRef fields are returned, respectively. These fields will contain an idref attribute that will match the the ID value in the caseDetail.appeal and caseDetail.paymentDetail.moneyMovement fields, respectively.
Reason for Case Being on Hold Returned in getEBPCaseDetail
If an eBay Buyer Protection case is on hold, the reason for the hold is returned in the caseDetail.responseHistory.attributes.onholdreason field.
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.
None for this release.
Documentation Changes and Errata - 1.1.0
None for this release.
Version 1.0.0
This is the first release of the eBay Resolution Case Management API.
For a current list of known issues, see API Status Updates and the Knowledge Base.
Index of Changed Calls - 1.0.0
These calls are included in the initial release of the eBay Resolution Case Management API.