阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	描述
deliverer_id	String	可选	83	盒马配送员id
provider_id	String	可选	13	外部配送员id
out_deliverer_id	String	可选	209	配送商id（盒马提供，暂时取配送商表id）
batch_id	String	必须	3193617711749	盒马小票上的批次号

名称	类型	示例值	描述
result	String	{"batchId":"20182000117154218","retCode":"0000","retMsg":"成功","waybills":[{"deliverFee":100,"latestArriveTime":1516176738000,"poiLngLat":"120.028888,30.27888","receiver":"归义","receiverAddress":"阿里巴巴西溪园区一号楼3楼","receiverPhone":"18621298620","stockOut":false,"storeId":"33571004","waybillCode":"DT340003","waybillSkus":[{"actualQuantity":1.0,"actualSellQuantity":1.0,"comboSkuCode":"combine_guiyi_test","frangibility":1,"quantity":5.0,"sellQuantity":5.0,"sellUnit":"箱","skuBarcode":"ba0010","skuCode":"0010","skuName":"归义测试0010","spuUnit":"箱","temperatureRequirement":1,"totalWeight":200.0,"waybillSkuId":"6253"},{"actualQuantity":5.0,"actualSellQuantity":5.0,"comboSkuCode":"combine_guiyi_test","frangibility":1,"quantity":5.0,"sellQuantity":5.0,"sellUnit":"箱","skuBarcode":"ba0011","skuCode":"0011","skuName":"归义测试0011","spuUnit":"箱","temperatureRequirement":1,"totalWeight":200.0,"waybillSkuId":"6254"},{"actualQuantity":3.0,"actualSellQuantity":3.0,"frangibility":1,"quantity":5.0,"sellQuantity":5.0,"sellUnit":"箱","skuBarcode":"ba0012","skuCode":"0012","skuName":"归义测试0012","spuUnit":"箱","temperatureRequirement":1,"totalWeight":200.0,"waybillSkuId":"6255"},{"actualQuantity":5.0,"actualSellQuantity":5.0,"frangibility":1,"quantity":5.0,"sellQuantity":5.0,"sellUnit":"箱","skuBarcode":"ba0013","skuCode":"0013","skuName":"归义测试0013","spuUnit":"箱","temperatureRequirement":1,"totalWeight":200.0,"waybillSkuId":"6256"}]}]}	result

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
WdktmsWaybillShipbatchRequest req = new WdktmsWaybillShipbatchRequest();
req.setDelivererId("83");
req.setProviderId("13");
req.setOutDelivererId("209");
req.setBatchId("3193617711749");
WdktmsWaybillShipbatchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
WdktmsWaybillShipbatchRequest req = new WdktmsWaybillShipbatchRequest();
req.DelivererId = "83";
req.ProviderId = "13";
req.OutDelivererId = "209";
req.BatchId = "3193617711749";
WdktmsWaybillShipbatchResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new WdktmsWaybillShipbatchRequest;
$req->setDelivererId("83");
$req->setProviderId("13");
$req->setOutDelivererId("209");
$req->setBatchId("3193617711749");
$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=taobao.wdktms.waybill.shipbatch' \
-d 'partner_id=apidoc' \
-d 'session=bb2a1514-e5fc-49dc-a191-ea7d63f02ac6' \
-d 'sign=B855B9DA017D5AA03F1A4856D977B7E0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+21%3A38%3A22' \
-d 'v=2.0' \
-d 'batch_id=3193617711749' \
-d 'deliverer_id=83' \
-d 'out_deliverer_id=209' \
-d 'provider_id=13'

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

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

req.deliverer_id="83"
req.provider_id="13"
req.out_deliverer_id="209"
req.batch_id="3193617711749"
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,"taobao.wdktms.waybill.shipbatch");
add_param(pRequest,"deliverer_id","83");
add_param(pRequest,"provider_id","13");
add_param(pRequest,"out_deliverer_id","209");
add_param(pRequest,"batch_id","3193617711749");
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('taobao.wdktms.waybill.shipbatch', {
	'deliverer_id':'83',
	'provider_id':'13',
	'out_deliverer_id':'209',
	'batch_id':'3193617711749'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<wdktms_waybill_shipbatch_response>
    <result>{&quot;batchId&quot;:&quot;20182000117154218&quot;,&quot;retCode&quot;:&quot;0000&quot;,&quot;retMsg&quot;:&quot;成功&quot;,&quot;waybills&quot;:[{&quot;deliverFee&quot;:100,&quot;latestArriveTime&quot;:1516176738000,&quot;poiLngLat&quot;:&quot;120.028888,30.27888&quot;,&quot;receiver&quot;:&quot;归义&quot;,&quot;receiverAddress&quot;:&quot;阿里巴巴西溪园区一号楼3楼&quot;,&quot;receiverPhone&quot;:&quot;18621298620&quot;,&quot;stockOut&quot;:false,&quot;storeId&quot;:&quot;33571004&quot;,&quot;waybillCode&quot;:&quot;DT340003&quot;,&quot;waybillSkus&quot;:[{&quot;actualQuantity&quot;:1.0,&quot;actualSellQuantity&quot;:1.0,&quot;comboSkuCode&quot;:&quot;combine_guiyi_test&quot;,&quot;frangibility&quot;:1,&quot;quantity&quot;:5.0,&quot;sellQuantity&quot;:5.0,&quot;sellUnit&quot;:&quot;箱&quot;,&quot;skuBarcode&quot;:&quot;ba0010&quot;,&quot;skuCode&quot;:&quot;0010&quot;,&quot;skuName&quot;:&quot;归义测试0010&quot;,&quot;spuUnit&quot;:&quot;箱&quot;,&quot;temperatureRequirement&quot;:1,&quot;totalWeight&quot;:200.0,&quot;waybillSkuId&quot;:&quot;6253&quot;},{&quot;actualQuantity&quot;:5.0,&quot;actualSellQuantity&quot;:5.0,&quot;comboSkuCode&quot;:&quot;combine_guiyi_test&quot;,&quot;frangibility&quot;:1,&quot;quantity&quot;:5.0,&quot;sellQuantity&quot;:5.0,&quot;sellUnit&quot;:&quot;箱&quot;,&quot;skuBarcode&quot;:&quot;ba0011&quot;,&quot;skuCode&quot;:&quot;0011&quot;,&quot;skuName&quot;:&quot;归义测试0011&quot;,&quot;spuUnit&quot;:&quot;箱&quot;,&quot;temperatureRequirement&quot;:1,&quot;totalWeight&quot;:200.0,&quot;waybillSkuId&quot;:&quot;6254&quot;},{&quot;actualQuantity&quot;:3.0,&quot;actualSellQuantity&quot;:3.0,&quot;frangibility&quot;:1,&quot;quantity&quot;:5.0,&quot;sellQuantity&quot;:5.0,&quot;sellUnit&quot;:&quot;箱&quot;,&quot;skuBarcode&quot;:&quot;ba0012&quot;,&quot;skuCode&quot;:&quot;0012&quot;,&quot;skuName&quot;:&quot;归义测试0012&quot;,&quot;spuUnit&quot;:&quot;箱&quot;,&quot;temperatureRequirement&quot;:1,&quot;totalWeight&quot;:200.0,&quot;waybillSkuId&quot;:&quot;6255&quot;},{&quot;actualQuantity&quot;:5.0,&quot;actualSellQuantity&quot;:5.0,&quot;frangibility&quot;:1,&quot;quantity&quot;:5.0,&quot;sellQuantity&quot;:5.0,&quot;sellUnit&quot;:&quot;箱&quot;,&quot;skuBarcode&quot;:&quot;ba0013&quot;,&quot;skuCode&quot;:&quot;0013&quot;,&quot;skuName&quot;:&quot;归义测试0013&quot;,&quot;spuUnit&quot;:&quot;箱&quot;,&quot;temperatureRequirement&quot;:1,&quot;totalWeight&quot;:200.0,&quot;waybillSkuId&quot;:&quot;6256&quot;}]}]}</result>
</wdktms_waybill_shipbatch_response>

{
    "wdktms_waybill_shipbatch_response":{
        "result":"{\"batchId\":\"20182000117154218\",\"retCode\":\"0000\",\"retMsg\":\"成功\",\"waybills\":[{\"deliverFee\":100,\"latestArriveTime\":1516176738000,\"poiLngLat\":\"120.028888,30.27888\",\"receiver\":\"归义\",\"receiverAddress\":\"阿里巴巴西溪园区一号楼3楼\",\"receiverPhone\":\"18621298620\",\"stockOut\":false,\"storeId\":\"33571004\",\"waybillCode\":\"DT340003\",\"waybillSkus\":[{\"actualQuantity\":1.0,\"actualSellQuantity\":1.0,\"comboSkuCode\":\"combine_guiyi_test\",\"frangibility\":1,\"quantity\":5.0,\"sellQuantity\":5.0,\"sellUnit\":\"箱\",\"skuBarcode\":\"ba0010\",\"skuCode\":\"0010\",\"skuName\":\"归义测试0010\",\"spuUnit\":\"箱\",\"temperatureRequirement\":1,\"totalWeight\":200.0,\"waybillSkuId\":\"6253\"},{\"actualQuantity\":5.0,\"actualSellQuantity\":5.0,\"comboSkuCode\":\"combine_guiyi_test\",\"frangibility\":1,\"quantity\":5.0,\"sellQuantity\":5.0,\"sellUnit\":\"箱\",\"skuBarcode\":\"ba0011\",\"skuCode\":\"0011\",\"skuName\":\"归义测试0011\",\"spuUnit\":\"箱\",\"temperatureRequirement\":1,\"totalWeight\":200.0,\"waybillSkuId\":\"6254\"},{\"actualQuantity\":3.0,\"actualSellQuantity\":3.0,\"frangibility\":1,\"quantity\":5.0,\"sellQuantity\":5.0,\"sellUnit\":\"箱\",\"skuBarcode\":\"ba0012\",\"skuCode\":\"0012\",\"skuName\":\"归义测试0012\",\"spuUnit\":\"箱\",\"temperatureRequirement\":1,\"totalWeight\":200.0,\"waybillSkuId\":\"6255\"},{\"actualQuantity\":5.0,\"actualSellQuantity\":5.0,\"frangibility\":1,\"quantity\":5.0,\"sellQuantity\":5.0,\"sellUnit\":\"箱\",\"skuBarcode\":\"ba0013\",\"skuCode\":\"0013\",\"skuName\":\"归义测试0013\",\"spuUnit\":\"箱\",\"temperatureRequirement\":1,\"totalWeight\":200.0,\"waybillSkuId\":\"6256\"}]}]}"
    }
}

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.wdktms.waybill.shipbatch (配送员揽收)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈