eBay Post-Order APIVersion 2.7.3
 

Void Shipping Label

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

This method is used on behalf of the seller to void the current return shipping label.

Input

See also Samples.

Resource URI (production)

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

URI parameters

Parameter Type Required? Meaning
returnId string Required The unique eBay-assigned ID of the return request. The returnId value is required as part of the call URI to identify the return request for which a shipping label is being voided.


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.

{ /* VoidLabelRequest */
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    },
"labelId": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
comments Text Optional This container can be used to write any applicable comments about voiding the shipping label.
comments.content string Conditional This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
comments.language string Conditional This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.

The full list of language enumeration values are defined in the LanguageEnum type definition.

Applicable values: See LanguageEnum
comments.translatedFromContent string Conditional If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
comments
  .translatedFromLanguage
string Conditional If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.

The full list of language enumeration values are defined in the LanguageEnum type definition.

Applicable values: See LanguageEnum
labelId string Required The unique eBay-assigned ID of the shipping label that is to be voided.

Output

See also Samples.

Payload model

This call has no response payload.

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: Void a Shipping Label

Make a shipping label unusable by the buyer.

Description

Use this operation to void the specified shipping label so the buyer cannot use it. This might be necessary because the label is no longer needed.

Input

The returnId parameter is required to identify the return to which the label applies. To identify the shipping label to be voided, include in the request the labelId field that was previously returned by the POST /post-order/v2/return/{returnId}/add_shipping_label call.

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

POST https://api.ebay.com/post-order/v2/return/5********9/void_shipping_label
{ 
  "labelId": "8******1",
  "comments":
  { 
    "content": "This shipping label is now void."
  }
}

Output

A successful call returns an HTTP code of 200; there is no payload in the response.

JSON format.



Change History

Change Date Description