stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.logistics.get_tracking_info
Use this api to get the logistics tracking information of an order.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Logistics |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/logistics/get_tracking_info |
| Production URL | https://partner.shopeemobile.com/api/v2/logistics/get_tracking_info |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/logistics/get_tracking_info |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Order Management; Customer Service; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| order_sn | string | Yes | 2409177JCSRTEU | Shopee's unique identifier for an order. |
| package_number | string | No | Shopee's unique identifier for the package under an order. You shouldn't fill the field with empty string when there is a package number. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| request_id | string | e3e3e7f33c4d75f91fb48ecb41aa2a01:010003d71ed9e184:00000066cec6b739 | The identifier for an API request for error tracking. | |
| error | string | Indicate error type if hit error. Empty if no error happened. | ||
| message | string | Indicate error details if hit error. Empty if no error happened. | ||
| response | object | Detail informations you are querying. | ||
| response.order_sn | string | 2409177JCSRTEU | Shopee's unique identifier for an order. | |
| response.package_number | string | Shopee's unique identifier for the package under an order. | ||
| response.logistics_status | string | LOGISTICS_DELIVERY_FAILED | The logistics status for the order. Applicable values: See Data Definition- LogisticsStatus. | |
| response.tracking_info | object[] | The tracking info of the order. | ||
| response.tracking_info.update_time | timestamp | 1726561500 | The time when the logistics tracking info is updated. | |
| response.tracking_info.description | string | 包裹正退回物流中心 | The description of the logistics tracking info. | |
| response.tracking_info.logistics_status | string | FAILED_DELIVERED | The logistics status for the order. Applicable values: See Data Definition- LogisticsStatus. | |
| response.tracking_info.return_code | string | 1234 | The OTP generated after the parcel enters the RTS (Return to Seller) process. Sellers need to provide this OTP to the driver to complete the return confirmation.; Note: - This field only applies to orders under the SPX Instant & Sameday channel in ID region.; - This field is only returned when the driver has initiated the return process to the seller. If the driver has not initiated the return process for the parcel, this field will be empty. | |
| response.collection_pin_code | string | 562891 | [TW Only] The unique 6-digit PIN code for sellers to collect RTS (Return to Seller) parcels at service points. This field is returned when the channel is C2C and the logistics_status is FULFILMENT_DELIVERY_FAILED. | |
| response.reversed_tracking_number | string | SG246907296501CU | The tracking number of the reversed logistics.; Note: Only apply to the cross-border segment of failed delivery parcels returned from the local return warehouse to the seller. | |
| response.reversed_courier_name | string | SPX Express | The courier name of the reversed logistics.; Note: Only apply to the cross-border segment of failed delivery parcels returned from the local return warehouse to the seller. | |
| response.reversed_tracking_info | object[] | The tracking information of the reversed logistics.; Note: Only apply to the cross-border segment of failed delivery parcels returned from the local return warehouse to the seller. | ||
| response.reversed_tracking_info.update_time | int64 | 1729842624 | The time when the reversed logistics tracking info is updated. | |
| response.reversed_tracking_info.description | string | 当地仓库已备货,包裹准备发运 | The description of the reversed logistics tracking info. |
§5 Common parameters
Common parameters
| Name | Type | Required | 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 |
§6 Request samples
Request samples
§7 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/logistics/get_tracking_info?timestamp=timestamp&sign=sign&shop_id=shop_id&package_number=9000192023232&partner_id=partner_id&order_sn=201214JASXYXY6&access_token=access_token")
.asString();
§8 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/get_tracking_info?access_token=access_token&order_sn=201214JASXYXY6&package_number=9000192023232&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§9 cURL
cURL
curl --location --request GET 'https://partner.shopeemobile.com/api/v2/logistics/get_tracking_info?package_number=9000192023232&partner_id=partner_id&order_sn=201214JASXYXY6&access_token=access_token×tamp=timestamp&sign=sign&shop_id=shop_id'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/logistics/get_tracking_info?access_token=access_token&order_sn=201214JASXYXY6&package_number=9000192023232&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp"
payload={}
headers = {
}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§11 Response sample
Response sample
§12 JSON
JSON
{
"request_id": "e3e3e7f33c4d75f91fb48ecb41aa2a01:010003d71ed9e184:00000066cec6b739",
"error": "-",
"message": "-",
"response": {
"order_sn": "2409177JCSRTEU",
"package_number": "-",
"logistics_status": "LOGISTICS_DELIVERY_FAILED",
"tracking_info": [
{
"update_time": 1726561500,
"description": "包裹正退回物流中心",
"logistics_status": "FAILED_DELIVERED",
"return_code": "1234"
}
],
"collection_pin_code": "562891",
"reversed_tracking_number": "SG246907296501CU",
"reversed_courier_name": "SPX Express",
"reversed_tracking_info": [
{
"update_time": 1729842624,
"description": "当地仓库已备货,包裹准备发运"
}
]
}
}
§13 Error example
Error example
§14 JSON
JSON
{
"error": "logistics.invalid_error",
"message": "The order is not exist.",
"request_id": "7769bb40266b5cca105b345b0c04e2d4"
}
§15 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| logistics.error_param | The order is being allocated, please wait until the allocate is completed. | |
| error_not_found | Wrong parameters, detail: {msg}. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_permission | Sorry you don't have the permission, detail: {msg}. | |
| error_server | System error. Please try again later. | |
| logistics.invalid_error | The order is not exist. | |
| logistics.error_status_limit | The order status is invalid. Please check the order status. | |
| logistics.package_not_exist | The package is not exist. | |
| common.invalid_shop | Shop id is invalid. Please check your shop. | |
| logistics.package_number_not_exist | Please request with package_number for this split order. | |
| logistics.invalid_address_version | Some addresses are no longer supported per new regulation, please update to avoid wrong fulfilment | |
| error_network | Inner http call failed | |
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway |
§16 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| error_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| api_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00) | |
| error_rate_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api. | |
| error_api_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§17 Update log
Update log
| Date | Change |
|---|---|
| 2026-05-29 | Add collection_pin_code response parameter |
| 2026-04-24 | Add return_code response parameter under tracking_info |
| 2025-08-14 | Add reversed_tracking_number, reversed_courier_name and reversed_tracking_info response parameters |
| 2021-11-18 | add logistics_status response parameters |
