淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
volume	Number	可选	1000000		体积单位立方毫米
weight	Number	可选	111111		重量单位克
comment	String	可选	消费者不在家，所以取消		备注说明
express_code	String	可选	SF11232222		物流单号（展示给消费者）
express_company	String	可选	顺丰快递		物流公司名词（展示给消费者）
courier_mobile	String	可选	13455655544		小件员手机号码
courier_name	String	可选	测试小件员		小件员姓名
got_code	String	可选	2333		取件码
logistics_order_id	Number	必须	222233333		物流订单号
cost	Number	可选	22		金额单位分
goods_info	String	可选	[{ "name": "上衣", "count": 1 }, { "name": "裤子", "count": 2 }]		1、以下状态时必填：包裹已揽收完成 2、字符串格式为：json 串例子： [{ "name": "上衣", "count": 1 }, { "name": "裤子", "count": 2 }]
status_code	String	必须	create		物流创建：create 物流取消：cancel 分派小件员：assign 已经分派小件员: assigned 包裹上门揽收: pickup_door 包裹已揽收完成: pickup_finished 包裹派送中: dispatching 包裹已签收: signed
sub_express_codes	String []	可选	2233332222	最大列表长度：999	物流子单号
delivery_time	Date	可选	2020-02-26 17:15:28		预计送达时间 dispatching节点时必填
sign_time	Date	可选	2020-02-26 17:15:28		签收时间 signed节点时必填
pickup_finish_time	Date	可选	2020-02-26 17:15:28		揽收完成时间 pickup_finished节点时必填
pickup_door_time	Date	可选	2020-02-26 17:15:28		上门揽收时间 pickup_door节点时必填
new_logistics	Boolean	可选	true		是否更新新物流数据
extend_info	String	可选	{"key":"value"}		扩展属性

名称	类型	示例值	描述
result	FulfilplatformResult	result	系统自动生成
└ display_msg String 更新失败错误描述信息 └ msg_code String 12233 错误码 └ success Boolean false true 成功 false 失败

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallServicecenterWorkcardLogisticsorderUpdateRequest req = new TmallServicecenterWorkcardLogisticsorderUpdateRequest();
req.setVolume(1000000L);
req.setWeight(111111L);
req.setComment("消费者不在家，所以取消");
req.setExpressCode("SF11232222");
req.setExpressCompany("顺丰快递");
req.setCourierMobile("13455655544");
req.setCourierName("测试小件员");
req.setGotCode("2333");
req.setLogisticsOrderId(222233333L);
req.setCost(22L);
req.setGoodsInfo("[{ \"name\": \"上衣\", \"count\": 1 }, { \"name\": \"裤子\", \"count\": 2 }]");
req.setStatusCode("create");
req.setSubExpressCodes("2233332222");
req.setDeliveryTime(StringUtils.parseDateTime("2020-02-26 17:15:28"));
req.setSignTime(StringUtils.parseDateTime("2020-02-26 17:15:28"));
req.setPickupFinishTime(StringUtils.parseDateTime("2020-02-26 17:15:28"));
req.setPickupDoorTime(StringUtils.parseDateTime("2020-02-26 17:15:28"));
req.setNewLogistics(true);
req.setExtendInfo("{\"key\":\"value\"}");
TmallServicecenterWorkcardLogisticsorderUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallServicecenterWorkcardLogisticsorderUpdateRequest req = new TmallServicecenterWorkcardLogisticsorderUpdateRequest();
req.Volume = 1000000L;
req.Weight = 111111L;
req.Comment = "消费者不在家，所以取消";
req.ExpressCode = "SF11232222";
req.ExpressCompany = "顺丰快递";
req.CourierMobile = "13455655544";
req.CourierName = "测试小件员";
req.GotCode = "2333";
req.LogisticsOrderId = 222233333L;
req.Cost = 22L;
req.GoodsInfo = "[{ \"name\": \"上衣\", \"count\": 1 }, { \"name\": \"裤子\", \"count\": 2 }]";
req.StatusCode = "create";
req.SubExpressCodes = "2233332222";
req.DeliveryTime = DateTime.Parse("2020-02-26 17:15:28");
req.SignTime = DateTime.Parse("2020-02-26 17:15:28");
req.PickupFinishTime = DateTime.Parse("2020-02-26 17:15:28");
req.PickupDoorTime = DateTime.Parse("2020-02-26 17:15:28");
req.NewLogistics = true;
req.ExtendInfo = "{\"key\":\"value\"}";
TmallServicecenterWorkcardLogisticsorderUpdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallServicecenterWorkcardLogisticsorderUpdateRequest;
$req->setVolume("1000000");
$req->setWeight("111111");
$req->setComment("消费者不在家，所以取消");
$req->setExpressCode("SF11232222");
$req->setExpressCompany("顺丰快递");
$req->setCourierMobile("13455655544");
$req->setCourierName("测试小件员");
$req->setGotCode("2333");
$req->setLogisticsOrderId("222233333");
$req->setCost("22");
$req->setGoodsInfo("[{ \"name\": \"上衣\", \"count\": 1 }, { \"name\": \"裤子\", \"count\": 2 }]");
$req->setStatusCode("create");
$req->setSubExpressCodes("2233332222");
$req->setDeliveryTime("2020-02-26 17:15:28");
$req->setSignTime("2020-02-26 17:15:28");
$req->setPickupFinishTime("2020-02-26 17:15:28");
$req->setPickupDoorTime("2020-02-26 17:15:28");
$req->setNewLogistics("true");
$req->setExtendInfo("{\"key\":\"value\"}");
$resp = $c->execute($req, $sessionKey);

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=tmall.servicecenter.workcard.logisticsorder.update' \
-d 'partner_id=apidoc' \
-d 'session=4ef83c56-de73-4e73-9244-bf928a6c5abf' \
-d 'sign=CBA41790C2178548B3F0E30D1F00FC0E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A40%3A42' \
-d 'v=2.0' \
-d 'comment=%E6%B6%88%E8%B4%B9%E8%80%85%E4%B8%8D%E5%9C%A8%E5%AE%B6%EF%BC%8C%E6%89%80%E4%BB%A5%E5%8F%96%E6%B6%88' \
-d 'cost=22' \
-d 'courier_mobile=13455655544' \
-d 'courier_name=%E6%B5%8B%E8%AF%95%E5%B0%8F%E4%BB%B6%E5%91%98' \
-d 'delivery_time=2020-02-26+17%3A15%3A28' \
-d 'express_code=SF11232222' \
-d 'express_company=%E9%A1%BA%E4%B8%B0%E5%BF%AB%E9%80%92' \
-d 'extend_info=%7B%5C%22key%5C%22%3A%5C%22value%5C%22%7D' \
-d 'goods_info=%7B+%22name%22%3A+%22%E4%B8%8A%E8%A1%A3%22%2C+%22count%22%3A+1+%7D%2C+%7B+%22name%22%3A+%22%E8%A3%A4%E5%AD%90%22%2C+%22count%22%3A+2+%7D' \
-d 'got_code=2333' \
-d 'logistics_order_id=222233333' \
-d 'new_logistics=true' \
-d 'pickup_door_time=2020-02-26+17%3A15%3A28' \
-d 'pickup_finish_time=2020-02-26+17%3A15%3A28' \
-d 'sign_time=2020-02-26+17%3A15%3A28' \
-d 'status_code=create' \
-d 'sub_express_codes=2233332222' \
-d 'volume=1000000' \
-d 'weight=111111'

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

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

req.volume=1000000
req.weight=111111
req.comment="消费者不在家，所以取消"
req.express_code="SF11232222"
req.express_company="顺丰快递"
req.courier_mobile="13455655544"
req.courier_name="测试小件员"
req.got_code="2333"
req.logistics_order_id=222233333
req.cost=22
req.goods_info="[{ \"name\": \"上衣\", \"count\": 1 }, { \"name\": \"裤子\", \"count\": 2 }]"
req.status_code="create"
req.sub_express_codes="2233332222"
req.delivery_time="2020-02-26 17:15:28"
req.sign_time="2020-02-26 17:15:28"
req.pickup_finish_time="2020-02-26 17:15:28"
req.pickup_door_time="2020-02-26 17:15:28"
req.new_logistics=true
req.extend_info="{\"key\":\"value\"}"
try:
	resp= req.getResponse(sessionkey)
	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,"tmall.servicecenter.workcard.logisticsorder.update");
add_param(pRequest,"volume","1000000");
add_param(pRequest,"weight","111111");
add_param(pRequest,"comment","消费者不在家，所以取消");
add_param(pRequest,"express_code","SF11232222");
add_param(pRequest,"express_company","顺丰快递");
add_param(pRequest,"courier_mobile","13455655544");
add_param(pRequest,"courier_name","测试小件员");
add_param(pRequest,"got_code","2333");
add_param(pRequest,"logistics_order_id","222233333");
add_param(pRequest,"cost","22");
add_param(pRequest,"goods_info","{ "name": "上衣", "count": 1 }, { "name": "裤子", "count": 2 }");
add_param(pRequest,"status_code","create");
add_param(pRequest,"sub_express_codes","2233332222");
add_param(pRequest,"delivery_time","2020-02-26 17:15:28");
add_param(pRequest,"sign_time","2020-02-26 17:15:28");
add_param(pRequest,"pickup_finish_time","2020-02-26 17:15:28");
add_param(pRequest,"pickup_door_time","2020-02-26 17:15:28");
add_param(pRequest,"new_logistics","true");
add_param(pRequest,"extend_info","{\"key\":\"value\"}");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('tmall.servicecenter.workcard.logisticsorder.update', {
	'volume':'1000000',
	'weight':'111111',
	'comment':'消费者不在家，所以取消',
	'express_code':'SF11232222',
	'express_company':'顺丰快递',
	'courier_mobile':'13455655544',
	'courier_name':'测试小件员',
	'got_code':'2333',
	'logistics_order_id':'222233333',
	'cost':'22',
	'goods_info':'{ "name": "上衣", "count": 1 }, { "name": "裤子", "count": 2 }',
	'status_code':'create',
	'sub_express_codes':'2233332222',
	'delivery_time':'2020-02-26 17:15:28',
	'sign_time':'2020-02-26 17:15:28',
	'pickup_finish_time':'2020-02-26 17:15:28',
	'pickup_door_time':'2020-02-26 17:15:28',
	'new_logistics':'true',
	'extend_info':'{\"key\":\"value\"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_servicecenter_workcard_logisticsorder_update_response>
    <result>
        <display_msg>更新失败</display_msg>
        <msg_code>12233</msg_code>
        <success>false</success>
    </result>
</tmall_servicecenter_workcard_logisticsorder_update_response>

{
    "tmall_servicecenter_workcard_logisticsorder_update_response":{
        "result":{
            "display_msg":"更新失败",
            "msg_code":"12233",
            "success":false
        }
    }
}

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下载

开放平台

天猫服务平台

tmall.servicecenter.workcard.logisticsorder.update (物流工单履约状态更新)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ