GET/tracking
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve tracking event details for a package associated with the provided tracking number.
Each tracking event is returned in the trackingDetails array and includes the description, location, time, and status of the event.
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_number | string | This query parameter specifies the tracking number for which to retrieve current tracking event details. This value is returned when creating a package through the createPackage method. 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 |
|---|---|---|
| trackingDetails | array of GetTrackingDetailResponsesData | This array returns a list of tracking event details for the specified tracking number. Occurrence: Always |
| trackingDetails.city | string | The city code in which the tracking event occurred. Occurrence: Always |
| trackingDetails.country | string | The two-letter ISO 3166 country code where the tracking event occurred. Occurrence: Always |
| trackingDetails.descriptionEn | string | The English description of the tracking event. Occurrence: Always |
| trackingDetails.descriptionZh | string | The Chinese description of the tracking event. Occurrence: Always |
| trackingDetails.district | string | The district code where the tracking event occurred. Occurrence: Always |
| trackingDetails.eventPostalCode | string | The postal code of where the tracking event occurred. Occurrence: Always |
| trackingDetails.eventTime | string | This timestamp the time and date the tracking event occurred. Occurrence: Always |
| trackingDetails.province | string | The province code where the tracking event occurred. Occurrence: Always |
| trackingDetails.status | string | The status of the shipment. Occurrence: Always |
| trackingDetails.trackingNumber | string | The tracking number specified in the request. 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. |
| 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 tracking event status of a package
This method can be used to retrieve the tracking event status of a package based on a provided tracking number.
Input
The tracking numbers of the packages for which to tracking event status updates are specified through the tracking_number query parameter.
GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/tracking?tracking_number=E**********N
Output
If the call is successful, tracking event status updates will be returned in the response.
In this sample, you can see each tracking event associated with the specified tracking number.