Add Shipping Label Info

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

The primary function of this seller-facing method is to create a return shipping label for the buyer. However, this method can also be used on behalf of the seller to provide more information to the buyer about the shipping label. For example, the seller may want to use this method to inform the buyer that an eBay or seller-provided shipping label is already available for use.

The seller may need to first call POST /post-order/v2/return/{returnId}/initiate_shipping_label method before using this method.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/return/{returnId}/add_shipping_label

URI parameters

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.

{ /* ProvideLabelRequest */
"carrierEnum": string,
"carrierName": string,
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    },
"fileId": string,
"forwardShippingLabelProvided": boolean,
"labelAction": string,
"labelSentDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"noLabelReason": string,
"returnLabelCost":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "exchangeRate": string,
    "value": number
    },
"trackingNumber": string
}

Request field descriptions

Output

See also Samples.

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 ProvideLabelResponse 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

{ /* ProvideLabelResponse */
"labelData": string,
"labelId": string,
"labelURL": string,
"trackingNumber": string
}

Response field descriptions

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 creates a return shipping label for the buyer to use.

Description

This call creates a return shipping label for the buyer to use. The shipping carrier, tracking number, and value are provided.

Input

The returnId parameter is required in the URI path to identify the return for which a return shipping label will be created. In the request payload, you must include the labelId value, which is the unique identifier of the return shipping label, and the value, which indicates the action being performed with this call. In this particular call sample, the seller is uploading a return shipping label, so the value provided in this field is . The carrierEnum and trackingNumber values should also be provided.

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

POST https://api.sandbox.ebay.com/post-order/v2/return/5********9/add_shipping_label
{ 
  "carrierEnum": "USPS",
  "comments":
  { 
    "content": "The shipping label you can use has been added to your return request.",
  },
  "labelId": "8******1",
  "trackingNumber": "9********************9",
  "labelAction": "UPLOAD_LABEL"
}

Output

The output fields are all returned with valid values, which confirms that the return shipping label was successfully sent to the buyer.

JSON format.
{ 
  "labelData": "B** B****, 2******************e, ********, CA 9***5, United States",
  "labelId": "8******1",
  "labelURL": "https://return.ebay.com/ws/eBayISAPI.dll?ResolveReturn&eventName=returnLabel&returnId=5********8",
  "trackingNumber": "9********************9"
}

Change History