logistics APIv1_beta.0.0

downloadLabelFile

GET
/shipment/{shipmentId}/download_label_file
This method returns the shipping label file that was generated for the shipmentId value specified in the request. Call createFromShippingQuote to generate a shipment ID.

Use the Accept HTTP header to specify the format of the returned file. The default file format is a PDF file.

Input

Resource URI (production)

GET https://api.ebay.com/sell/logistics/v1_beta/shipment/{shipmentId}/download_label_file

URI parameters

ParameterTypeDescription
shipmentIdstringThis path parameter specifies the unique eBay-assigned ID of the shipment associated with the shipping label you want to download. The shipmentId value is generated and returned by a call to createFromShippingQuote.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.logistics

See OAuth access tokens for more information.

Output

HTTP response headers

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
90000API_LOGISTICSAPPLICATIONA system error has occurred.
90005API_LOGISTICSREQUESTThe resource could not be found.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Download a shipping label

When you create a shipment with createFromShippingLabel, a pre-paid shipping label is created that you can use to ship the package via the selected shipping carrier. Use this method to download the printing label for your shipment. Note that you can also download the label using the URL returned in the response body of your createFromShippingLabel call.

Input

Supply the shippingQuoteId as a path parameter in your request.
GET
https://api.ebay.com/sell/logistics/v1_beta/shipment/SHIPMENT-001/download_label_file

Output

A successful call returns an HTTP status code of 200 OK and the label is downloaded to your system.