eBay Resolution Case Management APIVersion 1.3.0

getEBPCaseDetail



Note: The Resolution Case Management API is no longer recommended. Instead, current users of the Resolution Case Management API should make plans to migrate to, and use the Return, Inquiry, and Case Management operations of the Post-Order API. New users interested is programmatically managing and resolving Item Not Received (INR) and Return/SNAD (Significantly Not as Described) cases, should also make plans to integrate with the Post-Order API. Since the Resolution Case Management API was first released, there have been many changes made to post-order flows, and Resolution Case Management API does not support all features and logic of the new flows. This API will be deprecated in the near future.

This call returns detailed information for a specific case opened by a buyer in the eBay Resolution Center. This call is restricted to sellers.

Note: Users of this call should start using the GET /post-order/v2/casemanagement/{caseId} call of the Post-Order API instead.

Request Details

If you know the caseID of a specific eBay Buyer Protection case, you can use getEBPCaseDetail to retrieve detailed information for that case. In addition to the caseID, you must specify the case type. If the caseId.id and caseId.type values don't match, the request is processed (if caseId.id is valid) but a warning message is returned.

If not already known, the case ID for an eBay Buyer Protection case can be retrieved with a call to getUserCases. If you make this call, specify EBP_INR, EBP_SNAD, and/or RETURN (UK and DE only) as case type filters to restrict results to eBay Buyer Protection cases.

Working with the Response

The two containers returned at the root level of the getEBPCaseDetail response are caseSummary and caseDetail.

The caseSummary container consists of the following information:

The caseDetail container consists of the following information:

Case Decisions and Appeals

If the eBay Buyer Protection case has been decided, the decision, decisionDate, and decisionReasonDetail fields are returned under the caseDetail container in the response. decisionReasonDetail is actually a container that includes an ID (decisionReasonDetail.code) and description for the decision reason. Note that the decisionReason field is returned but not used, as it was replaced by decisionReasonDetail.

If an appeal on the eBay Buyer Protection case has been initiated, the appeal field is returned under the caseDetail container in the response. If a decision on the appeal has been made, the decisionReasonDetail container is returned under the appeal container. Note that the decisionReason field is returned but not used, as it was replaced by decisionReasonDetail.

Money Movement and Balance Due

A moneyMovement node is returned under the paymentDetail container for each money movement transaction related to the case. Each moneyMovement node contains the type of money movement, the two parties involved, the transaction date, the monetary amount of the transaction, the payment method, and the status of the transaction. For PayPal transactions, the PayPal transaction ID is also included in the node. An id string attribute is always returned in each moneyMovement element. A parentId string attribute is returned if the transaction is a reversal. Money movement types include the following:

The paymentDetail.balanceDue field indicates the balance due to the applicable party (eBay, buyer, or seller), and is always returned. The "applicable party" and the amount can change based on the latest money movement transaction.



Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getEBPCaseDetailRequest xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- Call-specific Input Fields -->
  <caseId> CaseIdType
    <id> string </id>
    <type> CaseType </type>
  </caseId>
</getEBPCaseDetailRequest>
Argument Type Occurrence Meaning
caseId CaseIdType Required This container is used to identify a specific Item Not Received or Significantly Not As Described case opened by a buyer in the eBay Resolution Center.
caseId.id string Required Unique identifier of the case. The caseId.id values are returned in the caseSummary container in the getUserCases and getEBPCaseDetail calls.
Max length: 38.
caseId.type CaseType Required eBay case type. Case types include eBay Buyer Protection and PayPal Buyer Protection cases (opened through the Resolution Center), older disputes created through other sites, and Unpaid Item or Cancel Transaction disputes created through the Resolution Center or with the AddDispute call of the Trading API. For all Resolution Case Management calls except getUserCases, only EBP_INR and EBP_SNAD are applicable caseType values.

Applicable values:

EBP_INR
An Item Not Received case opened by a buyer in the Resolution Center.
EBP_SNAD
A Significantly Not As Described case opened by a buyer in the Resolution Center.

(Not all values in CaseType apply to this field.)



Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getEBPCaseDetailResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- Call-specific Output Fields -->
  <caseDetail> EBPCaseDetailType
    <agreedRefundAmount> Amount (double) </agreedRefundAmount>
    <appeal id="string"> AppealType
      <decision> AppealDecisionType </decision>
      <decisionReasonDetail> DecisionReasonDetailType (EnumerationDetailType)
        <code> token </code>
        <content> token </content>
        <description> token </description>
      </decisionReasonDetail>
    </appeal>
    <!-- ... more appeal nodes allowed here ... -->
    <buyerReturnShipment> ShipmentType
      <carrierUsed> string </carrierUsed>
      <deliveryDate> dateTime </deliveryDate>
      <deliveryStatus> token </deliveryStatus>
      <shippingAddress> Address
        <city> string </city>
        <country> string </country>
        <name> string </name>
        <postalCode> string </postalCode>
        <stateOrProvince> string </stateOrProvince>
        <street1> string </street1>
        <street2> string </street2>
      </shippingAddress>
      <shippingCost> Amount (double) </shippingCost>
      <trackingNumber> string </trackingNumber>
    </buyerReturnShipment>
    <caseDocumentInfo> EBPCaseDocumentInfoType
      <name> string </name>
      <type> ProofType </type>
      <uploadDate> dateTime </uploadDate>
    </caseDocumentInfo>
    <!-- ... more caseDocumentInfo nodes allowed here ... -->
    <decision> CaseDecisionType </decision>
    <decisionDate> dateTime </decisionDate>
    <decisionReason> token </decisionReason>
    <decisionReasonDetail> DecisionReasonDetailType (EnumerationDetailType)
      <code> token </code>
      <content> token </content>
      <description> token </description>
    </decisionReasonDetail>
    <detailStatus> token </detailStatus>
    <detailStatusInfo> DetailStatusInfoType (EnumerationDetailType)
      <code> token </code>
      <content> token </content>
      <description> token </description>
    </detailStatusInfo>
    <FVFCredited> boolean </FVFCredited>
    <globalId> token </globalId>
    <initialBuyerExpectation> token </initialBuyerExpectation>
    <initialBuyerExpectationDetail> InitialBuyerExpectationDetailType (EnumerationDetailType)
      <code> token </code>
      <content> token </content>
      <description> token </description>
    </initialBuyerExpectationDetail>
    <notCountedInBuyerProtectionCases> boolean </notCountedInBuyerProtectionCases>
    <openReason> token </openReason>
    <paymentDetail> PaymentDetailType
      <balanceDue> Amount (double) </balanceDue>
      <moneyMovement id="string" parentId="string"> MoneyMovementDetailType
        <amount> Amount (double) </amount>
        <fromParty> CaseUserType
          <role> CaseUserRoleType </role>
          <userId> string </userId>
        </fromParty>
        <paymentMethod> PaymentMethodType </paymentMethod>
        <paypalTransactionId> string </paypalTransactionId>
        <status> MoneyMovementStatusType </status>
        <toParty> CaseUserType
          <role> CaseUserRoleType </role>
          <userId> string </userId>
        </toParty>
        <transactionDate> dateTime </transactionDate>
        <type> MoneyMovementType </type>
      </moneyMovement>
      <!-- ... more moneyMovement nodes allowed here ... -->
    </paymentDetail>
    <responseHistory> EBPCaseResponseHistoryType
      <activity> token </activity>
      <activityDetail> ActivityDetailType (EnumerationDetailType)
        <code> token </code>
        <content> token </content>
        <description> token </description>
      </activityDetail>
      <attributes> ResponseHistoryAttributesType
        <appealRef> ~appealRef </appealRef>
        <moneyMovementRef> ~moneyMovementRef </moneyMovementRef>
        <onholdReason> token </onholdReason>
        <onholdReasonDetail> OnHoldReasonDetailType (EnumerationDetailType)
          <code> token </code>
          <content> token </content>
          <description> token </description>
        </onholdReasonDetail>
      </attributes>
      <author> CaseUserType
        <role> CaseUserRoleType </role>
        <userId> string </userId>
      </author>
      <creationDate> dateTime </creationDate>
      <note> string </note>
    </responseHistory>
    <!-- ... more responseHistory nodes allowed here ... -->
    <returnMerchandiseAuthorization> string </returnMerchandiseAuthorization>
    <sellerShipment> ShipmentType
      <carrierUsed> string </carrierUsed>
      <deliveryDate> dateTime </deliveryDate>
      <deliveryStatus> token </deliveryStatus>
      <shippingAddress> Address
        <city> string </city>
        <country> string </country>
        <name> string </name>
        <postalCode> string </postalCode>
        <stateOrProvince> string </stateOrProvince>
        <street1> string </street1>
        <street2> string </street2>
      </shippingAddress>
      <shippingCost> Amount (double) </shippingCost>
      <trackingNumber> string </trackingNumber>
    </sellerShipment>
  </caseDetail>
  <caseSummary> CaseSummaryType
    <caseAmount> Amount (double) </caseAmount>
    <caseId> CaseIdType
      <id> string </id>
      <type> CaseType </type>
    </caseId>
    <caseQuantity> int </caseQuantity>
    <creationDate> dateTime </creationDate>
    <item> ItemType
      <globalId> token </globalId>
      <itemId> string </itemId>
      <itemTitle> string </itemTitle>
      <transactionDate> dateTime </transactionDate>
      <transactionId> string </transactionId>
      <transactionPrice> Amount (double) </transactionPrice>
    </item>
    <lastModifiedDate> dateTime </lastModifiedDate>
    <otherParty> CaseUserType
      <role> CaseUserRoleType </role>
      <userId> string </userId>
    </otherParty>
    <respondByDate> dateTime </respondByDate>
    <status> CaseStatusType
      <EBPINRStatus> EBPINRCaseStatusType </EBPINRStatus>
      <EBPSNADStatus> EBPSNADCaseStatusType </EBPSNADStatus>
    </status>
    <user> CaseUserType
      <role> CaseUserRoleType </role>
      <userId> string </userId>
    </user>
  </caseSummary>
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</getEBPCaseDetailResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
caseDetail EBPCaseDetailType Always Container consisting of detailed information for the eBay Buyer Protection Item Not Received or Significantly Not As Described case, including information on case decisions, appeal decisions, all activities logged in the case, and payment details.
caseDetail.agreedRefundAmount Amount (double) Conditionally 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.
caseDetail.appeal AppealType Conditionally,
repeatable: [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.
caseDetail.appeal
  [ attribute id ]
string Conditionally 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.
caseDetail.appeal.decision AppealDecisionType Conditionally The disposition (outcome) of the case appeal. The initiator of the appeal (buyer or seller) can either win the appeal, be denied the appeal, or earn partial credit through the appeal. This field is only returned if a decision has been made on a case. See caseDetail.appeal.decisionReasonDetail for more details on the appeal decision.

Applicable values: See decision.
caseDetail.appeal
  .decisionReasonDetail
DecisionReasonDetailType (EnumerationDetailType) Conditionally This container consists of the code value and description of the decision that eBay customer support made on the case appeal. It is only returned if a decision has been made on the appeal. This field can be considered an alternative to decisionReason, which only returns a code value.
caseDetail.appeal
  .decisionReasonDetail.code
token Always Unique identifier of the enumeration value.
caseDetail.appeal
  .decisionReasonDetail.content
token Always For future use.
caseDetail.appeal
  .decisionReasonDetail
  .description
token Always A description of the enumeration value.
caseDetail.buyerReturnShipment ShipmentType Conditionally 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.
caseDetail.buyerReturnShipment
  .carrierUsed
string Conditionally The shipping carrier being used by the buyer or seller to ship the package.
caseDetail.buyerReturnShipment
  .deliveryDate
dateTime Conditionally The expected date of delivery from the buyer (buyerReturnShipment) or the seller (sellerShipment).
caseDetail.buyerReturnShipment
  .deliveryStatus
token Conditionally The status of the delivery from the buyer (buyerReturnShipment) or the seller (sellerShipment).
caseDetail.buyerReturnShipment
  .shippingAddress
Address Conditionally The container for the shipping address for the buyer or seller. If the buyer is returning an item, this address is the seller's shipping address. If the seller is shipping an item, this address is the buyer's shipping address.
caseDetail.buyerReturnShipment
  .shippingAddress.city
string Conditionally The city listed for the eBay user's shipping address.
caseDetail.buyerReturnShipment
  .shippingAddress.country
string Conditionally The country listed for the eBay user's shipping address.
caseDetail.buyerReturnShipment
  .shippingAddress.name
string Conditionally The name listed for the eBay user's shipping address.
caseDetail.buyerReturnShipment
  .shippingAddress.postalCode
string Conditionally The postal code listed for the eBay user's shipping address.
caseDetail.buyerReturnShipment
  .shippingAddress
  .stateOrProvince
string Conditionally The state or province listed for the eBay user's shipping address.
caseDetail.buyerReturnShipment
  .shippingAddress.street1
string Conditionally The first line of the street listed for the eBay user's shipping address.
caseDetail.buyerReturnShipment
  .shippingAddress.street2
string Conditionally The second line of the street listed for the eBay user's shipping address. Based on the eBay user's shipping address, this field may be returned empty.
caseDetail.buyerReturnShipment
  .shippingCost
Amount (double) Conditionally The total shipping costs for the buyer (buyerReturnShipment) or the seller (sellerShipment).
caseDetail.buyerReturnShipment
  .trackingNumber
string Conditionally The shipment tracking number. eBay checks to verify that the tracking number is consistent with the numbering scheme used by the specified shipping carrier, but eBay cannot verify that the tracking number is accurate. Accuracy is the responsibility of the party shipping the package.
caseDetail.caseDocumentInfo EBPCaseDocumentInfoType Conditionally,
repeatable: [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).
caseDetail.caseDocumentInfo
  .name
string Conditionally The file name of the proof document. The file name must be unique for each proof document "attached" to the case.
caseDetail.caseDocumentInfo
  .type
ProofType Conditionally This field indicates the proof document's type. 'OTHER' is currently not supported.

Applicable values:

OTHER
The proof document type is reserved for future use.
PROOF_OF_REFUND
This document is uploaded by the seller to provide proof that a full or partial refund has been issued to the buyer. Supported file types for this document are JPEG, GIF, BMP, and PNG. The size limit for each document is 1 MB.
PROOF_OF_SHIPPING
This document is uploaded by the seller to provide proof that an item was shipped to the buyer. Supported file types for this document are JPEG, GIF, BMP, and PNG. The size limit for each document is 1 MB.

caseDetail.caseDocumentInfo
  .uploadDate
dateTime Conditionally Timestamp indicating the date and time that the document was uploaded. This value is automatically generated by eBay.
caseDetail.decision CaseDecisionType Conditionally 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.

Applicable values:

BUYER_FAULT
The buyer was found to be at fault in the final disposition of the case.
BUYER_FAULT_SELLER_FAULT
The buyer and seller were both found to be at fault in the final disposition of the case.
NEITHER_SELLER_NOR_BUYER_FAULT
Neither the seller nor the buyer was found to be at fault in the final disposition of the case.
OTHER
The final disposition of the case was classifed as 'Other'.
SELLER_FAULT
The seller was found to be at fault in the final disposition of the case.

caseDetail.decisionDate dateTime Conditionally The timestamp for a decision made on a case. This field is only returned if a decision has been made on a case.
caseDetail.decisionReason token Conditionally 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.
caseDetail
  .decisionReasonDetail
DecisionReasonDetailType (EnumerationDetailType) Conditionally 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.
caseDetail
  .decisionReasonDetail.code
token Always Unique identifier of the enumeration value.
caseDetail
  .decisionReasonDetail.content
token Always For future use.
caseDetail
  .decisionReasonDetail
  .description
token Always A description of the enumeration value.
caseDetail.detailStatus token Always 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.
caseDetail.detailStatusInfo DetailStatusInfoType (EnumerationDetailType) Always 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.
caseDetail.detailStatusInfo
  .code
token Always Unique identifier of the enumeration value.
caseDetail.detailStatusInfo
  .content
token Always For future use.
caseDetail.detailStatusInfo
  .description
token Always A description of the enumeration value.
caseDetail.FVFCredited boolean Conditionally 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.
caseDetail.globalId token Always 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.
caseDetail
  .initialBuyerExpectation
token Always 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.
caseDetail
  .initialBuyerExpectationDetail
InitialBuyerExpectationDetailType (EnumerationDetailType) Always 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.
caseDetail
  .initialBuyerExpectationDetail
  .code
token Always Unique identifier of the enumeration value.
caseDetail
  .initialBuyerExpectationDetail
  .content
token Always For future use.
caseDetail
  .initialBuyerExpectationDetail
  .description
token Always A description of the enumeration value.
caseDetail
  .notCountedInBuyerProtectionCases
boolean Conditionally 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.
caseDetail.openReason token Conditionally 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'.
caseDetail.paymentDetail PaymentDetailType Conditionally 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.
caseDetail.paymentDetail
  .balanceDue
Amount (double) Conditionally The current balance due from the seller to the buyer or to eBay. If no balance is due from the seller, it is returned as 0.00.
caseDetail.paymentDetail
  .moneyMovement
MoneyMovementDetailType Conditionally,
repeatable: [0..*]
Container consisting of the details of a money movement transaction. There can be more than one moneyMovement node returned in the getEBPCaseDetail response. Details in each moneyMovement node include the transaction type, the amount, the payer and payee, the date, the payment method, and the PayPal transaction ID (if the payment method is PayPal).
caseDetail.paymentDetail
  .moneyMovement
  [ attribute id ]
string Always Container consisting of the details of a money movement transaction. There can be more than one moneyMovement node returned in the getEBPCaseDetail response. Details in each moneyMovement node include the transaction type, the amount, the payer and payee, the date, the payment method, and the PayPal transaction ID (if the payment method is PayPal).
caseDetail.paymentDetail
  .moneyMovement
  [ attribute parentId ]
string Conditionally Container consisting of the details of a money movement transaction. There can be more than one moneyMovement node returned in the getEBPCaseDetail response. Details in each moneyMovement node include the transaction type, the amount, the payer and payee, the date, the payment method, and the PayPal transaction ID (if the payment method is PayPal).
caseDetail.paymentDetail
  .moneyMovement.amount
Amount (double) Conditionally The amount of the money movement transaction.
caseDetail.paymentDetail
  .moneyMovement.fromParty
CaseUserType Always Container that identifies the user who is the originator (or source) of the money movement transaction. The user is identified by case role (buyer, seller, or eBay) and eBay user ID.
caseDetail.paymentDetail
  .moneyMovement.fromParty.role
CaseUserRoleType Always The user's role in the eBay Buyer Protection case.

Applicable values:

BUYER
The user's role in the case is buyer.
EBAY
A representative of eBay involved in mediating the case.
OTHER
The user's role in the case is classified as 'other'.
SELLER
The user's role in the case is seller.

caseDetail.paymentDetail
  .moneyMovement.fromParty
  .userId
string Conditionally The eBay user ID for the user involved in the case.
caseDetail.paymentDetail
  .moneyMovement.paymentMethod
PaymentMethodType Conditionally The payment method used for the money movement transaction.

Applicable values:

CREDIT_CARD
A credit card is the selected payment method for the money movement transaction.
DIRECT_DEBIT
Direct debit is the selected payment method for the money movement transaction.
OTHER
The selected payment method for the money movement transaction is classified as "other".
PAYPAL
PayPal is the selected payment method for the money movement transaction. If PayPal is the selected payment method, the paypalTransactionId field will be returned after completion of the money movement transaction.

caseDetail.paymentDetail
  .moneyMovement
  .paypalTransactionId
string Conditionally The PayPal Transaction ID. This element is only applicable if PayPal was used as the payment method.
caseDetail.paymentDetail
  .moneyMovement.status
MoneyMovementStatusType Always The status of the money movement transaction.

Applicable values:

CANCELLED
Indicates a cancelled money movement transaction.
COMPLETED
Indicates a successful money movement transaction. If COMPLETED is returned, additional money movement transactions are expected.
SUCCESS
Indicates a successful money movement transaction. If SUCCESS is returned, no additional money movement transactions are expected.

caseDetail.paymentDetail
  .moneyMovement.toParty
CaseUserType Always Container that identifies the user who is the receiver (or destination) of the money movement transaction. The user is identified by case role (buyer, seller, or eBay) and eBay user ID.
caseDetail.paymentDetail
  .moneyMovement.toParty.role
CaseUserRoleType Always The user's role in the eBay Buyer Protection case.

Applicable values:

BUYER
The user's role in the case is buyer.
EBAY
A representative of eBay involved in mediating the case.
OTHER
The user's role in the case is classified as 'other'.
SELLER
The user's role in the case is seller.

caseDetail.paymentDetail
  .moneyMovement.toParty.userId
string Conditionally The eBay user ID for the user involved in the case.
caseDetail.paymentDetail
  .moneyMovement.transactionDate
dateTime Always The date of the money movement transaction.
caseDetail.paymentDetail
  .moneyMovement.type
MoneyMovementType Always The type of money movement transaction.

Applicable values:

OTHER
A money movement transaction classified as "other".
PAYOUT
A refund to the seller or buyer.
REFUND
A refund against a specific money movement transaction to the seller or buyer.
REIMBURSEMENT
A charge against the seller.
REVERSAL
A reversal against a refund, payout, or reimbursement.

caseDetail.responseHistory EBPCaseResponseHistoryType Conditionally,
repeatable: [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.
caseDetail.responseHistory
  .activity
token Conditionally The type of activity or response made on the case by a buyer, a seller, or eBay. THIS FIELD IS IN THE PROCESS OF BEING DEPRECATED. TO REFERENCE THE CASE ACTIVITY, VIEW THE activityDetail CONTAINER INSTEAD.
caseDetail.responseHistory
  .activityDetail
ActivityDetailType (EnumerationDetailType) Conditionally This container consists of the code value and description of the case activity. This field can be considered an alternative to the activity field.
caseDetail.responseHistory
  .activityDetail.code
token Always Unique identifier of the enumeration value.
caseDetail.responseHistory
  .activityDetail.content
token Always For future use.
caseDetail.responseHistory
  .activityDetail.description
token Always A description of the enumeration value.
caseDetail.responseHistory
  .attributes
ResponseHistoryAttributesType Always Container consisting of three possible child fields to indicate if there is a money movement transaction or an appeal associated with case activity, or if the case has been put on hold. This field is always returned but sometimes as an empty field (no children).
caseDetail.responseHistory
  .attributes.appealRef
~appealRef Conditionally This field only appears under the caseDetail.responseHistory.attributes container if there is an appeal related to the case activity.
caseDetail.responseHistory
  .attributes.moneyMovementRef
~moneyMovementRef Conditionally This field only appears under the caseDetail.responseHistory.attributes container if there is a money movement transaction related to the case activity.
caseDetail.responseHistory
  .attributes.onholdReason
token Conditionally If an Item Not Returned or Significantly Not As Described case is put on hold, this field is returned as a code value. THIS FIELD IS IN THE PROCESS OF BEING DEPRECATED. TO REFERENCE THE REASON FOR THE HOLD, VIEW THE onholdReasonDetail CONTAINER INSTEAD.
caseDetail.responseHistory
  .attributes.onholdReasonDetail
OnHoldReasonDetailType (EnumerationDetailType) Conditionally If an Item Not Returned or Significantly Not As Described case is put on hold, this container is returned under responseHistory.attributes. This container consists of the code value and description of the reason why the case is on hold. This field can be considered an alternative to onholdReason, which only returns a code value.
caseDetail.responseHistory
  .attributes.onholdReasonDetail
  .code
token Always Unique identifier of the enumeration value.
caseDetail.responseHistory
  .attributes.onholdReasonDetail
  .content
token Always For future use.
caseDetail.responseHistory
  .attributes.onholdReasonDetail
  .description
token Always A description of the enumeration value.
caseDetail.responseHistory
  .author
CaseUserType Always Container that identifies the user who initiated the activity. The container includes the author's role (either buyer, seller, or eBay) and the eBay user ID if the author (initiator of the activity) is a buyer or seller.
caseDetail.responseHistory
  .author.role
CaseUserRoleType Always The user's role in the eBay Buyer Protection case.

Applicable values:

BUYER
The user's role in the case is buyer.
EBAY
A representative of eBay involved in mediating the case.
OTHER
The user's role in the case is classified as 'other'.
SELLER
The user's role in the case is seller.

caseDetail.responseHistory
  .author.userId
string Conditionally The eBay user ID for the user involved in the case.
caseDetail.responseHistory
  .creationDate
dateTime Always Timestamp indicating the date and time of the case activity or response.
caseDetail.responseHistory
  .note
string Conditionally This field is returned if a note was created to accompany the activity or response.
caseDetail
  .returnMerchandiseAuthorization
string Conditionally The Return Merchandize Authorization number is returned if the seller provided this number to the buyer (through provideRefundInfo or in the Resolution Center).
caseDetail.sellerShipment ShipmentType Always 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.
caseDetail.sellerShipment
  .carrierUsed
string Conditionally The shipping carrier being used by the buyer or seller to ship the package.
caseDetail.sellerShipment
  .deliveryDate
dateTime Conditionally The expected date of delivery from the buyer (buyerReturnShipment) or the seller (sellerShipment).
caseDetail.sellerShipment
  .deliveryStatus
token Conditionally The status of the delivery from the buyer (buyerReturnShipment) or the seller (sellerShipment).
caseDetail.sellerShipment
  .shippingAddress
Address Conditionally The container for the shipping address for the buyer or seller. If the buyer is returning an item, this address is the seller's shipping address. If the seller is shipping an item, this address is the buyer's shipping address.
caseDetail.sellerShipment
  .shippingAddress.city
string Conditionally The city listed for the eBay user's shipping address.
caseDetail.sellerShipment
  .shippingAddress.country
string Conditionally The country listed for the eBay user's shipping address.
caseDetail.sellerShipment
  .shippingAddress.name
string Conditionally The name listed for the eBay user's shipping address.
caseDetail.sellerShipment
  .shippingAddress.postalCode
string Conditionally The postal code listed for the eBay user's shipping address.
caseDetail.sellerShipment
  .shippingAddress
  .stateOrProvince
string Conditionally The state or province listed for the eBay user's shipping address.
caseDetail.sellerShipment
  .shippingAddress.street1
string Conditionally The first line of the street listed for the eBay user's shipping address.
caseDetail.sellerShipment
  .shippingAddress.street2
string Conditionally The second line of the street listed for the eBay user's shipping address. Based on the eBay user's shipping address, this field may be returned empty.
caseDetail.sellerShipment
  .shippingCost
Amount (double) Conditionally The total shipping costs for the buyer (buyerReturnShipment) or the seller (sellerShipment).
caseDetail.sellerShipment
  .trackingNumber
string Conditionally The shipment tracking number. eBay checks to verify that the tracking number is consistent with the numbering scheme used by the specified shipping carrier, but eBay cannot verify that the tracking number is accurate. Accuracy is the responsibility of the party shipping the package.
caseSummary CaseSummaryType Always Container consisting of high-level information on the eBay Buyer Protection Item Not Received or Significantly Not As Described case.
caseSummary.caseAmount Amount (double) Always The amount of money involved in the case.
caseSummary.caseId CaseIdType Always This container identifies a dispute case between the buyer and seller.
caseSummary.caseId.id string Always Unique identifier of the case. The caseId.id values are returned in the caseSummary container in the getUserCases and getEBPCaseDetail calls.
Max length: 38.
caseSummary.caseId.type CaseType Always eBay case type. Case types include eBay Buyer Protection and PayPal Buyer Protection cases (opened through the Resolution Center), older disputes created through other sites, and Unpaid Item or Cancel Transaction disputes created through the Resolution Center or with the AddDispute call of the Trading API. For all Resolution Case Management calls except getUserCases, only EBP_INR and EBP_SNAD are applicable caseType values.

Applicable values:

EBP_INR
An Item Not Received case opened by a buyer in the Resolution Center.
EBP_SNAD
A Significantly Not As Described case opened by a buyer in the Resolution Center.

(Not all values in CaseType apply to this field.)
caseSummary.caseQuantity int Always This value indicates the quantity of items in the transaction related to the case. This value is usually '1' unless a buyer bought multiple items at the same time from the same fixed-priced listing.
Min: 1.
caseSummary.creationDate dateTime Always Timestamp indicating the date that the case was opened.
caseSummary.item ItemType Always A container consisting of details on the item associated with the case.
caseSummary.item.globalId token Conditionally The identifier for the eBay site on which the item is listed.
caseSummary.item.itemId string Always The unique identifier for the eBay item listing involved in the case.
Max length: 19.
caseSummary.item.itemTitle string Always The title of the item listing involved in the case.
Max length: 55.
caseSummary.item
  .transactionDate
dateTime Always The timestamp of the eBay transaction being disputed in the case.
caseSummary.item.transactionId string Always The unique identifier for the eBay transaction being disputed in the case.
caseSummary.item
  .transactionPrice
Amount (double) Conditionally The monetary amount for the eBay transaction being disputed in the case.
caseSummary.lastModifiedDate dateTime Always Timestamp indicating the date on which the case was last modified. A case is considered modified if the status value changes.
caseSummary.otherParty CaseUserType Always The role (e.g. buyer, seller) of the other party involved in the case.
caseSummary.otherParty.role CaseUserRoleType Always The user's role in the eBay Buyer Protection case.

Applicable values:

BUYER
The user's role in the case is buyer.
EBAY
A representative of eBay involved in mediating the case.
OTHER
The user's role in the case is classified as 'other'.
SELLER
The user's role in the case is seller.

caseSummary.otherParty.userId string Conditionally The eBay user ID for the user involved in the case.
caseSummary.respondByDate dateTime Conditionally The date by which the next action in the case must be made either by the user (caller) or other party involved in the case. This field is only returned if a response or payment is due from the user or the other party involved in the case.
caseSummary.status CaseStatusType Always Container holding the status of the case. The field appearing under this container is dependent on the case type. For getEBPCaseDetail, only the EBPINRStatus or EBPSNADStatus fields may be returned under the caseSummary.status field.
caseSummary.status
  .EBPINRStatus
EBPINRCaseStatusType Conditionally The current status of an Item Not Received case opened by the buyer in the Resolution Center.

Applicable values: See EBPINRStatus.
caseSummary.status
  .EBPSNADStatus
EBPSNADCaseStatusType Conditionally The current status of a Significantly Not As Described case opened by the buyer in the Resolution Center.

Applicable values: See EBPSNADStatus.
caseSummary.user CaseUserType Always The role (e.g. buyer, seller) of the user making the call.
caseSummary.user.role CaseUserRoleType Always The user's role in the eBay Buyer Protection case.

Applicable values:

BUYER
The user's role in the case is buyer.
EBAY
A representative of eBay involved in mediating the case.
OTHER
The user's role in the case is classified as 'other'.
SELLER
The user's role in the case is seller.

caseSummary.user.userId string Conditionally The eBay user ID for the user involved in the case.
Standard Output Fields  
ack AckValue Always

Applicable values:

Failure
eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data.
PartialFailure
eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. Inspect the message details and resolve any problems before resubmitting the request.
Success
eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result.
Warning
The request that triggered the error was processed successfully but with one or more warnings.

errorMessage ErrorMessage Conditionally Information for an error or warning that occurred when eBay processed the request. This field is not returned if the ack value is Success.
errorMessage.error ErrorData Conditionally,
repeatable: [0..*]
Details about a single error.
errorMessage.error.category ErrorCategory Conditionally There are three categories of errors: request errors, application errors, and system errors.

Applicable values:

Application
An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay.
Request
An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay.
System
Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

errorMessage.error.domain string Conditionally Name of the domain in which the error occurred.
errorMessage.error.errorId long Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId token Conditionally Unique identifier for an exception associated with an error.
errorMessage.error.message string Conditionally A detailed description of the condition that caused the error.
errorMessage.error.parameter ErrorParameter (string) Conditionally,
repeatable: [0..*]
Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter
  [ attribute name ]
string Conditionally Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.severity ErrorSeverity Conditionally Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information on the cause.

If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay.

If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form.

If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem.

Applicable values:

Error
eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request.
Warning
The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this case, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.

errorMessage.error.subdomain string Conditionally Name of the subdomain in which the error occurred.
timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.
version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request.



Samples

Code samples not yet added for this call's documentation.



Change History

Change Date Description
1.3.0
2011-05-26
  • caseDetail.caseDocumentInfo (added): New container is returned for each proof document that has been uploaded and associated with the case. The container contains the name, type, and upload date of the proof document. This container will only be return for Gerrman sellers who have one or more proof documents associated with the case.
  • caseDetail.returnMerchandiseAuthorization (added): This field is returned if the seller provided a Return Merchandise Authorization number to the buyer (through provideRefundInfo, offerRefundUponReturn, or in the Resolution Center).
1.2.0
2011-02-16
  • caseDetail.decisionReasonDetail (added): New container contains a description (and a code value) of the case decision reason.
  • caseDetail.appeal.decisionReasonDetail (added): New container contains a description (and a code value) of the appeal decision reason.
  • caseDetail.initialBuyerExpectationDetail (added): New container contains a description (and a code value) of the initial buyer expectation.
  • caseDetail.detailStatusInfo (added): New container contains a description (and a code value) of the current status of the case.
  • caseDetail.responseHistory.attributes.onholdReasonDetail (added): New container contains a description (and a code value) of the reason why a case was put on hold.
  • caseDetail.responseHistory.activityDetail (added): New container contains a description (and a code value) of the case activity.
1.1.0
2010-12-08
  • caseDetail.decisionReason (added): New field contains a code value that represents the reason for a case decision.
  • caseDetail.appeal.decisionReason (added): New field contains a code value that represents the reason for an appeal decision.
  • caseDetail.initialBuyerExpectation (added): New field contains a code value that represents the initial buyer expectation.
  • caseDetail.detailStatus (added): New field contains a code value that represents the current status of the case.
  • caseDetail.notCountedInBuyerProtectionCases (added): New flag that indicates whether a case will count against the seller's performance rating.
  • caseDetail.responseHistory.attributes.appealRef (added): New field that is returned if there is an appeal related to the case activity.
  • caseDetail.responseHistory.attributes.moneyMovementRef (added): New field that is returned if there is a money movement transaction related to the case activity.
  • caseDetail.responseHistory.attributes.onholdReason (added): New field that is returned if the case is put on hold.
1.0.0
2010-09-17
  • (added) New call.