淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
monthly_bill_sync_request	TmsMonthlyBillSyncRequest	必须			请求
└ supplier_id String 必须 100000167 淘天物流服务商ID └ delivery_code String 必须 SF 服务商配资源唯一编码 └ id String 必须 12312321 唯一id └ mail_no String 必须 SF1312312 运单号码 └ customer_code String 必须 1231231 子公司卡号 └ logistics_object_type String 可选托寄物托寄物内容 └ logistics_object_num String 可选 1 托寄物数量 └ volume String 可选 33.22 体积（两位小数） └ length String 可选 44.3333 长（四位小数） └ width String 可选 44.3333 宽（四位小数） └ height String 可选 44.3333 高（四位小数） └ actual_weight String 可选 44.3333 实际重量（四位小数） └ account_weight String 可选 44.3333 计费重量（四位小数） └ spe_light_weight String 可选 44.3333 个性化轻抛重量（四位小数） receiver_info ContacterRequest 可选收件人，始发地 └ province String 可选浙江省 └ city String 可选杭州市 └ district String 可选余杭区区 └ street String 可选五常街道街道 └ area_id String 可选 12321 区id，三级地址id └ address String 可选文一西路969号详细地址 sender_info ContacterRequest 可选寄件人，目的地 └ province String 可选浙江省 └ city String 可选杭州市 └ district String 可选余杭区区 └ street String 可选五常街道街道 └ area_id String 可选 12321 区id，三级地址id └ address String 可选文一西路969号详细地址 └ claim_price String 可选 3344 声明价值 └ product_type String 可选 1 产品类型 └ type_name String 必须快递费用费用模块 └ fee_item String 可选 323232 增值费用 └ fee String 可选 3232.32 费用(元) └ discount String 可选 3232.32 折扣/促销 └ payable_amount String 可选 3232.32 应付金额 └ business_date String 可选 2023-12-12 日期 └ deduction_date String 可选 2023-12-12 抵减日 └ original_fee String 可选 3232.32 运单原运费 └ deduction_fee String 可选 3232.32 抵减运费 └ deduction_monthly_fee String 可选 3232.32 抵减月结运费 └ extend_props String 可选 {} 拓展属性

名称	类型	示例值	描述
result	ResultWrapper		结果
└ success Boolean true\|false 系统成功失败 └ error_code String 10001 错误码 └ error_desc String 系统错误错误信息 └ retry Boolean true\|false 是否可重试

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressBillSyncRequest req = new LogisticsExpressBillSyncRequest();
LogisticsExpressBillSyncRequest.TmsMonthlyBillSyncRequest obj1 = new LogisticsExpressBillSyncRequest.TmsMonthlyBillSyncRequest();
obj1.setSupplierId("100000167");
obj1.setDeliveryCode("SF");
obj1.setId("12312321");
obj1.setMailNo("SF1312312");
obj1.setCustomerCode("1231231");
obj1.setLogisticsObjectType("托寄物");
obj1.setLogisticsObjectNum("1");
obj1.setVolume("33.22");
obj1.setLength("44.3333");
obj1.setWidth("44.3333");
obj1.setHeight("44.3333");
obj1.setActualWeight("44.3333");
obj1.setAccountWeight("44.3333");
obj1.setSpeLightWeight("44.3333");
LogisticsExpressBillSyncRequest.ContacterRequest obj2 = new LogisticsExpressBillSyncRequest.ContacterRequest();
obj2.setProvince("浙江");
obj2.setCity("杭州");
obj2.setDistrict("余杭区");
obj2.setStreet("五常街道");
obj2.setAreaId("12321");
obj2.setAddress("文一西路969号");
obj1.setReceiverInfo(obj2);
LogisticsExpressBillSyncRequest.ContacterRequest obj3 = new LogisticsExpressBillSyncRequest.ContacterRequest();
obj3.setProvince("浙江");
obj3.setCity("杭州");
obj3.setDistrict("余杭区");
obj3.setStreet("五常街道");
obj3.setAreaId("12321");
obj3.setAddress("文一西路969号");
obj1.setSenderInfo(obj3);
obj1.setClaimPrice("3344");
obj1.setProductType("1");
obj1.setTypeName("快递费用");
obj1.setFeeItem("323232");
obj1.setFee("3232.32");
obj1.setDiscount("3232.32");
obj1.setPayableAmount("3232.32");
obj1.setBusinessDate("2023-12-12");
obj1.setDeductionDate("2023-12-12");
obj1.setOriginalFee("3232.32");
obj1.setDeductionFee("3232.32");
obj1.setDeductionMonthlyFee("3232.32");
obj1.setExtendProps("{}");
req.setMonthlyBillSyncRequest(obj1);
LogisticsExpressBillSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsExpressBillSyncRequest req = new LogisticsExpressBillSyncRequest();
LogisticsExpressBillSyncRequest.TmsMonthlyBillSyncRequestDomain obj1 = new LogisticsExpressBillSyncRequest.TmsMonthlyBillSyncRequestDomain();
obj1.SupplierId = "100000167";
obj1.DeliveryCode = "SF";
obj1.Id = "12312321";
obj1.MailNo = "SF1312312";
obj1.CustomerCode = "1231231";
obj1.LogisticsObjectType = "托寄物";
obj1.LogisticsObjectNum = "1";
obj1.Volume = "33.22";
obj1.Length = "44.3333";
obj1.Width = "44.3333";
obj1.Height = "44.3333";
obj1.ActualWeight = "44.3333";
obj1.AccountWeight = "44.3333";
obj1.SpeLightWeight = "44.3333";
LogisticsExpressBillSyncRequest.ContacterRequestDomain obj2 = new LogisticsExpressBillSyncRequest.ContacterRequestDomain();
obj2.Province = "浙江";
obj2.City = "杭州";
obj2.District = "余杭区";
obj2.Street = "五常街道";
obj2.AreaId = "12321";
obj2.Address = "文一西路969号";
obj1.ReceiverInfo= obj2;
LogisticsExpressBillSyncRequest.ContacterRequestDomain obj3 = new LogisticsExpressBillSyncRequest.ContacterRequestDomain();
obj3.Province = "浙江";
obj3.City = "杭州";
obj3.District = "余杭区";
obj3.Street = "五常街道";
obj3.AreaId = "12321";
obj3.Address = "文一西路969号";
obj1.SenderInfo= obj3;
obj1.ClaimPrice = "3344";
obj1.ProductType = "1";
obj1.TypeName = "快递费用";
obj1.FeeItem = "323232";
obj1.Fee = "3232.32";
obj1.Discount = "3232.32";
obj1.PayableAmount = "3232.32";
obj1.BusinessDate = "2023-12-12";
obj1.DeductionDate = "2023-12-12";
obj1.OriginalFee = "3232.32";
obj1.DeductionFee = "3232.32";
obj1.DeductionMonthlyFee = "3232.32";
obj1.ExtendProps = "{}";
req.MonthlyBillSyncRequest_ = obj1;
LogisticsExpressBillSyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LogisticsExpressBillSyncRequest;
$monthly_bill_sync_request = new TmsMonthlyBillSyncRequest;
$monthly_bill_sync_request->supplier_id="100000167";
$monthly_bill_sync_request->delivery_code="SF";
$monthly_bill_sync_request->id="12312321";
$monthly_bill_sync_request->mail_no="SF1312312";
$monthly_bill_sync_request->customer_code="1231231";
$monthly_bill_sync_request->logistics_object_type="托寄物";
$monthly_bill_sync_request->logistics_object_num="1";
$monthly_bill_sync_request->volume="33.22";
$monthly_bill_sync_request->length="44.3333";
$monthly_bill_sync_request->width="44.3333";
$monthly_bill_sync_request->height="44.3333";
$monthly_bill_sync_request->actual_weight="44.3333";
$monthly_bill_sync_request->account_weight="44.3333";
$monthly_bill_sync_request->spe_light_weight="44.3333";
$receiver_info = new ContacterRequest;
$receiver_info->province="浙江";
$receiver_info->city="杭州";
$receiver_info->district="余杭区";
$receiver_info->street="五常街道";
$receiver_info->area_id="12321";
$receiver_info->address="文一西路969号";
$monthly_bill_sync_request->receiver_info = $receiver_info;
$sender_info = new ContacterRequest;
$sender_info->province="浙江";
$sender_info->city="杭州";
$sender_info->district="余杭区";
$sender_info->street="五常街道";
$sender_info->area_id="12321";
$sender_info->address="文一西路969号";
$monthly_bill_sync_request->sender_info = $sender_info;
$monthly_bill_sync_request->claim_price="3344";
$monthly_bill_sync_request->product_type="1";
$monthly_bill_sync_request->type_name="快递费用";
$monthly_bill_sync_request->fee_item="323232";
$monthly_bill_sync_request->fee="3232.32";
$monthly_bill_sync_request->discount="3232.32";
$monthly_bill_sync_request->payable_amount="3232.32";
$monthly_bill_sync_request->business_date="2023-12-12";
$monthly_bill_sync_request->deduction_date="2023-12-12";
$monthly_bill_sync_request->original_fee="3232.32";
$monthly_bill_sync_request->deduction_fee="3232.32";
$monthly_bill_sync_request->deduction_monthly_fee="3232.32";
$monthly_bill_sync_request->extend_props="{}";
$req->setMonthlyBillSyncRequest(json_encode($monthly_bill_sync_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.bill.sync' \
-d 'partner_id=apidoc' \
-d 'sign=86215013E18185B3142B567201CD45A9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-13+22%3A00%3A30' \
-d 'v=2.0' \
-d 'monthly_bill_sync_request=null'

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

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

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

XML示例
JSON示例

<logistics_express_bill_sync_response>
    <result>
        <success>true|false</success>
        <error_code>10001</error_code>
        <error_desc>系统错误</error_desc>
        <retry>true|false</retry>
    </result>
</logistics_express_bill_sync_response>

{
    "logistics_express_bill_sync_response":{
        "result":{
            "success":true|false,
            "error_code":"10001",
            "error_desc":"系统错误",
            "retry":true|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下载

开放平台

淘天物流API

taobao.logistics.express.bill.sync (配送公司月度账单同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ