GET/handover_sheet
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve the handover sheet for one or more packages in a pickup request.
The tracking numbers for the packages for which to retrieve handover sheets are specified through the tracking_numbers query parameter.
The retrieved handover sheet will be returned as a base64 string value, and can be used for confirmation with a pickup contact. Only one handover sheet will be returned for the specified packages.
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 for the packages for which to retrieve a handover sheet. 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 |
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 |
|---|---|---|
| handoverSheet | GetHandoverSheetResponsesData | This container returns the base64 string value for a handover sheet. Occurrence: Always |
| handoverSheet.base64Str | string | The base 64 string value for a handover sheet. This string can be converted to a PDF file once it has been 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. |
| 355067 | API_EDIS | REQUEST | The field tracking_numbers is required. |
| 355068 | API_EDIS | REQUEST | The specified tracking number {tracking_number} is not recognized. Please check and try again. |
| 355400 | API_EDIS | REQUEST | The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list. |
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 the handover sheet for an pickup request order
This method retrieves a handover sheet for a pickup request based on the specified tracking number for the packages in the request.
Input
The tracking numbers of the packages in the pickup order for which to retrieve a handover sheet are specified through the tracking_numbers query parameter.
GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/handover_sheet?tracking_numbers=E***********************N
Output
If the call is successful, the base64 string value for the handover sheet will be returned in the handoverSheet container.
Note: In this sample, the base64 string has been significantly shorted for space. A typical base64Str response will be much longer.