eBay Post-Order APIVersion 2

Check Shipping Label Eligibility

GET /post-order/v2/return/{returnId}/check_label_print_eligibility

Use this call to determine if a valid shipping label is ready to be printed and used.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/return/{returnId}/check_label_print_eligibility

URI parameters

Parameter Type Required? Meaning
returnId string Required The unique identifier of the return. The returnId value is required to identify the return for which the shipping label is being verified.


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

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

{ /* CheckLabelPrintEligibilityResponse */
"printLabelValid": boolean
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
printLabelValid boolean Always This boolean field will be returned as 'true' if the shipping label is available to be downloaded and printed.



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: Check Label Print Readiness

Determine if a return shipping label is ready to use.

Description

This operation determines if a valid shipping label is ready to be sent to the buyer, to use for the specified return.

Input

The returnId parameter is required to identify the return to which the label applies. This call has no request payload.

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

GET https://api.ebay.com/post-order/v2/return/5000116809/check_label_print_eligibility

Output

The boolean printLabelValid field is true, indicating that the seller can post the shipping label for the buyer to use.

JSON format.
{ 
  "printLabelValid": true
}



Change History

Change Date Description