getActivityOptions

A seller can use this call to return one or more actions that can be performed based on the type and status of the eBay Buyer Protection case. Some options returned to a seller will contain a buyerPreference flag. If a seller is making a call and more than one option is returned, only one of the options will have a buyerPreference value of 'True'. The buyer's preference for resolving a case is specified when they open the case in the Resolution Center.

Request Details

In the getActivityOptions request, the seller must provide the case ID and the case type (EBP_INR or EBP_SNAD only) for the Item Not Received or Significantly Not As Described case. 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, use EBP_INR and/or EBP_SNAD case type filters to restrict results to Item Not Received and/or Significantly Not As Described cases. To get more detailed information on an eBay Buyer Protection case, you will want to call getEBPCaseDetail , using the same case ID in the request.

Working with the Response

In addition to the standard timestamp and version fields and the errorMessage container (if errors and/or warnings exist), the response for getActivityOptions includes the activityOptions container, which will contain one or more activity options, based on the type and status of the case.

Sellers making a getActivityOptions call should pay attention to any buyerPreference fields that are returned under an applicable activity option container. A true value in a buyerPreference field indicates that the corresponding activity option is the buyer's preference for resolving the case. The buyer's preference is stated when the buyer opens the case in the Resolution Center. Only one activity option returned for a seller in the getActivityOptions response can be the buyer's preference.

See the Call-specific Output Fields table for more information on each activity option, including the next step that the seller can take to perform one of the available activity options.

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"?>
<getActivityOptionsRequest xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- Call-specific Input Fields -->
  <caseId> CaseIdType
    <id> string </id>
    <type> CaseType </type>
  </caseId>
</getActivityOptionsRequest>

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"?>
<getActivityOptionsResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- Call-specific Output Fields -->
  <activityOptions> ActivityOptionListType
    <appealToCustomerSupport> AppealToCustomerSupportOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
      <customerSupportResponseTimeInHours> integer </customerSupportResponseTimeInHours>
    </appealToCustomerSupport>
    <contactCustomerSupport> ContactCustomerSupportOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
    </contactCustomerSupport>
    <escalateToCustomerSupport> EscalateToCustomerSupportOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
      <customerSupportResponseTimeInHours> integer </customerSupportResponseTimeInHours>
    </escalateToCustomerSupport>
    <issueFullRefund> IssueFullRefundOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
      <daysToRefundBuyer> integer </daysToRefundBuyer>
    </issueFullRefund>
    <issuePartialRefund> IssuePartialRefundOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
    </issuePartialRefund>
    <offerOtherSolution> OfferOtherSolutionOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
    </offerOtherSolution>
    <provideRefundInfo> ProvideRefundInfoOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
    </provideRefundInfo>
    <provideShippingInfo> ProvideShippingInfoOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
      <carrierUsed> string </carrierUsed>
      <shippedDate> string </shippedDate>
    </provideShippingInfo>
    <provideShippingOrTrackingInfo> ProvideShippingOrTrackingInfoOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
    </provideShippingOrTrackingInfo>
    <provideTrackingInfo> ProvideTrackingInfoOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
      <carrierUsed> string </carrierUsed>
      <trackingNumber> string </trackingNumber>
    </provideTrackingInfo>
    <requestBuyerToReturn> RequestBuyerToReturnOptionType (BaseActivityOptionType)
      <buyerPreference> boolean </buyerPreference>
    </requestBuyerToReturn>
  </activityOptions>
  <!-- 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>
</getActivityOptionsResponse>

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.

This call is used by a seller to retrieve a list of the next possible actions to take in an open case.

Description

This getActivity call sample retrieves the list of possible next actions that the authenticated seller can take on an open eBay Buyer Protection Significantly Not As Described case. The case ID and case type are required input fields.

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.

This call returns all possible activity options that the seller can perform on the open case specified in the request. For applicable activity options, the buyerPreference field will show 'true' for the activity option that is the buyer's preference for resolving the case.

Input

A seller wants to retrieve the list of activity options for an open Significantly Not As Described case. The case ID is 5********1. 'EBP_SNAD' 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="http://www.ebay.com/marketplace/resolution/v1/services">
   <soap:Header>
      <RequesterCredentials>
          <eBayAuthToken>A********3</ser:eBayAuthToken>
      </RequesterCredentials>
   </soap:Header>
   <soap:Body>
      <getActivityOptionsRequest>
          <caseId>
              <id>5********1</id>
              <type>EBP_SNAD</type>
          </caseId>
      </getActivityOptionsRequest>
   </soap:Body>
</soap:Envelope>

Output

The list of next possible actions that a seller can make on the case is returned under the activityOptions container. These activity options include the following:

• Request buyer to return item: a seller often requires that a buyer returns a Significantly Not As Described item before a full refund will be issued to the buyer. As indicated by the 'true' value in the buyerPreference field, the buyer is planning to return the item and is expecting a full refund once the seller receives the returned item. To officially notify the buyer that the item must be returned before a full refund can be issued the seller should call offerRefundUponReturn.
• Issue a full refund to buyer: the seller can use the issueFullRefund call to issue a full refund to the buyer. The seller should issue the refund to the buyer within the number of days specified in the daysToRefundBuyer value.
• Issue a partial refund to the buyer: the seller will often issue a partial refund to a buyer who is keeping the Significantly Not As Described item, but is not fully satisfied. A partial refund can be offered to the buyer using the offerPartialRefund call, and upon acceptance of the refund amount by the buyer, the seller can issue the refund using the issuePartialRefund call.
• Offer other solution: the seller can use the offerOtherSolution call to offer a customized solution to the buyer.
• Escalate the case to eBay customer support: the seller can use the escalateToCustomerSupport call to escalate the case to eBay customer support. The customerSupportResponseTimeInHours value indicates the estimated response time from eBay customer support.

SOAP format. Also available is the XML equivalent.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
   <soap:Header/>
   <soap:Body>
      <getActivityOptionsResponse>
         <ack>Success</ack>
         <version>1.2.0</version>
         <timestamp>2011-01-25T22:28:24.795Z</timestamp>
         <activityOptions>
            <requestBuyerToReturn>
               <buyerPreference>true</buyerPreference>
            </requestBuyerToReturn>
            <issueFullRefund>
               <buyerPreference>false</buyerPreference>
               <daysToRefundBuyer>3</daysToRefundBuyer>
            </issueFullRefund>
            <issuePartialRefund>
               <buyerPreference>false</buyerPreference>
            </issuePartialRefund>
            <offerOtherSolution/>
            <escalateToCustomerSupport>
               <customerSupportResponseTimeInHours>48</customerSupportResponseTimeInHours>
            </escalateToCustomerSupport>
         </activityOptions>
      </getActivityOptionsResponse>
   </soap:Body>
</soap: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"?> 
<getActivityOptionsResponse  xmlns:"http://www.ebay.com/marketplace/resolution/v1/services">
   <ack>Success</ack>
   <version>1.2.0</version>
   <timestamp>2011-01-25T22:28:24.795Z</timestamp>
   <activityOptions>
      <requestBuyerToReturn>
         <buyerPreference>true</buyerPreference>
      </requestBuyerToReturn>
      <issueFullRefund>
         <buyerPreference>false</buyerPreference>
         <daysToRefundBuyer>3</daysToRefundBuyer>
      </issueFullRefund>
      <issuePartialRefund>
         <buyerPreference>false</buyerPreference>
      </issuePartialRefund>
      <offerOtherSolution/>
      <escalateToCustomerSupport>
         <customerSupportResponseTimeInHours>48</customerSupportResponseTimeInHours>
      </escalateToCustomerSupport>
   </activityOptions>
</getActivityOptionsResponse>

Change History