Send Return Shipping Label

POST /post-order/v2/return/{returnId}/send_shipping_label

This method can be used on behalf of a buyer to send a return shipping label to a specified email address. The email address is passed in through the to_email_address query parameter.

If the request is successful, the shipping label will be sent to the specified email address and the labelURL field is returned in the response.

This method is not supported in the Sandbox environment.

Input

Resource URI (production)

POST https://api.ebay.com/post-order/v2/return/{returnId}/send_shipping_label?
  to_email_address=string

URI parameters

Parameter	Type	Required?	Meaning
returnId	string	Required	The unique eBay-assigned ID of the return. The returnId value is required as part of the call URI to identify the return request for which a return shipping label is being sent.
to_email_address	string	Required	The recipient's email address is specified in this query parameter.

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

This call has no request payload.

Output

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

Supported response formats: application/json, application/xml

For more information:
- See SendShippingLabelResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* SendShippingLabelResponse */
"labelURL": string
}

Response field descriptions

Output Container/Field	Type	Occurrence	Meaning
labelURL	string	Conditionally	This string value is the URL of the page where the shipping label can be downloaded and printed. This field is returned if the shipping label was successfully sent to the recipient with the request.

null

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.

Sample: Basic Call

Send return shipping label.

Description

This call is used to send a return shipping label to the buyer's email address.

Input

The seller passes in the return request ID as a path parameter in the URI, and specifies the destination email address of the shipping label through the labelURL query parameter. There is no request payload for this call.

URL format. See also the non-wrapped version of this URL.

POST https://api.ebay.com/post-order/v2/return/5********6/send_shipping_label?
   to_email_address=b*******1@*****.com

Output

Upon a successful call, the URL to shipping label page is returned in the response. This same URL will be sent to the email address specified in the request.

JSON format.
{ 
"labelURL": "https://return.ebay.com/ws/eBayISAPI.dll?ResolveReturn&eventName=returnLabel&returnId=5********6"
}

Change History

Change Date	Description