淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
voucher	Voucher	必须			业务凭证
└ dc_code String 必须 51 盒马分配给DC的组织编码 inventory_items InventoryItem [] 可选凭证库存子项列表 inventory_batches InventoryBatch [] 可选凭证库存批次子项列表 └ batch_count String 可选 5.0000 批次对应的数量，支持4为小数点 └ batch_date String 可选 2017-03-24 库存对应的生产日期 └ batch_no String 可选 aaaabbbb170324-001 库存的批次号 └ item_code String 可选 130800500100 盒马系统中的商品编码 └ item_count String 可选 100.0000 批次数量的合计，支持4为小数点 └ management_code String 必须 01 管理部门编码，DC一般分良品、退货、坏货部 └ merchant_code String 必须 HM 盒马平台定义的商家编码 └ occur_date String 必须 2017-3-28 17:24:43 业务发生的时间，精确到时分秒 └ order_no String 必须 89101703280003 DC系统中的业务单号 └ order_type Number 必须 1 业务单据的类型，1：采购入库；2：退仓入库；3：调入；4：配货出库；5：退供出库；6：调出；7：批发出库；8：移库；9：库存调整 └ out_order_no String 可选 HPO51170328000019 如果出入库指令由盒马系统发起，则是盒马系统的指令单号，如：采购订单、退供单、配货出库单、批发出库单、退仓单、调入单、调出单 └ related_code String 可选 54 业务相关的对方，采购入库和退供出库是供应商，退仓入库和配货出库是门店；调入和调出是对方DC，批发出库是客户，移库和库存调整无业务发生方 └ related_dept String 可选 02 特指移库和调拨相关方的目的部门 └ page_size Number 可选 100 每页记录数 └ current_page Number 可选 1 当前第几页 └ total_page Number 可选 10 总页数 └ total_items Number 可选 100 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);
WdkVoucherSyncRequest req = new WdkVoucherSyncRequest();
WdkVoucherSyncRequest.Voucher obj1 = new WdkVoucherSyncRequest.Voucher();
obj1.setDcCode("51");
List<WdkVoucherSyncRequest.InventoryItem> list3 = new ArrayList<WdkVoucherSyncRequest.InventoryItem>();
WdkVoucherSyncRequest.InventoryItem obj4 = new WdkVoucherSyncRequest.InventoryItem();
list3.add(obj4);
List<WdkVoucherSyncRequest.InventoryBatch> list7 = new ArrayList<WdkVoucherSyncRequest.InventoryBatch>();
WdkVoucherSyncRequest.InventoryBatch obj8 = new WdkVoucherSyncRequest.InventoryBatch();
list7.add(obj8);
obj8.setBatchCount("5.0000");
obj8.setBatchDate("2017-03-24");
obj8.setBatchNo("aaaabbbb170324-001");
list5.setInventoryBatches(list7);
obj4.setItemCode("130800500100");
obj4.setItemCount("100.0000");
obj1.setInventoryItems(list3);
obj1.setManagementCode("01");
obj1.setMerchantCode("HM");
obj1.setOccurDate("2017-3-28 17:24:43");
obj1.setOrderNo("89101703280003");
obj1.setOrderType(1L);
obj1.setOutOrderNo("HPO51170328000019");
obj1.setRelatedCode("54");
obj1.setRelatedDept("02");
obj1.setPageSize(100L);
obj1.setCurrentPage(1L);
obj1.setTotalPage(10L);
obj1.setTotalItems(100L);
req.setVoucher(obj1);
WdkVoucherSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
WdkVoucherSyncRequest req = new WdkVoucherSyncRequest();
WdkVoucherSyncRequest.VoucherDomain obj1 = new WdkVoucherSyncRequest.VoucherDomain();
obj1.DcCode = "51";
List<WdkVoucherSyncRequest.InventoryItemDomain> list3 = new List<WdkVoucherSyncRequest.InventoryItemDomain>();
WdkVoucherSyncRequest.InventoryItemDomain obj4 = new WdkVoucherSyncRequest.InventoryItemDomain();
list3.Add(obj4);
List<WdkVoucherSyncRequest.InventoryBatchDomain> list6 = new List<WdkVoucherSyncRequest.InventoryBatchDomain>();
WdkVoucherSyncRequest.InventoryBatchDomain obj7 = new WdkVoucherSyncRequest.InventoryBatchDomain();
list6.Add(obj7);
obj7.BatchCount = "5.0000";
obj7.BatchDate = "2017-03-24";
obj7.BatchNo = "aaaabbbb170324-001";
obj4.InventoryBatches= list6;
obj4.ItemCode = "130800500100";
obj4.ItemCount = "100.0000";
obj1.InventoryItems= list3;
obj1.ManagementCode = "01";
obj1.MerchantCode = "HM";
obj1.OccurDate = "2017-3-28 17:24:43";
obj1.OrderNo = "89101703280003";
obj1.OrderType = 1L;
obj1.OutOrderNo = "HPO51170328000019";
obj1.RelatedCode = "54";
obj1.RelatedDept = "02";
obj1.PageSize = 100L;
obj1.CurrentPage = 1L;
obj1.TotalPage = 10L;
obj1.TotalItems = 100L;
req.Voucher_ = obj1;
WdkVoucherSyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new WdkVoucherSyncRequest;
$voucher = new Voucher;
$voucher->dc_code="51";
$inventory_items = new InventoryItem;
$inventory_batches = new InventoryBatch;
$inventory_batches->batch_count="5.0000";
$inventory_batches->batch_date="2017-03-24";
$inventory_batches->batch_no="aaaabbbb170324-001";
$inventory_items->inventory_batches = $inventory_batches;
$inventory_items->item_code="130800500100";
$inventory_items->item_count="100.0000";
$voucher->inventory_items = $inventory_items;
$voucher->management_code="01";
$voucher->merchant_code="HM";
$voucher->occur_date="2017-3-28 17:24:43";
$voucher->order_no="89101703280003";
$voucher->order_type="1";
$voucher->out_order_no="HPO51170328000019";
$voucher->related_code="54";
$voucher->related_dept="02";
$voucher->page_size="100";
$voucher->current_page="1";
$voucher->total_page="10";
$voucher->total_items="100";
$req->setVoucher(json_encode($voucher));
$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.voucher.sync' \
-d 'partner_id=apidoc' \
-d 'sign=34D6CF35EE32236D914F7BECC8284657' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+16%3A54%3A21' \
-d 'v=2.0' \
-d 'voucher=null'

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

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

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

XML示例
JSON示例

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

{
    "wdk_voucher_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.voucher.sync (同步五道口业务凭证)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ