v2.logistics.get_booking_tracking_info

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

来自 Shopee 官方资料快照 · 2026-09-06 12:12:54

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.logistics.get_booking_tracking_info

Use this api to get the logistics tracking information of a booking.

§2 Overview

Overview

Field	Value
Module	Logistics
API type	Shop
HTTP method	GET
Path	/api/v2/logistics/get_booking_tracking_info
Production URL	https://partner.shopeemobile.com/api/v2/logistics/get_booking_tracking_info
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/logistics/get_booking_tracking_info
Permission	ERP System; Seller In House System; Order Management; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
booking_sn	string	Yes	201201E81SYYKE	Shopee's unique identifier for a booking.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
request_id	string	862fc4d77de74edf9bf045c7650f1988	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.
response.booking_sn	string	201214JASXYXY6	Shopee's unique identifier for a booking.
response.logistics_status	string	LOGISTICS_REQUEST_CREATED	The Shopee logistics status for the booking. Applicable values.; LOGISTICS_REQUEST_CREATED:booking arranged shipment; LOGISTICS_PICKUP_DONE:booking handed over to 3PL; LOGISTICS_PICKUP_FAILED:booking cancelled by 3PL due to failed pickup or picked up but not able to proceed with delivery; LOGISTICS_DELIVERY_DONE:successfully delivered; LOGISTICS_REQUEST_CANCELED:cancelled when booking at LOGISTICS_REQUEST_CREATED; LOGISTICS_READY:booking ready for fulfilment; LOGISTICS_INVALID:cancelled when booking at LOGISTICS_READY; LOGISTICS_LOST:booking cancelled due to 3PL lost the parcel
response.tracking_info	object[]		The tracking info of the booking.
response.tracking_info.update_time	timestamp	1587375600	The time when logistics info has been updated.
response.tracking_info.description	string	Your parcel is ready to ship from the seller	The description of booking logistics tracking info.logistics_status
response.tracking_info.logistics_status	string	PICKED_UP	The Shopee logistics status for the booking.; TrackingLogisticsStatus: INITIAL; ORDER_INIT; ORDER_SUBMITTED; ORDER_CREATED; PICKUP_REQUESTED; PICKUP_PENDING; PICKED_UP; DELIVERY_PENDING; DELIVERED; LOST; UPDATE; UPDATE_SUBMITTED; UPDATE_CREATED; RETURN_STARTED; RETURN_PENDING; CANCEL; CANCEL_CREATED; CANCELED; FAILED_ORDER_SUBMITTED; FAILED_ORDER_CREATED; FAILED_PICKUP_REQUESTED; FAILED_PICKED_UP; FAILED_DELIVERED; FAILED_UPDATE_SUBMITTED; FAILED_UPDATE_CREATED; FAILED_RETURNED; FAILED_CANCEL_CREATED; FAILED_CANCELED; RETURNED; RETURN_INTIATED

§5 Common parameters

Common 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

§6 Request samples

Request samples

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.uat.shopeemobile.com/api/v2/logistics/get_booking_tracking_info?access_token=access_token&booking_sn=201201E81SYYKE&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.uat.shopeemobile.com/api/v2/logistics/get_booking_tracking_info?access_token=access_token&booking_sn=201201E81SYYKE&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.uat.shopeemobile.com/api/v2/logistics/get_booking_tracking_info?access_token=access_token&booking_sn=201201E81SYYKE&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://partner.uat.shopeemobile.com/api/v2/logistics/get_booking_tracking_info?access_token=access_token&booking_sn=201201E81SYYKE&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"request_id": "862fc4d77de74edf9bf045c7650f1988",
	"error": "error_auth",
	"message": "Invalid access_token.",
	"response": {
		"booking_sn": "201214JASXYXY6",
		"logistics_status": "LOGISTICS_REQUEST_CREATED",
		"tracking_info": [
			{
				"update_time": 1587375600,
				"description": "Your parcel is ready to ship from the seller",
				"logistics_status": "PICKED_UP"
			}
		]
	}
}

§13 Errors

Errors

Error	Description	Solution
logistics.invalid_address_version	Some addresses are no longer supported per new regulation, please update to avoid wrong fulfilment
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

§14 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.

§15 Update log

Update log

Date	Change
2024-07-16	New API

这条内容对你有帮助吗？