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.
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.
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.
Back to top
|Output Samples Change History User Notes|
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"?> <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>
This optional field allows the seller to add additional instructions regarding the return of the item. This comment is intended to be read by the buyer in the Resolution Center.
Max length: 1000.
|caseId||CaseIdType||Required||This container is used to identify a specific eBay Buyer Protection case opened by a buyer in the eBay Resolution Center.|
Unique identifier of the case. The caseId.id value is required in the request of every call except getVersion. The caseId.id value for a case is always returned in the caseSummary container of the getUserCases and getEBPCaseDetail calls.
Max length: 38.
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.
A Significantly Not As Described case opened by a buyer in the Resolution Center.
(Not all values in CaseType apply to this field.)
|returnAddress||Address||Optional||This container, defined by Address type, allows the seller to input a different return address than the one listed as the shipping address for the seller. This container is optional.|
|returnAddress.city||string||Optional||The city listed for the eBay user's shipping address.|
|returnAddress.country||string||Optional||The country listed for the eBay user's shipping address.|
|returnAddress.name||string||Optional||The name listed for the eBay user's shipping address.|
|returnAddress.postalCode||string||Optional||The postal code listed for the eBay user's shipping address.|
|returnAddress.stateOrProvince||string||Optional||The state or province listed for the eBay user's shipping address.|
The first line of the street listed for the eBay user's shipping address.
This field is required in the provideReturnInfo request, and is also required in the offerRefundUponReturn request if the seller is providing the buyer an alternative return shipping address via the returnAddress container.
This field is always returned with the shippingAddress container (seller shipment or buyer return) in the getEBPCaseDetail response.
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 empty.
This field is conditional in the provideReturnInfo and offerRefundUponReturn requests.
If specified, this field will be returned with the shippingAddress container (seller shipment or buyer return) in the getEBPCaseDetail response.
|returnMerchandiseAuthorization||string||Optional||If applicable and requested by the buyer, the seller can include the Return Merchandise Authorization number in the request.|
Back to top
|Input Samples Change History User Notes|
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"?> <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>
|(No call-specific fields)|
|Standard Output Fields|
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.
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.
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.
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.|
|Details about a single error.|
There are three categories of errors: request errors, application errors, and system errors.
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.
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.
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.|
|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.|
[ attribute name ]
|string||Conditionally||The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value.|
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.
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.
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.|
Back to top
|Input Output Change History User Notes|
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 inform the buyer that the Significantly Not As Described item must be returned before a full refund can be issued.
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.
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 5000223009. '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.
XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <offerRefundUponReturnRequest xmlns:"http://www.ebay.com/marketplace/resolution/v1/services"> <RequesterCredentials> <eBayAuthToken>ABC...123</eBayAuthToken> </RequesterCredentials> <caseId> <id>5000223009</id> <type>EBP_SNAD</type> </caseId> <!--Optional:--> <address> <!--Required:--> <street1>2145 Hamilton Avenue</street1> <city>San Jose</city> <stateOrProvince>CA</stateOrProvince> <postalCode>95125</postalCode> <!--Optional:--> <name>QIBUS</name> <country>US</country> <street2>Mailstop 20</street2> </address> <returnMerchandiseAuthorization>123434566</returnMerchandiseAuthorization> <additionalReturnInstructions>Please return the item to the provided address to receive a full refund.</additionalReturnInstructions> </offerRefundUponReturnRequest>
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"?> <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>
Back to top
|Input Output Samples User Notes|
Back to top
|Input Output Samples Change History User 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.