Provides Return Address
POST /post-order/v2/casemanagement/{caseId}/provide_return_address
Sellers use this call to provide the correct return address to the buyer. If applicable, and requested by the buyer, the seller can also provide the Return Merchandise Authorization (RMA) number to the buyer through this call.
Output Samples Change History |
Input
See also Samples.
Resource URI (production)
POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/provide_return_address
URI parameters
Parameter | Type | Required? | Meaning |
---|---|---|---|
caseId | string | Required |
The unique identifier of a case. This URI parameter is required in order to identify the case for which the seller is providing a return address and or an RMA number. The case is identified by the caseId that is passed in as part of the call URI.
|
HTTP request headers
All requests made to eBay REST operations require you to provide the authorization
HTTP header for authentication.
See HTTP request headers for details.
Authorization
This call uses standard authorization tokens. See Making a Call for details.
Payload model
The following lists all fields that could be included in the request.
{ /* ReturnAddressRequest */ "firstName": string, "lastName": string, "returnAddress": { /* Address */ "addressLine1": string, "addressLine2": string, "addressType": string, "city": string, "country": string, "county": string, "isTransliterated": boolean, "nationalRegion": string, "postalCode": string, "script": string, "stateOrProvince": string, "transliteratedFromScript": string, "worldRegion": string }, "RMA": string }
Request field descriptions
Input Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
firstName | string | Conditional | The first name associated with the return address that is being provided by the seller in the returnAddress container. A business name or store name can also be provided in this field. This field is conditionally required if the seller is providing the buyer an alternative return address. |
lastName | string | Optional | The last name associated with the return address that is being provided by the seller in the returnAddress container. This field is optional and might not be used if the seller is providing a business name or store name in the firstName field. |
returnAddress | Address | Conditional | The full return address is provided in this container. This container is conditionally required if the seller is providing the buyer an alternative return address. |
returnAddress.addressLine1 | string | Conditional | The first line of the street address. The first line of the street address is always used by containers using the Address type. |
returnAddress.addressLine2 | string | Optional | The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'. |
returnAddress.addressType | string | Optional |
This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.
Applicable values are from AddressTypeEnum:See addressType. |
returnAddress.city | string | Conditional | The city of the address. This field is always used by containers using the Address type. |
returnAddress.country | string | Conditional |
This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.
Applicable values are from CountryCodeEnum:See country. |
returnAddress.county | string | Optional | The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. |
returnAddress.isTransliterated | boolean | Optional | This Boolean field is returned as 'true' if language transliteration was required. |
returnAddress.nationalRegion | string | Optional | This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions. |
returnAddress.postalCode | string | Conditional | The postal code of the address. This field is always used by containers using the Address type. |
returnAddress.script | string | Optional |
This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.
Applicable values are from LanguageScriptEnum:See script. |
returnAddress.stateOrProvince | string | Conditional | The state or province of the address. This field is always used by containers using the Address type. |
returnAddress .transliteratedFromScript |
string | Optional |
This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.
Applicable values are from LanguageScriptEnum:See transliteratedFromScript. |
returnAddress.worldRegion | string | Optional |
This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.
Applicable values are from WorldRegionEnum:See worldRegion. |
RMA | 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. This field is conditionally required if there is an RMA number associated with the item, and if the buyer is requesting an RMA number. |
Input Samples Change History |
Output
See also Samples.
Payload model
This call has no response payload.
nullInput 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.
Seller provides an alternate return address to the buyer.
Description
The buyer will be returning an item, but the seller does not want the buyer to return the item to the default return address listed for the seller. The seller uses this call to provide the return address where the buyer will ship the return item.
Input
The seller passes in the case ID value as a path parameter to identify the case for which an alternate return address is being provided to the buyer. The firstName field is used to provide the name that should appear on the return shipment. The returnAddress container displays the correct address that the buyer will use to return the item.
URL format. See also the non-wrapped version of this URL. POST https://api.ebay.com/post-order/v2/casemanagement/5********3/provide_return_address { "firstName": "e***********1", "returnAddress": { "addressLine1": "2******************e", "addressType": "BUSINESS", "city": "San Jose", "country": "US", "postalCode": "9***5", "stateOrProvince": "California" } }
Output
There is no output payload with this response. A successful call contains an HTTP status code of 200.
JSON format.
Input Output Samples |
Change History
Change Date | Description |
---|