eBay Resolution Case Management API
|
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:
Index of Changed Calls - 1.3.0
Documentation Changes and Errata - 1.3.0
For a current list of known issues, see System Announcements and the Knowledge Base.
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.
| 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 |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
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.
This call allows the seller to issue a partial refund to the buyer for a Significantly Not As Described item.
This call allows the seller to offer a partial refund to the buyer for a Significantly Not As Described item.
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.
This call allows a German seller to provide a customized message to the buyer regarding an item refund.
This call allows a seller to provide an alternative shipping address to the buyer.
This call allows a seller to provide the shipping carrier and shipped date to the buyer.
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.
The Return Merchandise Authorization number for an item is returned in getEBPCaseDetail if provided to the buyer by the seller.
Any proof documents that are associated with the case are returned in getEBPCaseDetail. This feature is currently only applicable to the Germany site.
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.
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.
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.
Index of Changed Calls - 1.2.0
Documentation Changes and Errata - 1.2.0
For a current list of known issues, see System Announcements and the Knowledge Base.
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.
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 |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
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.
This call allows the seller to appeal a decision made on an eBay Buyer Protection Item Not Received or Significantly Not as Described case.
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.
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.
Sellers use this call to provide a full refund to the buyer.
This call allows the seller to offer an alternative solution to the buyer in order to settle the case.
Call used by the seller to provide new or verify existing tracking information for a package that is enroute to the buyer.
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
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.
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.
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.
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.
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.
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.
None for this release.
Index of Changed Calls - 1.1.0
Documentation Changes and Errata - 1.1.0
For a current list of known issues, see System Announcements and the Knowledge Base.
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.
No new calls in this release.
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 |
See the System Announcements for bug fixes related to this release. For documentation-related issues, see the Documentation System Announcements.
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.
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.
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.
The buyer's initial expectation upon filing the case is returned in the caseDetail.initialBuyerExpecation field of the getEBPCaseDetail request.
The high-level status of an eBay Buyer Protection case is returned in the caseDetail.detailStatus field of the getEBPCaseDetail request.
The caseDetail.notCountedInBuyerProtectionCases flag indicates whether or not a closed eBay Buyer Protection case will count against the seller's performance standards.
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.
If an eBay Buyer Protection case is on hold, the reason for the hold is returned in the caseDetail.responseHistory.attributes.onholdreason field.
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.
None for this release.
This is the first release of the eBay Resolution Case Management API.
For a current list of known issues, see System Announcements and the Knowledge Base.
These calls are included in the initial release of the eBay Resolution Case Management API.
© 2009–2011 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.