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

v2.logistics.get_tracking_number

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_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.

#

§2 Overview

Overview

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

§3 Request parameters

Request parameters

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

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
request_idstring9d07076ffda5407bb7c559f0b82ed91eThe identifier for an API request for error tracking.
errorstringerror_authIndicate error type if hit error. Empty if no error happened.
messagestringInvalid access_token.Indicate error details if hit error. Empty if no error happened.
responseobjectDetail informations you are querying.
response.tracking_numberstringMY200448706479ITThe tracking number of this order.
response.plp_numberstringThe unique identifier for package of BR correios.
response.first_mile_tracking_numberstringCNF877146678717210312The first mile tracking number of the order. Only for Cross Border Seller
response.last_mile_tracking_numberstring200448706479ITThe last mile tracking number of the order. Only for Cross Border BR seller.
response.hintstringBuyers CVS closed, waiting for buyer to reselect another CVS stores,auto cancel time 2021-01-01Indicate hint information if cannot get some fields under special scenarios. For example, cannot get tracking_number when cvs store is closed.
response.pickup_codestringFor drivers to quickly identify parcel to be picked up. Only returned for ID local orders who using instant+sameday for delivery.
#

§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_number?partner_id=partner_id&order_sn=201214JASXYXY6&access_token=access_token&timestamp=timestamp&sign=sign&response_optional_fields=first_mile_tracking_number&shop_id=shop_id&package_number=-")
.asString();
#

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/get_tracking_number?access_token=access_token&order_sn=201214JASXYXY6&package_number=-&partner_id=partner_id&response_optional_fields=first_mile_tracking_number&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_number?package_number=-&partner_id=partner_id&order_sn=201214JASXYXY6&access_token=access_token&timestamp=timestamp&sign=sign&response_optional_fields=first_mile_tracking_number&shop_id=shop_id' 
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/logistics/get_tracking_number?access_token=access_token&order_sn=201214JASXYXY6&package_number=-&partner_id=partner_id&response_optional_fields=first_mile_tracking_number&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

{
    "error": "",
    "message": "",
    "response": {
        "tracking_number": "MY200448706479IT",
        "first_mile_tracking_number": "CNF877146678717210312"
    },
    "request_id": "9d07076ffda5407bb7c559f0b82ed91e"
}
#

§13 Error example

Error example

#

§14 JSON

JSON

{
    "error": "logistics.invalid_error",
    "message": "The order is not exist.",
    "request_id": "2524f1aa00d84e7eba5a4d46d5e04791"
}
#

§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.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
2021-06-15add hint field to response
2021-03-30ADD PLP NUMBER
#