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

v2.logistics.batch_update_tpf_warehouse_tracking_status

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

For CB orders that fulfilled by 3PF, support 3PF Warehouse Vendors to update the tpf_tracking_status when 3PF warehouse receive the order and complete the outbound of the package. CB orders that fulfilled by 3PF: v2.shop.get_shop_info - shop_fulfillment_flag in {Pure - 3PF Shop,PFF - 3PF Shop,LFF Hybrid Shop} And v2.order.get_order_detail - fulfillment_flag = fulfilled_by_local_seller

#

§2 Overview

Overview

FieldValue
ModuleLogistics
API typeShop
HTTP methodPOST
Path/api/v2/logistics/batch_update_tpf_warehouse_tracking_status
Production URLhttps://partner.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status
PermissionERP System; Seller In House System; Order Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
tpf_namestringYesShopee 3PFThe name of 3PF Warehouse Vendor. Prohibit pure numbers and excessive abbreviations. Standardize naming for easy business recognition. Input priority: warehouse English name > full pinyin of warehouse brand name > warehouse Chinese name > other officially recognized and prominent names.
tpf_tracking_statusstringYes3pf_warehouse_outbound_doneThe 3PF tracking status for the timestamp. All statuses are in lower case.; List of status: - 3pf_warehouse_order_created; - 3pf_warehouse_outbound_done
package_listobject[]Yes
package_list.order_snstringYes2003160SXK2A3TShopee's unique identifier for an order.
package_list.package_numberstringNoOFG38027870177402Shopee's unique identifier for the package under an order.
package_list.update_timeint64Yes1610000000This is to indicate timestamp of the 3PF tracking status.; Timestamp should be within order create time and order pick up by 3PL time.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
request_idstringe3e3e7f32b90e1a2b73dc8ca69586501The identifier for an API request for error tracking.
responseobject
response.success_listobject[]Update success order list.
response.success_list.order_snstring2003160SXK2A3TShopee's unique identifier for an order.
response.success_list.package_numberstringOFG38027870177402Shopee's unique identifier for the package under an order.
response.fail_listobject[]Update fail order list.
response.fail_list.order_snstring201214JASXYXY6Shopee's unique identifier for an order.
response.fail_list.package_numberstringOFG134731496217591Shopee's unique identifier for the package under an order.
response.fail_list.fail_errorstringcommon.error_serverReason for failure.
response.fail_list.fail_messagestringSomething wrong. Please try later.Reason for failure.
#

§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 Payload

Payload

{
	"tpf_name": "Shopee 3PF",
	"tpf_tracking_status": "3pf_warehouse_outbound_done",
	"package_list": [
		{
			"order_sn": "2003160SXK2A3T",
			"package_number": "OFG38027870177402",
			"update_time": 1610000000
		},
		{
			"order_sn": "201214JASXYXY6",
			"package_number": "OFG134731496217591",
			"update_time": 1610000000
		}
	]
}
#

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"package_list\": [
      {
         \"order_sn\": \"2003160SXK2A3T\",
         \"package_number\": \"OFG38027870177402\",
         \"update_time\": 1610000000
      },
      {
         \"order_sn\": \"201214JASXYXY6\",
         \"package_number\": \"OFG134731496217591\",
         \"update_time\": 1610000000
      }
   ],
   \"tpf_name\": \"Shopee 3PF\",
   \"tpf_tracking_status\": \"3pf_warehouse_outbound_done\"
}")
.asString();
#

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status?access_token=access_token&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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "package_list": [
        {
            "order_sn": "2003160SXK2A3T",
            "package_number": "OFG38027870177402",
            "update_time": 1610000000
        },
        {
            "order_sn": "201214JASXYXY6",
            "package_number": "OFG134731496217591",
            "update_time": 1610000000
        }
    ],
    "tpf_name": "Shopee 3PF",
    "tpf_tracking_status": "3pf_warehouse_outbound_done"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§10 cURL

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "package_list": [
      {
         "order_sn": "2003160SXK2A3T",
         "package_number": "OFG38027870177402",
         "update_time": 1610000000
      },
      {
         "order_sn": "201214JASXYXY6",
         "package_number": "OFG134731496217591",
         "update_time": 1610000000
      }
   ],
   "tpf_name": "Shopee 3PF",
   "tpf_tracking_status": "3pf_warehouse_outbound_done"
}'
#

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "package_list": [
    {
      "order_sn": "2003160SXK2A3T",
      "package_number": "OFG38027870177402",
      "update_time": 1610000000
    },
    {
      "order_sn": "201214JASXYXY6",
      "package_number": "OFG134731496217591",
      "update_time": 1610000000
    }
  ],
  "tpf_name": "Shopee 3PF",
  "tpf_tracking_status": "3pf_warehouse_outbound_done"
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§12 Response sample

Response sample

#

§13 JSON

JSON

{
	"request_id": "e3e3e7f32b90e1a2b73dc8ca69586501",
	"error": "-",
	"message": "success",
	"response": [
		{
			"success_list": [
				{
					"order_sn": "2003160SXK2A3T",
					"package_number": "OFG38027870177402"
				}
			],
			"fail_list": [
				{
					"order_sn": "201214JASXYXY6",
					"package_number": "OFG134731496217591",
					"fail_error": "common.error_server",
					"fail_message": "Something wrong. Please try later."
				}
			]
		}
	]
}
#

§14 Errors

Errors

ErrorDescriptionSolution
logistics.invalid_address_versionSome addresses are no longer supported per new regulation, please update to avoid wrong fulfilment
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
#

§15 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.
#

§16 Update log

Update log

DateChange
2025-04-08Supplemented the technical interface identification method of CB orders that fulfilled by 3PF Supplemented tpf_name Description
2025-03-28Change object[] to object
2025-01-13New API
#