淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
ledger	Ledger	可选			总账
└ dc_code String 可选 51 盒马分配给DC的组织编码 ledger_items LedgerItem [] 可选总账明细 └ record_count Number 可选 51 每种业务单据类型的商品行计数 └ total_count Number 可选 1 每种业务单据类型的单号计数，如果是库存日报，则是1 └ type Number 可选 1 业务单据类型，0：库存日报；1：采购入库；2：退仓入库；3：调入；4：配货出库；5：退供出库；6：调出；7：批发出库；8：移库；9：库存调整 └ merchant_code String 可选 HM 盒马平台定义的商家编码 └ occur_date String 可选 2017-3-28 发生日期 └ page_size Number 可选 100 每页记录数 └ current_page Number 可选 1 当前第几页 └ total_page Number 可选 10 总页数 └ total_items Number 可选 1000 items总记录数

名称	类型	示例值	描述
result	WdkResult	wdkResult	业务处理结果
└ result_code String success 结果码 └ result_message String 成功结果码中文描述 └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
WdkLedgerSyncRequest req = new WdkLedgerSyncRequest();
WdkLedgerSyncRequest.Ledger obj1 = new WdkLedgerSyncRequest.Ledger();
obj1.setDcCode("51");
List<WdkLedgerSyncRequest.LedgerItem> list3 = new ArrayList<WdkLedgerSyncRequest.LedgerItem>();
WdkLedgerSyncRequest.LedgerItem obj4 = new WdkLedgerSyncRequest.LedgerItem();
list3.add(obj4);
obj4.setRecordCount(51L);
obj4.setTotalCount(1L);
obj4.setType(1L);
obj1.setLedgerItems(list3);
obj1.setMerchantCode("HM");
obj1.setOccurDate("2017-3-28");
obj1.setPageSize(100L);
obj1.setCurrentPage(1L);
obj1.setTotalPage(10L);
obj1.setTotalItems(1000L);
req.setLedger(obj1);
WdkLedgerSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
WdkLedgerSyncRequest req = new WdkLedgerSyncRequest();
WdkLedgerSyncRequest.LedgerDomain obj1 = new WdkLedgerSyncRequest.LedgerDomain();
obj1.DcCode = "51";
List<WdkLedgerSyncRequest.LedgerItemDomain> list3 = new List<WdkLedgerSyncRequest.LedgerItemDomain>();
WdkLedgerSyncRequest.LedgerItemDomain obj4 = new WdkLedgerSyncRequest.LedgerItemDomain();
list3.Add(obj4);
obj4.RecordCount = 51L;
obj4.TotalCount = 1L;
obj4.Type = 1L;
obj1.LedgerItems= list3;
obj1.MerchantCode = "HM";
obj1.OccurDate = "2017-3-28";
obj1.PageSize = 100L;
obj1.CurrentPage = 1L;
obj1.TotalPage = 10L;
obj1.TotalItems = 1000L;
req.Ledger_ = obj1;
WdkLedgerSyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new WdkLedgerSyncRequest;
$ledger = new Ledger;
$ledger->dc_code="51";
$ledger_items = new LedgerItem;
$ledger_items->record_count="51";
$ledger_items->total_count="1";
$ledger_items->type="1";
$ledger->ledger_items = $ledger_items;
$ledger->merchant_code="HM";
$ledger->occur_date="2017-3-28";
$ledger->page_size="100";
$ledger->current_page="1";
$ledger->total_page="10";
$ledger->total_items="1000";
$req->setLedger(json_encode($ledger));
$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.wdk.ledger.sync' \
-d 'partner_id=apidoc' \
-d 'sign=7CAFF07459290AABC4A5424CA356FA50' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+17%3A07%3A43' \
-d 'v=2.0' \
-d 'ledger=null'

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

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

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

XML示例
JSON示例

<wdk_ledger_sync_response>
    <result>
        <result_code>success</result_code>
        <result_message>成功</result_message>
        <success>true</success>
    </result>
</wdk_ledger_sync_response>

{
    "wdk_ledger_sync_response":{
        "result":{
            "result_code":"success",
            "result_message":"成功",
            "success":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.wdk.ledger.sync (同步五道口总账信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ