stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§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
| Field | Value |
|---|---|
| Module | Logistics |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/logistics/batch_update_tpf_warehouse_tracking_status |
| Production URL | https://partner.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/logistics/batch_update_tpf_warehouse_tracking_status |
| Permission | ERP System; Seller In House System; Order Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| tpf_name | string | Yes | Shopee 3PF | The 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_status | string | Yes | 3pf_warehouse_outbound_done | The 3PF tracking status for the timestamp. All statuses are in lower case.; List of status: - 3pf_warehouse_order_created; - 3pf_warehouse_outbound_done |
| package_list | object[] | Yes | ||
| package_list.order_sn | string | Yes | 2003160SXK2A3T | Shopee's unique identifier for an order. |
| package_list.package_number | string | No | OFG38027870177402 | Shopee's unique identifier for the package under an order. |
| package_list.update_time | int64 | Yes | 1610000000 | This 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
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| 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. | ||
| request_id | string | e3e3e7f32b90e1a2b73dc8ca69586501 | The identifier for an API request for error tracking. | |
| response | object | |||
| response.success_list | object[] | Update success order list. | ||
| response.success_list.order_sn | string | 2003160SXK2A3T | Shopee's unique identifier for an order. | |
| response.success_list.package_number | string | OFG38027870177402 | Shopee's unique identifier for the package under an order. | |
| response.fail_list | object[] | Update fail order list. | ||
| response.fail_list.order_sn | string | 201214JASXYXY6 | Shopee's unique identifier for an order. | |
| response.fail_list.package_number | string | OFG134731496217591 | Shopee's unique identifier for the package under an order. | |
| response.fail_list.fail_error | string | common.error_server | Reason for failure. | |
| response.fail_list.fail_message | string | Something wrong. Please try later. | Reason for failure. |
§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 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×tamp=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×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 => '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×tamp=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×tamp=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
| 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 |
§15 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. |
§16 Update log
Update log
| Date | Change |
|---|---|
| 2025-04-08 | Supplemented the technical interface identification method of CB orders that fulfilled by 3PF Supplemented tpf_name Description |
| 2025-03-28 | Change object[] to object |
| 2025-01-13 | New API |
