eBay Resolution Case Management APIVersion 1.3.0

EBPCaseDetailType

This type defines the caseDetail container in the getEBPCaseDetail response. The caseDetail container provides detailed information on a single Item Not Received or Significantly Not As Described case.

Type that uses EBPCaseDetailType:

Call that uses EBPCaseDetailType:

Fields



agreedRefundAmount ( Amount (double) ) [0..1]
The monetary value of a partial or full refund if applicable for the case. This field is only returned if a partial or full refund is being issued to the buyer.
See the Field Index to learn which calls use agreedRefundAmount.

appeal ( AppealType ) [0..*]
Container consisting of case appeal details. This container is only returned if an appeal has been made on the case decision by the buyer or seller. Each appeal has a unique ID that is returned as an attribute. Until a decision is made on the appeal, only the creationDate child field is returned.
See the Field Index to learn which calls use appeal.

buyerReturnShipment ( ShipmentType ) [0..1]
This container is only returned if the buyer is returning the item to the seller as part of the solution to a Significantly Not As Described case. This container consists of the shipping carrier that the buyer will use, the status and expected date of the delivery, the shipping costs, the tracking number of the package(s), and the seller's shipping address.
See the Field Index to learn which calls use buyerReturnShipment.

caseDocumentInfo ( EBPCaseDocumentInfoType ) [0..*]
Container consisting of the name, type, and upload date of the proof document associated with the case. Only German (DE) sellers can upload proof documents using the uploadDocuments call, so this container will not be returned for US and UK sellers. One caseDocumentInfo container is returned for each proof document uploaded (maximum of 5).
See the Field Index to learn which calls use caseDocumentInfo.

decision ( CaseDecisionType ) [0..1]
The disposition (outcome) of the case. Some decisions favor the seller and some decisions favor the buyer. This field is only returned if a decision has been made on a case. See caseDetail.decisionReasonDetail for more details on the decision.
See the Field Index to learn which calls use decision.

decisionDate ( dateTime ) [0..1]
The timestamp for a decision made on a case. This field is only returned if a decision has been made on a case.
See the Field Index to learn which calls use decisionDate.

decisionReason ( token ) [0..1]
A code value that represents the decision that eBay customer support made on the case. It is only returned if a decision has been made on a case. THIS FIELD IS IN THE PROCESS OF BEING DEPRECATED. TO REFERENCE THE REASON FOR THE DECISION, VIEW THE decisionReasonDetail CONTAINER INSTEAD.
See the Field Index to learn which calls use decisionReason.

decisionReasonDetail ( DecisionReasonDetailType ) [0..1]
This container consists of the code value and description of the decision that eBay customer support made on the case. It is only returned if a decision has been made on a case. This field can be considered an alternative to decisionReason, which only returns a code value.
See the Field Index to learn which calls use decisionReasonDetail.

detailStatus ( token ) [0..1]
A code value that represents the current high-level status of a case. THIS FIELD IS IN THE PROCESS OF BEING DEPRECATED. TO REFERENCE THE CURRENT STATUS OF A CASE, VIEW THE detailStatusInfo CONTAINER INSTEAD.
See the Field Index to learn which calls use detailStatus.

detailStatusInfo ( DetailStatusInfoType ) [1]
This container consists of the code value and description of case status. This field can be considered an alternative to detailStatus, which only returns a code value.
See the Field Index to learn which calls use detailStatusInfo.

FVFCredited ( boolean ) [0..1]
Flag to indicate whether or not a Final Value Fee (FVF) was credited back to the seller's account as part of the case decision.
See the Field Index to learn which calls use FVFCredited.

globalId ( token ) [1]
The unique identifier for the eBay site where the buyer opened the eBay Buyer Protection case. See eBay Site ID to GlobalID for a list of eBay site IDs. This field should not be confused with the caseSummary.item.globalId value, which indicates the listing site of the item involved in the case.
See the Field Index to learn which calls use globalId.

initialBuyerExpectation ( token ) [0..1]
A code value that represents the buyer's initial expectation for resolving the case. THIS FIELD IS IN THE PROCESS OF BEING DEPRECATED. TO REFERENCE THE BUYER'S INITIAL EXPECTATION, VIEW THE initialBuyerExpectationDetail CONTAINER INSTEAD.
See the Field Index to learn which calls use initialBuyerExpectation.

initialBuyerExpectationDetail ( InitialBuyerExpectationDetailType ) [1]
This container consists of the code value and description what the buyer is expecting from the seller in order to resolve the case. This field can be considered an alternative to initialBuyerExpectation, which only returns a code value.
See the Field Index to learn which calls use initialBuyerExpectationDetail.

notCountedInBuyerProtectionCases ( boolean ) [0..1]
Flag that indicates whether or not a closed eBay Buyer Protection case will count against the seller's performance standards. A true value indicates that the case will not count against the seller's performance standards, and a false value indicates that the case will count against the seller's performance standards. This field is only returned if a decision has been made on a case.
See the Field Index to learn which calls use notCountedInBuyerProtectionCases.

openReason ( token ) [0..1]
A token value describing the reason for the case being opened. For Item Not Received cases, this value is always 'Item not received.'. Possible token values for Significantly Not As Described cases include 'Unknown', 'Fake', 'MissingPartsPieces', 'Wrong', 'Unusable', 'Other', 'EmptyBox', 'Damaged', 'Internal Damaged', 'External Damaged', or 'All'.
See the Field Index to learn which calls use openReason.

paymentDetail ( PaymentDetailType ) [0..1]
Container consisting of one or more money movement transactions that may occur between a buyer and seller (and eBay) during an open eBay Buyer Protection case. This container is only returned if a money movement transaction related to the case has occurred.
See the Field Index to learn which calls use paymentDetail.

responseHistory ( EBPCaseResponseHistoryType ) [0..*]
Container consisting of case activity details. A responseHistory node is returned for each activity that has occurred with the case, and each node contains the type of activity, the timestamp for the activity, the initiator of the activity, and any notes related to the case. Additionally, if the activity is related to a case appeal, a money movement transaction, or a hold put on a case, a caseDetail.responseHistory.attributes container is returned providing more information on these activities.
See the Field Index to learn which calls use responseHistory.

returnMerchandiseAuthorization ( string ) [0..1]
The Return Merchandize Authorization number is returned if the seller provided this number to the buyer (through provideRefundInfo or in the Resolution Center).
See the Field Index to learn which calls use returnMerchandiseAuthorization.

sellerShipment ( ShipmentType ) [1]
This container is only returned if the seller is shipping the original item, a replacement item, or missing/replacement parts to the buyer as a solution to an Item Not Received or Significantly Not As Described case. This container consists of the shipping carrier that the seller will use, the status and expected date of the delivery, the shipping costs, the tracking number of the package(s), and the buyer's shipping address.
See the Field Index to learn which calls use sellerShipment.