淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
tms_collect_request	TmsCollectRequest	可选			揽收参数
└ service_type String 必须 1 业务类型 └ mail_no String 可选 SF23434 运单号（运单号及包裹重量至少有一个） └ pic_url String 可选 https://img.alicdn.com/134 验视照片 └ biz_code String 必须 234234234 单据标识 └ length String 可选 12.34 包裹长度 (单位：cm)，小数点后2位 └ width String 可选 10.52 包裹宽度（单位：cm)，小数点后2位 └ service_flag String 可选 1 业务服务 └ weight String 可选 23.43 实际重量（取件称重重量），单位g ，小数点后2位 └ tms_cp_code String 可选 SF 资源编码 └ estimate_fee String 可选 23344 预估运费（单位：分） └ charged_weight String 可选 3434 计费重量，单位g，小数点后2位 └ height String 可选 23.34 包裹高度 (单位：cm)，小数点后2位 └ supplier_id String 可选 2342342342 服务商id └ delivery_code String 可选 STO 配资源编码 └ throwing_weight String 可选 23.34 计抛重量，单位g，小数点后2位。条件必填，计抛重量与包裹长宽高信息需要同时传入 feature TmsCollectFeatureDTO 可选扩展字段 └ sub_mail_no String 可选 23423242 子运单号 phone_call_infos TmsPhoneCallInfoDTO [] 可选电联列表电联信息 └ phone_call_operator_name String 可选张三电联人员名称（小件员） └ phone_call_operator_phone String 可选 12345678911 电联人员联系方式（小件员/官方号码） └ phone_call_consumer_phone String 可选 12345678911 消费者联系方式（消费者） └ phone_call_result_remark String 可选消费者电联需求描述消费者电联需求描述 └ connection_status String 可选 NOT _CONNECT NOT_CONNECT, 未拨通；CONNECTED，已接通； NOBODY_ANSWER，无人接听 └ call_time String 可选 2023-12-30 12:00:00 拨打时间，操作时间（YYYY-MM-DD HH:MM:SS） └ connect_time String 可选 2023-12-30 12:00:00 接通时间，操作时间（YYYY-MM-DD HH:MM:SS） └ hang_up_time String 可选 2023-12-30 12:00:00 挂断时间，操作时间（YYYY-MM-DD HH:MM:SS） └ connect_time_length Number 可选 10 接通时长, 单位s └ phone_call_type String 可选 NORMAL 电联属性，SMART 智能云呼；NORMAL, 普通 └ hang_up_type String 可选 CUSTOMER_HAND_UP 挂断状态，CUSTOMER_HAND_UP,消费者挂断；SENDER_HANG_UP,小件员挂断 OTHER，其他（无法识别） └ phone_chat_url String 可选 https://**.com 电联语音文件，用于客诉场景定责使用 extend_operate_infos TmsExtendOperateInfosDTO [] 可选其他作业信息明细 └ operate_type String 可选 UpdateAddress 操作类型（枚举）： UpdateAddress-服务商修改地址 └ operate_time String 可选 2023-12-30 12:00:00 操作时间(YYYY-MM-DD HH:MM:SS) └ operate_detail String 可选内容内容 └ weight_is_verified String 可选 1 0-未核实 1-已核实

名称	类型	示例值	描述
suc	Boolean	true	校验成功或者异常
biz_error_message	String	单据不存在	错误码描述
biz_error_code	String	10000	错误码标识
retry	Boolean	true	是否可重试
data	TmsCollectResponse		返回值
└ weight_check_result Boolean true 重量是否通过风控 └ weight String 234 风控通过重量 └ post_fee Number 123 总运费金额（单位：分) └ post_deduct_fee Number 123 运费险抵扣金额（单位：分)

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressCollectSyncRequest req = new LogisticsExpressCollectSyncRequest();
LogisticsExpressCollectSyncRequest.TmsCollectRequest obj1 = new LogisticsExpressCollectSyncRequest.TmsCollectRequest();
obj1.setServiceType("1");
obj1.setMailNo("SF23434");
obj1.setPicUrl("https://img.alicdn.com/134");
obj1.setBizCode("234234234");
obj1.setLength("12.34");
obj1.setWidth("10.52");
obj1.setServiceFlag("1");
obj1.setWeight("23.43");
obj1.setTmsCpCode("SF");
obj1.setEstimateFee("23344");
obj1.setChargedWeight("3434");
obj1.setHeight("23.34");
obj1.setSupplierId("2342342342");
obj1.setDeliveryCode("STO");
obj1.setThrowingWeight("23.34");
LogisticsExpressCollectSyncRequest.TmsCollectFeatureDTO obj2 = new LogisticsExpressCollectSyncRequest.TmsCollectFeatureDTO();
obj2.setSubMailNo("23423242");
obj1.setFeature(obj2);
List<LogisticsExpressCollectSyncRequest.TmsPhoneCallInfoDTO> list4 = new ArrayList<LogisticsExpressCollectSyncRequest.TmsPhoneCallInfoDTO>();
LogisticsExpressCollectSyncRequest.TmsPhoneCallInfoDTO obj5 = new LogisticsExpressCollectSyncRequest.TmsPhoneCallInfoDTO();
list4.add(obj5);
obj5.setPhoneCallOperatorName("张三");
obj5.setPhoneCallOperatorPhone("12345678911");
obj5.setPhoneCallConsumerPhone("12345678911");
obj5.setPhoneCallResultRemark("消费者电联需求描述");
obj5.setConnectionStatus("NOT _CONNECT");
obj5.setCallTime("2023-12-30 12:00:00");
obj5.setConnectTime("2023-12-30 12:00:00");
obj5.setHangUpTime("2023-12-30 12:00:00");
obj5.setConnectTimeLength(10L);
obj5.setPhoneCallType("NORMAL");
obj5.setHangUpType("CUSTOMER_HAND_UP");
obj5.setPhoneChatUrl("https://**.com");
obj1.setPhoneCallInfos(list4);
List<LogisticsExpressCollectSyncRequest.TmsExtendOperateInfosDTO> list7 = new ArrayList<LogisticsExpressCollectSyncRequest.TmsExtendOperateInfosDTO>();
LogisticsExpressCollectSyncRequest.TmsExtendOperateInfosDTO obj8 = new LogisticsExpressCollectSyncRequest.TmsExtendOperateInfosDTO();
list7.add(obj8);
obj8.setOperateType("UpdateAddress");
obj8.setOperateTime("2023-12-30 12:00:00");
obj8.setOperateDetail("内容");
obj1.setExtendOperateInfos(list7);
obj1.setWeightIsVerified("1");
req.setTmsCollectRequest(obj1);
LogisticsExpressCollectSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsExpressCollectSyncRequest req = new LogisticsExpressCollectSyncRequest();
LogisticsExpressCollectSyncRequest.TmsCollectRequestDomain obj1 = new LogisticsExpressCollectSyncRequest.TmsCollectRequestDomain();
obj1.ServiceType = "1";
obj1.MailNo = "SF23434";
obj1.PicUrl = "https://img.alicdn.com/134";
obj1.BizCode = "234234234";
obj1.Length = "12.34";
obj1.Width = "10.52";
obj1.ServiceFlag = "1";
obj1.Weight = "23.43";
obj1.TmsCpCode = "SF";
obj1.EstimateFee = "23344";
obj1.ChargedWeight = "3434";
obj1.Height = "23.34";
obj1.SupplierId = "2342342342";
obj1.DeliveryCode = "STO";
obj1.ThrowingWeight = "23.34";
LogisticsExpressCollectSyncRequest.TmsCollectFeatureDTODomain obj2 = new LogisticsExpressCollectSyncRequest.TmsCollectFeatureDTODomain();
obj2.SubMailNo = "23423242";
obj1.Feature= obj2;
List<LogisticsExpressCollectSyncRequest.TmsPhoneCallInfoDTODomain> list4 = new List<LogisticsExpressCollectSyncRequest.TmsPhoneCallInfoDTODomain>();
LogisticsExpressCollectSyncRequest.TmsPhoneCallInfoDTODomain obj5 = new LogisticsExpressCollectSyncRequest.TmsPhoneCallInfoDTODomain();
list4.Add(obj5);
obj5.PhoneCallOperatorName = "张三";
obj5.PhoneCallOperatorPhone = "12345678911";
obj5.PhoneCallConsumerPhone = "12345678911";
obj5.PhoneCallResultRemark = "消费者电联需求描述";
obj5.ConnectionStatus = "NOT _CONNECT";
obj5.CallTime = "2023-12-30 12:00:00";
obj5.ConnectTime = "2023-12-30 12:00:00";
obj5.HangUpTime = "2023-12-30 12:00:00";
obj5.ConnectTimeLength = 10L;
obj5.PhoneCallType = "NORMAL";
obj5.HangUpType = "CUSTOMER_HAND_UP";
obj5.PhoneChatUrl = "https://**.com";
obj1.PhoneCallInfos= list4;
List<LogisticsExpressCollectSyncRequest.TmsExtendOperateInfosDTODomain> list7 = new List<LogisticsExpressCollectSyncRequest.TmsExtendOperateInfosDTODomain>();
LogisticsExpressCollectSyncRequest.TmsExtendOperateInfosDTODomain obj8 = new LogisticsExpressCollectSyncRequest.TmsExtendOperateInfosDTODomain();
list7.Add(obj8);
obj8.OperateType = "UpdateAddress";
obj8.OperateTime = "2023-12-30 12:00:00";
obj8.OperateDetail = "内容";
obj1.ExtendOperateInfos= list7;
obj1.WeightIsVerified = "1";
req.TmsCollectRequest_ = obj1;
LogisticsExpressCollectSyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsExpressCollectSyncRequest;
$tms_collect_request = new TmsCollectRequest;
$tms_collect_request->service_type="1";
$tms_collect_request->mail_no="SF23434";
$tms_collect_request->pic_url="https://img.alicdn.com/134";
$tms_collect_request->biz_code="234234234";
$tms_collect_request->length="12.34";
$tms_collect_request->width="10.52";
$tms_collect_request->service_flag="1";
$tms_collect_request->weight="23.43";
$tms_collect_request->tms_cp_code="SF";
$tms_collect_request->estimate_fee="23344";
$tms_collect_request->charged_weight="3434";
$tms_collect_request->height="23.34";
$tms_collect_request->supplier_id="2342342342";
$tms_collect_request->delivery_code="STO";
$tms_collect_request->throwing_weight="23.34";
$feature = new TmsCollectFeatureDTO;
$feature->sub_mail_no="23423242";
$tms_collect_request->feature = $feature;
$phone_call_infos = new TmsPhoneCallInfoDTO;
$phone_call_infos->phone_call_operator_name="张三";
$phone_call_infos->phone_call_operator_phone="12345678911";
$phone_call_infos->phone_call_consumer_phone="12345678911";
$phone_call_infos->phone_call_result_remark="消费者电联需求描述";
$phone_call_infos->connection_status="NOT _CONNECT";
$phone_call_infos->call_time="2023-12-30 12:00:00";
$phone_call_infos->connect_time="2023-12-30 12:00:00";
$phone_call_infos->hang_up_time="2023-12-30 12:00:00";
$phone_call_infos->connect_time_length="10";
$phone_call_infos->phone_call_type="NORMAL";
$phone_call_infos->hang_up_type="CUSTOMER_HAND_UP";
$phone_call_infos->phone_chat_url="https://**.com";
$tms_collect_request->phone_call_infos = $phone_call_infos;
$extend_operate_infos = new TmsExtendOperateInfosDTO;
$extend_operate_infos->operate_type="UpdateAddress";
$extend_operate_infos->operate_time="2023-12-30 12:00:00";
$extend_operate_infos->operate_detail="内容";
$tms_collect_request->extend_operate_infos = $extend_operate_infos;
$tms_collect_request->weight_is_verified="1";
$req->setTmsCollectRequest(json_encode($tms_collect_request));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.logistics.express.collect.sync' \
-d 'partner_id=apidoc' \
-d 'sign=63C138C5BE76105A03A597B438D5B9FB' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+16%3A20%3A22' \
-d 'v=2.0' \
-d 'tms_collect_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.LogisticsExpressCollectSyncRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.tms_collect_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.logistics.express.collect.sync");
add_param(pRequest,"tms_collect_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.logistics.express.collect.sync', {
	'tms_collect_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_express_collect_sync_response>
    <suc>true</suc>
    <biz_error_message>单据不存在</biz_error_message>
    <biz_error_code>10000</biz_error_code>
    <retry>true</retry>
    <data>
        <weight_check_result>true</weight_check_result>
        <weight>234</weight>
        <post_fee>123</post_fee>
        <post_deduct_fee>123</post_deduct_fee>
    </data>
</logistics_express_collect_sync_response>

{
    "logistics_express_collect_sync_response":{
        "suc":true,
        "biz_error_message":"单据不存在",
        "biz_error_code":"10000",
        "retry":true,
        "data":{
            "weight_check_result":true,
            "weight":"234",
            "post_fee":123,
            "post_deduct_fee":123
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

淘天物流API

taobao.logistics.express.collect.sync (服饰逆向揽收信息同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ