GET/labels
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve shipping labels for the one or more specified packages.
The packages for which to retrieve shipping labels can be specified through the tracking_numbers query parameter. The page size and print preference settings for the shipping label(s) can also be specified through the query parameters.
Shipping labels are returned as base64 string values which can be converted to PDF files. A separate file will be returned for each tracking number specified in the request.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| tracking_numbers | array of string | This query parameter specifies an array of tracking numbers of the packages for which to retrieve shipping labels. Tracking numbers are returned when creating packages through the createPackage method. Up to 200 tracking numbers can be provided. Multiple tracking numbers can be input as individual query parameters.For example, tracking_numbers=E***********************N&tracking_numbers=E***********************Q Occurrence: Required |
| page_size | string | This query parameter specifies the page size of the retrieved shipping labels. Valid values:
Occurrence: Optional |
| print_preference | string | This query parameter specifies one or more printing preferences to be set when retrieving shipping labels. Multiple values can be delimited by a comma. Valid values:
Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
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/scope/sell.edelivery
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| labels | array of GetLabelListResponsesData | This array returns the shipping label information, such as the base64 string value and result code for each specified tracking number. Occurrence: Always |
| labels.base64Str | string | The base 64 string value for a shipping label. Occurrence: Always |
| labels.message | string | A message relating to the status of the shipping label retrieval process. Occurrence: Always |
| labels.resultCode | string | The result code detailing the results of the shipping label retrieval process. Occurrence: Always |
| labels.trackingNumber | string | The tracking number for which the shipping label is being retrieved. Occurrence: Always |
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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 355000 | API_EDIS | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 355004 | API_EDIS | REQUEST | The specified tracking number {tracking_number} is not recognized. Please check and try again. |
| 355067 | API_EDIS | REQUEST | The field tracking_numbers is required. |
| 355071 | API_EDIS | REQUEST | The specified tracking number {tracking_number} does not belong to the seller, so cannot be retrieved. |
| 355077 | API_EDIS | REQUEST | Invalid input value for page setting parameters. Please revise it. |
Warnings
This call has no warnings.
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: Retrieve shipping labels
This method retrieves shipping labels for the specified packages.
Input
The tracking numbers of the packages for which to retrieve shipping labels are specified through the tracking_numbers query parameter. Additionally, the page size and print preferences for the retrieved shipping labels can be specified through the page_size and print_preference query parameters.
GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/labels?tracking_numbers=E*************************N&page_size=A4&print_preference=nameZh,nameEn
Output
If the call is successful, the base64 string value for each shipping label will be returned in the labels container. The associated tracking number for each label will also be returned.
Note: In this sample, the base64 string has been significantly shorted for space. A typical base64Str response will be much longer.