eBay Resolution Case Management API Call Reference Version 1.3.0 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

Call Index Field Index Enumeration Index Type Index Errors by Number Input Output Samples Change History User Notes

provideReturnInfo

This call is used by the seller to provide an alternative shipping address to the buyer who is returning an Significantly Not As Described item. In this case, an "alternative" shipping address is one other than the seller's default shipping address or the seller's return address on file. Optionally, this call can also be used by the seller to supply a Return Merchandise Authorization number to the buyer.

Request Details

In the provideReturnInfo request, the seller must provide the case ID and the case type (EBP_SNAD only) for the case in which an item is being returned by the buyer. 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 as the 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 address container is required. The street1, city, stateOrProvince, and postalCode are the required child fields. The name, country, and street2 fields are optional child fields. The county field is not used.

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

Working with the Response

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

Back to top

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

Back to top

provideReturnInfo 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"?>
<provideReturnInfoResponse 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>
</provideReturnInfoResponse>

Back to top

provideReturnInfo Samples

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

Note: Some data in these samples might no longer be active. If necessary, you can substitute current data in your requests.

This call is used by a seller to provide an alternative shipping address to the buyer who is returning an item. A Return Merchandise Authorization number can also be provided to the buyer with this call.

Description

This provideReturnInfo call sample is used by a seller to provide an alternative shipping address to the buyer who is returning an item. The case ID, case type, and address container are required input elements. The returnMerchandiseAuthorization field is optional and should only be used if applicable.

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 provides a return address to the buyer who is returning a Significantly Not As Described item to the seller. This address overrides the seller's default shipping address or another return address on file. The seller also provides a Return Merchandise Authorization number to the buyer.

The case ID is 5000270988. 'EBP_SNAD' is passed in as the caseId.type value. The full return address for the seller is passed into the address container. A Return Merchandise Authorization number is passed into the returnMerchandiseAuthorization field.

XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<provideReturnInfoRequest xmlns:"http://www.ebay.com/marketplace/resolution/v1/services">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <address>
    <!--Required address subfields-->
    <street1>2145 Hamilton Avenue</street1>
    <city>San Jose</city>
    <stateOrProvince>CA</stateOrProvince>
    <postalCode>95125</postalCode>
    <!--Optional address subfields-->
    <name>QIBUS</name>
    <country>US</country>
    <street2>Mailstop 20</street2>
  </address>
  <caseId>
    <id>5000270988</id>
    <type>EBP_SNAD</type>
  </caseId>
  <!--Optional:-->
  <returnMerchandiseAuthorization>123434555</returnMerchandiseAuthorization>
</provideReturnInfoRequest>

Output

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

XML format. Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<provideReturnInfoResponse 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>
</provideReturnInfoResponse>

Back to top

provideReturnInfo Change History

Back to top

User-Contributed Notes

Copyright © 2010–2012 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developer Network and API License Agreement.