v2.logistics.get_tracking_number
GET /api/v2/logistics/get_tracking_number
After arranging shipment (v2.logistics.ship_order) for the integrated channel, use this api to get the tracking_number, which is a required parameter for creating shipping labels. The api response can return tracking_number empty, since this info is dependent from the 3PL, due to this it is allowed to keep calling the api within 5 minutes interval, until the tracking_number is returned.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/get_tracking_number
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| order_sn | string | True | 201214JASXYXY6 | Shopee's unique identifier for an order. |
| package_number | string | False | Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there isn't a package number. | |
| response_optional_fields | string | False | first_mile_tracking_number | Indicate response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them. Available values: plp_number, first_mile_tracking_number,last_mile_tracking_number |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | 9d07076ffda5407bb7c559f0b82ed91e | The identifier for an API request for error tracking. |
| error | string | error_auth | Indicate error type if hit error. Empty if no error happened. |
| message | string | Invalid access_token. | Indicate error details if hit error. Empty if no error happened. |
| response | object | Detail informations you are querying. | |
| tracking_number | string | MY200448706479IT | The tracking number of this order. |
| plp_number | string | The unique identifier for package of BR correios. | |
| first_mile_tracking_number | string | CNF877146678717210312 | The first mile tracking number of the order. Only for Cross Border Seller |
| last_mile_tracking_number | string | 200448706479IT | The last mile tracking number of the order. Only for Cross Border BR seller. |
| hint | string | Buyers CVS closed， waiting for buyer to reselect another CVS stores，auto cancel time 2021-01-01 | Indicate hint information if cannot get some fields under special scenarios. For example, cannot get tracking_number when cvs store is closed. |
| pickup_code | string | For drivers to quickly identify parcel to be picked up. Only returned for ID local orders who using instant+sameday for delivery. |