快工助手跨境电商知识与商机助手

v2.logistics.get_tracking_info

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.logistics.get_tracking_info

Use this api to get the logistics tracking information of an order.

#

§2 Overview

Overview

FieldValue
ModuleLogistics
API typeShop
HTTP methodGET
Path/api/v2/logistics/get_tracking_info
Production URLhttps://partner.shopeemobile.com/api/v2/logistics/get_tracking_info
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/logistics/get_tracking_info
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Order Management; Customer Service; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
order_snstringYes2409177JCSRTEUShopee's unique identifier for an order.
package_numberstringNoShopee'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

NameTypeRequiredSampleDescription
request_idstringe3e3e7f33c4d75f91fb48ecb41aa2a01:010003d71ed9e184:00000066cec6b739The identifier for an API request for error tracking.
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
responseobjectDetail informations you are querying.
response.order_snstring2409177JCSRTEUShopee's unique identifier for an order.
response.package_numberstringShopee's unique identifier for the package under an order.
response.logistics_statusstringLOGISTICS_DELIVERY_FAILEDThe logistics status for the order. Applicable values: See Data Definition- LogisticsStatus.
response.tracking_infoobject[]The tracking info of the order.
response.tracking_info.update_timetimestamp1726561500The time when the logistics tracking info is updated.
response.tracking_info.descriptionstring包裹正退回物流中心The description of the logistics tracking info.
response.tracking_info.logistics_statusstringFAILED_DELIVEREDThe logistics status for the order. Applicable values: See Data Definition- LogisticsStatus.
response.tracking_info.return_codestring1234The 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_codestring562891[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_numberstringSG246907296501CUThe 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_namestringSPX ExpressThe 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_infoobject[]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_timeint641729842624The time when the reversed logistics tracking info is updated.
response.reversed_tracking_info.descriptionstring当地仓库已备货,包裹准备发运The description of the reversed logistics tracking info.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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&timestamp=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&timestamp=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&timestamp=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

ErrorDescriptionSolution
logistics.error_paramThe order is being allocated, please wait until the allocate is completed.
error_not_foundWrong parameters, detail: {msg}.
error_paramWrong parameters, detail: {msg}.
error_permissionSorry you don't have the permission, detail: {msg}.
error_serverSystem error. Please try again later.
logistics.invalid_errorThe order is not exist.
logistics.error_status_limitThe order status is invalid. Please check the order status.
logistics.package_not_existThe package is not exist.
common.invalid_shopShop id is invalid. Please check your shop.
logistics.package_number_not_existPlease request with package_number for this split order.
logistics.invalid_address_versionSome addresses are no longer supported per new regulation, please update to avoid wrong fulfilment
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
#

§16 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp 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_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe 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_suspendedThe API is offline. Please call v2 API instead.
error_limitThe 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_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour 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_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§17 Update log

Update log

DateChange
2026-05-29Add collection_pin_code response parameter
2026-04-24Add return_code response parameter under tracking_info
2025-08-14Add reversed_tracking_number, reversed_courier_name and reversed_tracking_info response parameters
2021-11-18add logistics_status response parameters
#