淘宝开放平台 - 文档中心

请求地址：

环境	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_to_msc_update_order_request	Tms2MscUpdateOrderRequest	可选			tms更新参数
└ service_type String 必须 1 业务类型 └ supplier_id String 必须 111 淘天物流服务商ID └ service_date String 可选 2023-02-20 修改后的上门日期（YYYY-MM-DD） └ request_type String 必须 1 请求类型 └ biz_code String 必须 111111 唯一标识单号 └ reason String 必须 DUPLICATE_ORDER 修改上门时间原因 └ service_time_range String 可选 09:00-11:00 修改后的上门时间段（HH:MM-HH:MM） └ deliver_code String 可选 001 配资源编码 phone_call_infos TmsPhoneCallInfoDTO [] 可选 list 电联信息（组） └ 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,小件员挂断 └ phone_chat_url String 可选 http://ssss.xxxx.com/xxx.mp3 电联语音文件，用于客诉场景定责使用。 └ connect_time String 可选 2023-06-01 02:00:03 接通时间，操作时间（YYYY-MM-DD HH:MM:SS） └ phone_call_result_remark String 可选更换上门时间为10-11点消费者电联需求描述 └ connection_status String 可选 NOT _CONNECT 通话状态（枚举） └ phone_call_operator_phone String 可选 12345678910 电联人员联系方式（小件员/官方号码） └ phone_call_consumer_phone String 可选 12345678910 消费者联系方式（消费者） └ call_time String 可选 2023-06-01 02:00:00 拨打时间，操作时间（YYYY-MM-DD HH:MM:SS） └ phone_call_operator_name String 可选小二电联人员名称（小件员） └ hang_up_time String 可选 2023-06-01 02:01:00 挂断时间，操作时间（YYYY-MM-DD HH:MM:SS） └ delivery_code String 可选 001 配资源编码

名称	类型	示例值	描述
suc	Boolean	true	系统成功失败
biz_error_message	String	单据不存在	响应信息
biz_error_code	String	10000	响应码
retry	Boolean	true	是否可重试

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressOrderTmsUpdateRequest req = new LogisticsExpressOrderTmsUpdateRequest();
LogisticsExpressOrderTmsUpdateRequest.Tms2MscUpdateOrderRequest obj1 = new LogisticsExpressOrderTmsUpdateRequest.Tms2MscUpdateOrderRequest();
obj1.setServiceType("1");
obj1.setSupplierId("111");
obj1.setServiceDate("2023-02-20");
obj1.setRequestType("1");
obj1.setBizCode("111111");
obj1.setReason("DUPLICATE_ORDER");
obj1.setServiceTimeRange("09:00-11:00");
obj1.setDeliverCode("001");
List<LogisticsExpressOrderTmsUpdateRequest.TmsPhoneCallInfoDTO> list3 = new ArrayList<LogisticsExpressOrderTmsUpdateRequest.TmsPhoneCallInfoDTO>();
LogisticsExpressOrderTmsUpdateRequest.TmsPhoneCallInfoDTO obj4 = new LogisticsExpressOrderTmsUpdateRequest.TmsPhoneCallInfoDTO();
list3.add(obj4);
obj4.setConnectTimeLength(10L);
obj4.setPhoneCallType("NORMAL");
obj4.setHangUpType("CUSTOMER_HAND_UP");
obj4.setPhoneChatUrl("http://ssss.xxxx.com/xxx.mp3");
obj4.setConnectTime("2023-06-01 02:00:03");
obj4.setPhoneCallResultRemark("更换上门时间为10-11点");
obj4.setConnectionStatus("NOT _CONNECT");
obj4.setPhoneCallOperatorPhone("12345678910");
obj4.setPhoneCallConsumerPhone("12345678910");
obj4.setCallTime("2023-06-01 02:00:00");
obj4.setPhoneCallOperatorName("小二");
obj4.setHangUpTime("2023-06-01 02:01:00");
obj1.setPhoneCallInfos(list3);
obj1.setDeliveryCode("001");
req.setTmsToMscUpdateOrderRequest(obj1);
LogisticsExpressOrderTmsUpdateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsExpressOrderTmsUpdateRequest req = new LogisticsExpressOrderTmsUpdateRequest();
LogisticsExpressOrderTmsUpdateRequest.Tms2MscUpdateOrderRequestDomain obj1 = new LogisticsExpressOrderTmsUpdateRequest.Tms2MscUpdateOrderRequestDomain();
obj1.ServiceType = "1";
obj1.SupplierId = "111";
obj1.ServiceDate = "2023-02-20";
obj1.RequestType = "1";
obj1.BizCode = "111111";
obj1.Reason = "DUPLICATE_ORDER";
obj1.ServiceTimeRange = "09:00-11:00";
obj1.DeliverCode = "001";
List<LogisticsExpressOrderTmsUpdateRequest.TmsPhoneCallInfoDTODomain> list3 = new List<LogisticsExpressOrderTmsUpdateRequest.TmsPhoneCallInfoDTODomain>();
LogisticsExpressOrderTmsUpdateRequest.TmsPhoneCallInfoDTODomain obj4 = new LogisticsExpressOrderTmsUpdateRequest.TmsPhoneCallInfoDTODomain();
list3.Add(obj4);
obj4.ConnectTimeLength = 10L;
obj4.PhoneCallType = "NORMAL";
obj4.HangUpType = "CUSTOMER_HAND_UP";
obj4.PhoneChatUrl = "http://ssss.xxxx.com/xxx.mp3";
obj4.ConnectTime = "2023-06-01 02:00:03";
obj4.PhoneCallResultRemark = "更换上门时间为10-11点";
obj4.ConnectionStatus = "NOT _CONNECT";
obj4.PhoneCallOperatorPhone = "12345678910";
obj4.PhoneCallConsumerPhone = "12345678910";
obj4.CallTime = "2023-06-01 02:00:00";
obj4.PhoneCallOperatorName = "小二";
obj4.HangUpTime = "2023-06-01 02:01:00";
obj1.PhoneCallInfos= list3;
obj1.DeliveryCode = "001";
req.TmsToMscUpdateOrderRequest_ = obj1;
LogisticsExpressOrderTmsUpdateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsExpressOrderTmsUpdateRequest;
$tms_to_msc_update_order_request = new Tms2MscUpdateOrderRequest;
$tms_to_msc_update_order_request->service_type="1";
$tms_to_msc_update_order_request->supplier_id="111";
$tms_to_msc_update_order_request->service_date="2023-02-20";
$tms_to_msc_update_order_request->request_type="1";
$tms_to_msc_update_order_request->biz_code="111111";
$tms_to_msc_update_order_request->reason="DUPLICATE_ORDER";
$tms_to_msc_update_order_request->service_time_range="09:00-11:00";
$tms_to_msc_update_order_request->deliver_code="001";
$phone_call_infos = new TmsPhoneCallInfoDTO;
$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="http://ssss.xxxx.com/xxx.mp3";
$phone_call_infos->connect_time="2023-06-01 02:00:03";
$phone_call_infos->phone_call_result_remark="更换上门时间为10-11点";
$phone_call_infos->connection_status="NOT _CONNECT";
$phone_call_infos->phone_call_operator_phone="12345678910";
$phone_call_infos->phone_call_consumer_phone="12345678910";
$phone_call_infos->call_time="2023-06-01 02:00:00";
$phone_call_infos->phone_call_operator_name="小二";
$phone_call_infos->hang_up_time="2023-06-01 02:01:00";
$tms_to_msc_update_order_request->phone_call_infos = $phone_call_infos;
$tms_to_msc_update_order_request->delivery_code="001";
$req->setTmsToMscUpdateOrderRequest(json_encode($tms_to_msc_update_order_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.order.tms.update' \
-d 'partner_id=apidoc' \
-d 'sign=F60E30E861D120C2D69CD5B64419A009' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-13+19%3A34%3A38' \
-d 'v=2.0' \
-d 'tms_to_msc_update_order_request=null'

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

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

req.tms_to_msc_update_order_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.order.tms.update");
add_param(pRequest,"tms_to_msc_update_order_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.order.tms.update', {
	'tms_to_msc_update_order_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<logistics_express_order_tms_update_response>
    <suc>true</suc>
    <biz_error_message>单据不存在</biz_error_message>
    <biz_error_code>10000</biz_error_code>
    <retry>true</retry>
</logistics_express_order_tms_update_response>

{
    "logistics_express_order_tms_update_response":{
        "suc":true,
        "biz_error_message":"单据不存在",
        "biz_error_code":"10000",
        "retry":true
    }
}

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.order.tms.update (服务商修改上门取退时间接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ