淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request	ItemLackReportRequest	可选
└ warehouseCode String 必须 W1234 仓库编码 └ deliveryOrderCode String 必须 F1234 ERP的发货单编码 └ deliveryOrderId String 可选 H1234 仓库系统的发货单编码 └ createTime String 必须 2015-09-09 12:00:00 缺货回告创建时间(YYYY-MM-DD HH:mm:ss) └ outBizCode String 必须 WB123 外部业务编码(消息ID;用于去重;ISV对于同一请求;分配一个唯一性的编码。用来保证因为网络等原因导致重复传输;请求不会被重复处理) items Item [] 可选缺货商品列表 └ itemCode String 必须 I1234 商品编码 └ itemId String 可选 W1234 仓储系统商品编码 └ inventoryType String 可选 ZP 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;ZT=在途库存) └ batchCode String 可选 P1234 批次编码 └ productDate String 可选 2017-09-09 商品生产日期(YYYY-MM-DD) └ expireDate String 可选 2017-08-08 商品过期日期(YYYY-MM-DD) └ produceCode String 可选 P1234 生产批号 └ planQty Number 必须 11 应发商品数量 └ lackQty Number 必须 12 缺货商品数量 └ reason String 可选实物报缺缺货原因(系统报缺;实物报缺) └ remark String 可选备注备注 └ extendProps Map 可选扩展属性 └ remark String 可选备注备注

名称	类型	示例值	描述
response	Response
└ flag String success 响应结果:success\|failure └ code String 0 响应码 └ message String invalid appkey 响应信息

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
ItemlackReportRequest req = new ItemlackReportRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setWarehouseCode("W1234");
req.setDeliveryOrderCode("F1234");
req.setDeliveryOrderId("H1234");
req.setCreateTime("2015-09-09 12:00:00");
req.setOutBizCode("WB123");
Item obj1 = new Item();
obj1.setItemCode("I1234");
obj1.setItemId("W1234");
obj1.setInventoryType("ZP");
obj1.setBatchCode("P1234");
obj1.setProductDate("2017-09-09");
obj1.setExpireDate("2017-08-08");
obj1.setProduceCode("P1234");
obj1.setPlanQty(11L);
obj1.setLackQty(12L);
obj1.setReason("实物报缺");
obj1.setRemark("备注");
req.setItems(obj1);
req.setRemark("备注");
ItemlackReportResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
ItemlackReportRequest req = new ItemlackReportRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.WarehouseCode = "W1234";
req.DeliveryOrderCode = "F1234";
req.DeliveryOrderId = "H1234";
req.CreateTime = "2015-09-09 12:00:00";
req.OutBizCode = "WB123";
ItemlackReportRequest.ItemDomain obj1 = new ItemlackReportRequest.ItemDomain();
req.Items_= obj1;
obj1.ItemCode = "I1234";
obj1.ItemId = "W1234";
obj1.InventoryType = "ZP";
obj1.BatchCode = "P1234";
obj1.ProductDate = "2017-09-09";
obj1.ExpireDate = "2017-08-08";
obj1.ProduceCode = "P1234";
obj1.PlanQty = 11L;
obj1.LackQty = 12L;
obj1.Reason = "实物报缺";
obj1.Remark = "备注";
req.Items_ = obj1;
req.Remark = "备注";
ItemlackReportResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenItemlackReportRequest;
$request = new ItemLackReportRequest;
$request->warehouse_code="W1234";
$request->delivery_order_code="F1234";
$request->delivery_order_id="H1234";
$request->create_time="2015-09-09 12:00:00";
$request->out_biz_code="WB123";
$items = new Item;
$items->item_code="I1234";
$items->item_id="W1234";
$items->inventory_type="ZP";
$items->batch_code="P1234";
$items->product_date="2017-09-09";
$items->expire_date="2017-08-08";
$items->produce_code="P1234";
$items->plan_qty="11";
$items->lack_qty="12";
$items->reason="实物报缺";
$items->remark="备注";
$request->items = $items;
$request->extend_props="";
$request->remark="备注";
$req->setRequest(json_encode($request));
$resp = $c->execute($req);

curl -X POST 'http://qimenapi.tbsandbox.com/router/qimen/service?app_key=testerp_appkey&customerId=stub-cust-code&format=xml&method=taobao.qimen.itemlack.report&sign=19F1D91656F1357CC154A9E18029B544&sign_method=md5&timestamp=2025-04-28+18%3A13%3A40&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <outBizCode>WB123</outBizCode>
  <createTime>2015-09-09 12:00:00</createTime>
  <remark>备注</remark>
  <deliveryOrderCode>F1234</deliveryOrderCode>
  <items>
    <itemId>W1234</itemId>
    <produceCode>P1234</produceCode>
    <reason>实物报缺</reason>
    <inventoryType>ZP</inventoryType>
    <planQty>11</planQty>
    <lackQty>12</lackQty>
    <itemCode>I1234</itemCode>
    <batchCode>P1234</batchCode>
    <expireDate>2017-08-08</expireDate>
    <remark>备注</remark>
    <productDate>2017-09-09</productDate>
  </items>
  <warehouseCode>W1234</warehouseCode>
  <deliveryOrderId>H1234</deliveryOrderId>
</request>'

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

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

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

XML示例
JSON示例

<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey"
    }
}

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.qimen.itemlack.report (发货单缺货通知接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ