offerRefundUponReturn

This call is used by sellers to inform the buyer that the Significantly Not As Described item must be returned before a full refund can be issued. Only the caseId container is required, but the seller can also include a Return Merchandise Authorization number, a return address (if different from seller's default shipping address or return address on file), and any additional return instructions.

Request Details

In the offerRefundUponReturn request, the seller must provide the case ID and the case type (always EBP_SNAD for this call) for the case upon which a refund will be issued. 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_SNAD case type filter to restrict results to 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.

The returnAddress container allows the seller to provide an alternative return shipping address to the buyer. If this container is not used, the buyer will use the seller's default shipping address or the return address already on file.

If known and applicable, the seller can include the Return Merchandise Authorization number in the returnMerchandiseAuthorization field.

The additionalReturnInstructions field is an optional field that allows the seller to provide any relevant return instructions to the buyer.

Working with the Response

The response for offerRefundUponReturn includes the standard fields for a successful call, which are timestamp and version. If applicable, errors and/or warnings may be returned in an errorMessage container.

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"?>
<offerRefundUponReturnRequest xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- Call-specific Input Fields -->
  <additionalReturnInstructions> string </additionalReturnInstructions>
  <caseId> CaseIdType
    <id> string </id>
    <type> CaseType </type>
  </caseId>
  <returnAddress> Address
    <city> string </city>
    <country> string </country>
    <name> string </name>
    <postalCode> string </postalCode>
    <stateOrProvince> string </stateOrProvince>
    <street1> string </street1>
    <street2> string </street2>
  </returnAddress>
  <returnMerchandiseAuthorization> string </returnMerchandiseAuthorization>
</offerRefundUponReturnRequest>

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"?>
<offerRefundUponReturnResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- (No call-specific Output fields) -->

  <!-- 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>
</offerRefundUponReturnResponse>

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 inform the buyer that the Significantly Not As Described item must be returned before a full refund can be issued.

Description

This offerRefundUponReturn call sample notifies the buyer that a Significantly Not As Described item must be returned before a full refund can be issued. The case ID and case type are required input fields. The address container, the returnMerchandiseAuthorization field, and the additionalReturnInstructions fields are optional.

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 only returns the standard output fields to indicate a successful call.

Input

A seller informs the buyer that the Significantly Not As Described item must be returned before a full refund can be issued.

The case ID is 5********9. 'EBP_SNAD' is passed in as the caseId.type value. The seller also uses all three optional elements. The return address passed into the returnAddress container will override the seller's default shipping address or return address already on file. The seller also provides the buyer with a Return Merchandise Authorization number and additional return instructions.

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</eBayAuthToken>
      </RequesterCredentials>
   </soap:Header>
   <soap:Body>
      <offerRefundUponReturnRequest>
         <caseId>
            <id>5********9</id>
            <type>EBP_SNAD</type>
         </caseId>
         <!--Optional:-->
         <returnAddress>
             <!--Required:-->
             <street1>2********e</street1>
             <city>S********e</city>
             <stateOrProvince>**</stateOrProvince>
             <postalCode>9***5</postalCode>
             <!--Optional:-->
             <name>Q********S</name>
             <country>US</country>
             <street2>M********0</street2>
         </returnAddress>
         <returnMerchandiseAuthorization>1********6</returnMerchandiseAuthorization>
         <additionalReturnInstructions>Please return the item to the provided address to receive a full refund.</additionalReturnInstructions>
      </offerRefundUponReturnRequest>
   </soap:Body>
</soap:Envelope>

Output

The seller's call is successful as indicated by the Success value in the ack field.

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>
      <offerRefundUponReturnResponse>
         <ack>Success</ack>
         <version>1.3.0</version>
         <timestamp>2011-04-11T02:25:41.001Z</timestamp>
      </offerRefundUponReturnResponse>
   </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"?>
<offerRefundUponReturnResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
   <ack>Success</ack>
   <version>1.3.0</version>
   <timestamp>2011-04-11T02:25:41.001Z</timestamp>
</offerRefundUponReturnResponse>

Change History