provideSellerInfo
Note: The Return Management API is no longer recommended. Instead, current users of the Return Management API should make plans to migrate to, and use the Return operations of the Post-Order API. New users interested is programmatically managing return requests, should also make plans to integrate with the Post-Order API. The Return Management API was developed to be used by sellers who had opted in to "Hassle-free Returns". Hassle-free Returns have been replaced by a new Returns Platform, where sellers fully or partially automate the processing of return requests through Return Automation Rules. The Return Management API does not support all features and logic of the new Returns Platform, and this API will be deprecated in the near future.
This call is used by the seller to provide a Return Merchandise Authorization number to the buyer, or an alternative return shipping address to the buyer who is returning an item. In this case, an "alternative" shipping address is one other than the seller's primary return address on file.
Note: Users of this call should start using the POST /post-order/v2/return/{returnId}/decide call of the Post-Order API instead.Request Details
In the provideSellerInfo request, the seller must provide the return ID for the return for which a Return Merchandise Authorization number or alternative return shipping address will be provided. If not already known, the return ID can be retrieved with a call to getUserReturns.
The seller inputs the Return Merchandise Authorization number in the returnMerchandiseAuthorization field.
To provide the buyer with an alternative return address, the returnAddress container must be used. 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 always applicable.
Working with the Response
The response for provideSellerInfo 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.
Output Samples Change History |
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"?> <provideSellerInfoRequest xmlns="http://www.ebay.com/marketplace/returns/v1/services"> <!-- Call-specific Input Fields --> <returnAddress> Address <city> string </city> <country> string </country> <county> string </county> <name> string </name> <postalCode> string </postalCode> <stateOrProvince> string </stateOrProvince> <street1> string </street1> <street2> string </street2> </returnAddress> <ReturnId> ReturnIdType <id> string </id> </ReturnId> <returnMerchandiseAuthorization> string </returnMerchandiseAuthorization> </provideSellerInfoRequest>
Argument | Type | Occurrence | Meaning |
---|
returnAddress | Address | Optional | This optional container allows the seller to provide an alternative return shipping address to the buyer. If not provided, the seller's primary return address on record is used as the return address. |
returnAddress.city | string | Optional | The city on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. |
returnAddress.country | string | Optional | The country on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. |
returnAddress.county | string | Optional | The county on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call. |
returnAddress.name | string | Optional | The name on record for the seller's shipping address. |
returnAddress.postalCode | string | Optional | The postal code on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. |
returnAddress.stateOrProvince | string | Optional | The state or province on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. |
returnAddress.street1 | string | Optional | The street address on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. |
returnAddress.street2 | string | Optional | The second line of the street address on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call. |
ReturnId | ReturnIdType | Required | Container consisting of the unique identifier for a return. A return ID value is required and the seller should take all precautions to make sure this value and the Return Merchandise Authorization number match before making the call. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. |
ReturnId.id | string | Required |
This string value is the unique identifier for a return, and is returned in the responses of getUserReturns and getReturnDetail. For getReturnDetail, getActivityOptions, issueRefund, provideSellerInfo, provideTrackingInfo, and setItemAsReceived, a ReturnId value is a required input field. Max length: 38. |
returnMerchandiseAuthorization | string | Conditional |
The Return Merchandise Authorization number associated with the item to be returned. An RMA number is a unique identifier that is provided by a manufacturer and authorizes the return of an item. Max length: 15. |
Input Samples Change History |
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"?> <provideSellerInfoResponse xmlns="http://www.ebay.com/marketplace/returns/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> </provideSellerInfoResponse>
Return Value | Type | Occurrence | Meaning |
---|
(No call-specific fields) |
Standard Output Fields |
ack | AckValue | Always |
A token representing the application-level acknowledgement code that indicates the response status, such as "Success". The AckValue enumeration type specifies the possible values for ack.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
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. |
errorMessage.error | ErrorData | Conditionally,
repeatable: [0..*] |
Details about a single error. |
errorMessage.error.category | ErrorCategory | Conditionally |
There are three categories of errors: request errors, application errors, and system errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
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. |
errorMessage.error.parameter | ErrorParameter (string) | Conditionally,
repeatable: [0..*] |
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. |
errorMessage.error.parameter [ attribute name ] |
string | Conditionally | 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. |
errorMessage.error.severity | ErrorSeverity | Conditionally |
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, resend 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. Applicable values: Code so that your app gracefully handles any future changes to this list. |
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 Features 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. |
Input Output Change History |
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 provide a Return Merchandise Authorization number and a return shipping address to the buyer who is returning an item.
Description
This provideSellerInfo call sample is used by a seller to provide a Return Merchandise Authorization number and a return shipping address to the buyer, who is requesting this information before returning the item.
Note that Return Merchandise Authorization numbers cannot be verified, so the seller should be careful in ensuring that an accurate number is provided to the buyer.
This call only returns the standard output fields to indicate a successful call.
Input
A seller provides a Return Merchandise Authorization number to the buyer using the returnMerchandiseAuthorization field, and a return shipping address using the returnAddress container.
The return ID is 5********0, so this Return Merchandise Authorization number applies to the item being returned.
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/returns/v1/services"> <soap:Header/> <soap:Body> <ser:provideSellerInfoRequest> <ser:ReturnId> <ser:id>5********0</ser:id> </ser:ReturnId> <ser:returnMerchandiseAuthorization>t********3</ser:returnMerchandiseAuthorization> <ser:returnAddress> <ser:name>A********r</ser:name> <ser:street1>1********t</ser:street1> <ser:street2>S********0</ser:street2> <ser:city>S********e</ser:city> <ser:county>S********a</ser:county> <ser:stateOrProvince>**</ser:stateOrProvince> <ser:country>US</ser:country> <ser:postalCode>9***9</ser:postalCode> </ser:returnAddress> </ser:provideSellerInfoRequest> </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. <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope"> <soapenv:Header/> <soapenv:Body> <ns1:provideSellerInfoResponse xmlns="http://www.ebay.com/marketplace/services" xmlns:ns1="http://www.ebay.com/marketplace/returns/v1/services"> <ns1:ack>Success</ns1:ack> <ns1:version>1.0.0</ns1:version> <ns1:timestamp>2011-11-06T00:55:52.572Z</ns1:timestamp> </ns1:provideSellerInfoResponse> </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"?> <provideSellerInfoResponse xmlns="http://www.ebay.com/marketplace/services" xmlns:ns1="http://www.ebay.com/marketplace/returns/v1/services"> <ack>Success</ack> <version>1.0.0</version> <timestamp>2011-11-06T00:55:52.572Z</timestamp> </provideSellerInfoResponse>
Input Output Samples |
Change History
Change Date | Description |
---|---|
1.0.0 2012-04-23 |
|