getEBPCaseDetail

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

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 case ID and case type. These are the same values passed into the request.
• the creation date of the case.
• The role and user ID of the user making the call. The role should always be SELLER.
• The role and user ID of the other party in the case. The other party's role should always be BUYER.
• The status of the case. Depending on case type, either a status.EBPINRStatus , a status.EBPSNADStatus, or a status.returnStatus (UK or DE only) field will be returned giving the present status of the case.
• An item container consisting of the item ID and title, the transaction ID, date, and price, and the site ID of the item listing site.
• The quantity of items associated with the case. Most often, this value will be 1. However, it is possible for it to be higher if the order/shipment consisted of multiple items.
• The total monetary amount under dispute in the case.
• The "respond by" date (if applicable). This field is returned if a payment or response is due from the buyer or seller.
• The date of the last status change in the case.
• The Return Merchandise Authorization number is returned if provided to the buyer by the seller

The caseDetail container consists of the following information:

• The site ID of the eBay site where the case was created.
• The detailStatus field indicates the high-level status of the case.
• One or more responseHistory nodes, which record all activity in the case. Each responseHistory node includes the initiator (author) and date of the activity, the activity type, indicators if the activity is related to a case appeal or money movement transaction, and any note related to the case activity (if applicable). If a case has been put on hold, details for the hold are also returned.
• The inititalBuyerExpectation field indicates what the buyer is hoping to accomplish by opening the case. For an Item Not Received case, a typical value would be "Buyer did not receive item and wants a full refund." For an Significantly Not As Described case, a typical value would be "Buyer wants seller to send another identical item."
• The outcome and date of the decision if a decision has been made on the case.
• The details of an appeal if an appeal has been made on the case.
• The details of all money movement transactions involved in the case. Money movement details include the money movement type and date, the parties (buyer, seller, or eBay) on both sides of the transaction, the transaction ID, the amount of money involved in the transaction, the payment method used, and status (result) of the transaction.
• The refund amount if a partial or full refund has been credited to the buyer.
• The shipping details. A sellerShipment container is returned if an original or replacement item (or missing parts) is being shipped to the buyer, and a buyerReturnShipment container is returned if the buyer is returning an item.
• A flag indicating if the Final Value Fee associated with the original order line item will be credited back to the seller's account.
• A flag indicating if the case decision will affect the seller's performance standards.
• One or more caseDocumentInfo containers are returned if one or more proof documents have been uploaded. Only the German site supports proof documents.

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:

• payout: An account-level refund to the buyer or seller.
• reimbursement: A charge against the seller.
• refund: A refund against a specific money movement transaction to the buyer or seller.
• reversal: A reversal against a refund, payout, or reimbursement.
• other: Any other money movement transaction.

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

See also Samples.

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 the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

<?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>

Output

See also Samples.

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 the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?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 values allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</getEBPCaseDetailResponse>

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Available samples:

• Basic Call ↓ - Retrieves case details on a single eBay Buyer Protection Significantly Not As Described case. This call sample is based on version 1.0.0.
• Item Not Received Call ↓ - Retrieves case details on a single eBay Buyer Protection Item Not Received case.

Retrieves case details on a single eBay Buyer Protection Significantly Not As Described case. This call sample is based on version 1.0.0.

Description

This getEBPCaseDetail call sample returns case details on a single eBay Buyer Protection Significantly Not As Described case.

This call will fail if an invalid case ID is passed in. If the case ID does not match the case type that is passed in, a warning message will be returned in the request, but the call will succeed (if case ID is valid). The caller must be authenticated to make this call.

Input

A seller wants to retrieve details of a Significantly Not As Described case. The case ID is 5********5. 'EBP_SNAD' is passed in as the caseId.type value

Output

In Case 5********5, the buyer opened a Significantly Not As Described case against the seller. The seller did not respond to the case in the alotted time, so eBay customer support decided fully in the buyer's favor and refunded the full price of the item to the buyer. The seller did not agree with the decision and makes an appeal on the case decision. The seller's reason for the appeal appears in the caseDetail.responseHistory.note field. The seller wins the appeal.

There were two money movement transactions involved in this case. The first money movement transaction was eBay refunding the buyer after the original case decision. The second money movement transaction was the seller refunding eBay, however, this transaction was cancelled after the seller won the appeal.

Back to list of samples

Retrieves case details on a single eBay Buyer Protection Item Not Received case.

Description

This getEBPCaseDetail call sample returns case details on a single eBay Buyer Protection Item Not Received case. This call sample is based on version 1.3.0.

This call will fail if an invalid case ID is passed in. If the case ID does not match the case type that is passed in, a warning message will be returned in the request, but the call will succeed (if case ID is valid). The caller must be authenticated to make this call.

Input

A seller wants to retrieve details of an Item Not Received case. The case ID is 5********8. 'EBP_INR' is passed in as the caseId.type value.

SOAP format. Also available is the XML equivalent.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://www.ebay.com/marketplace/resolution/v1/services">
   <soap:Header>
       <ebl:RequesterCredentials xmlns:ebl="urn:ebay:apis:eBLBaseComponents" soap:mustUnderstand="0">
          <ebl:eBayAuthToken>A********3</ebl:eBayAuthToken>
      </ebl:RequesterCredentials>
   </soap:Header>
   <soap:Body>
      <ser:getEBPCaseDetailRequest>
         <ser:caseId>
            <ser:id>5********1</ser:id>
            <ser:type>EBP_INR</ser:type>
         </ser:caseId>
      </ser:getEBPCaseDetailRequest>
   </soap:Body>
</soap:Envelope>

Output

In Case 5********8, the buyer opened and escalated an Item Not Received case against the seller. The buyer is seeking a full refund as specified in the initialBuyerExpectationDetail container. As indicated in the caseSummary.caseAmount field, the amount in dispute is $4.00. Based on the timestamp of the call, and the timestamp specified in the caseSummary.respondByDate field, the seller has two days to respond to the escalated case and to try to make it right with the buyer.

SOAP format. Also available is the XML equivalent.

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <getEBPCaseDetailResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
         <ack>Success</ack>
         <version>1.3.0</version>
         <timestamp>2011-04-15T01:20:38.294Z</timestamp>
         <caseSummary>
            <caseId>
               <id>5********1</id>
               <type>EBP_INR</type>
            </caseId>
            <user>
               <userId>c********r</userId>
               <role>SELLER</role>
            </user>
            <otherParty>
               <userId>c********3</userId>
               <role>BUYER</role>
            </otherParty>
            <status>
               <EBPINRStatus>MY_RESPONSE_DUE</EBPINRStatus>
            </status>
            <item>
               <itemId>2********7</itemId>
               <itemTitle>FixedPriceItem-PayPal-INR</itemTitle>
               <transactionPrice currencyId="EUR">6.0</transactionPrice>
               <globalId>EBAY-DE</globalId>
               <transactionId>7********2</transactionId>
            </item>
            <caseQuantity>1</caseQuantity>
            <caseAmount currencyId="EUR">6.0</caseAmount>
            <respondByDate>2011-04-21T07:56:30.000Z</respondByDate>
            <creationDate>2011-04-11T07:56:30.000Z</creationDate>
            <lastModifiedDate>2011-04-11T07:57:08.000Z</lastModifiedDate>
         </caseSummary>
         <caseDetail>
            <openReason>Item not received</openReason>
            <decision>OTHER</decision>
            <FVFCredited>false</FVFCredited>
            <globalId>EBAY-DE</globalId>
            <responseHistory>
               <note>test</note>
               <author>
                  <role>BUYER</role>
               </author>
               <activityDetail>
                  <code>0</code>
                  <description>A CPS case was created.</description>
               </activityDetail>
               <creationDate>2011-04-11T07:56:07.000Z</creationDate>
            </responseHistory>
            <agreedRefundAmount>0.0</agreedRefundAmount>
            <detailStatusInfo>
               <code>1</code>
               <description>Case is open and has not yet been escalated.</description>
               <content>Case Open: Work it out</content>
            </detailStatusInfo>
            <initialBuyerExpectationDetail>
               <code>101</code>
               <description>Buyer has not received the item and wants a full refund.</description>
            </initialBuyerExpectationDetail>
         </caseDetail>
      </getEBPCaseDetailResponse>
   </soapenv:Body>
</soapenv:Envelope>

   Here is the same output in XML format. Note that this does not include standard values.

XML format. Also available is the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
   <getEBPCaseDetailResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
      <ack>Success</ack>
      <version>1.3.0</version>
      <timestamp>2011-04-15T01:20:38.294Z</timestamp>
      <caseSummary>
        <caseId>
          <id>5********1</id>
          <type>EBP_INR</type>
        </caseId>
        <user>
          <userId>c********r</userId>
          <role>SELLER</role>
        </user>
        <otherParty>
          <userId>c********3</userId>
          <role>BUYER</role>
        </otherParty>
        <status>
          <EBPINRStatus>MY_RESPONSE_DUE</EBPINRStatus>
        </status>
        <item>
          <itemId>2********7</itemId>
          <itemTitle>FixedPriceItem-PayPal-INR</itemTitle>
          <transactionPrice currencyId="EUR">6.0</transactionPrice>
          <globalId>EBAY-DE</globalId>
          <transactionId>7********2</transactionId>
        </item>
        <caseQuantity>1</caseQuantity>
        <caseAmount currencyId="EUR">6.0</caseAmount>
        <respondByDate>2011-04-21T07:56:30.000Z</respondByDate>
        <creationDate>2011-04-11T07:56:30.000Z</creationDate>
        <lastModifiedDate>2011-04-11T07:57:08.000Z</lastModifiedDate>
      </caseSummary>
      <caseDetail>
        <openReason>Item not received</openReason>
        <decision>OTHER</decision>
        <FVFCredited>false</FVFCredited>
        <globalId>EBAY-DE</globalId>
        <responseHistory>
           <note>test</note>
           <author>
             <role>BUYER</role>
           </author>
           <activityDetail>
             <code>0</code>
             <description>A CPS case was created.</description>
           </activityDetail>
           <creationDate>2011-04-11T07:56:07.000Z</creationDate>
         </responseHistory>
         <agreedRefundAmount>0.0</agreedRefundAmount>
         <detailStatusInfo>
             <code>1</code>
             <description>Case is open and has not yet been escalated.</description>
             <content>Case Open: Work it out</content>
         </detailStatusInfo>
         <initialBuyerExpectationDetail>
             <code>101</code>
             <description>Buyer has not received the item and wants a full refund.</description>
         </initialBuyerExpectationDetail>
      </caseDetail>
  </getEBPCaseDetailResponse>

Back to list of samples

Change History