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

请求地址：

环境	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	InventoryCheckQueryRequest	可选
└ ownerCode String 可选 H1234 货主编码 └ warehouseCode String 可选 C1234 仓库编码 └ checkOrderCode String 必须 P1234 盘点单编码 └ checkOrderId String 可选 PID1234 仓储系统的盘点单编码 └ page Number 必须 1 当前页(从1开始) └ pageSize Number 必须 20 每页orderLine条数(最多100条) └ extendProps Map 可选扩展属性

名称	类型	示例值	描述
response	InventoryCheckQueryResponse
└ flag String success 响应结果:success\|failure └ code String 0 响应码 └ message String invalid appkey 响应信息 └ totalLines Number 12 orderLines总条数 └ warehouseCode String W1234 仓库编码 └ checkOrderCode String P1234 盘点单编码 └ checkOrderId String PS1234 仓储系统的盘点单编码 └ ownerCode String H1234 货主编码 └ checkTime String 2016-09-09 12:00:00 盘点时间(YYYY-MM-DD HH:MM:SS) └ remark String 备注信息备注 items Item [] 商品库存列表 └ itemCode String I1234 商品编码 └ itemId String ID1234 仓储系统商品ID └ inventoryType String ZP 库存类型(ZP=正品;CC=残次;JS=机损;XS= 箱损;ZT=在途库存;默认为ZP) └ quantity Number 12 盘盈盘亏商品变化量(盘盈为正数;盘亏为负数) └ batchCode String P1234 批次编码 └ productDate String 2016-09-09 商品生产日期(YYYY-MM-DD) └ expireDate String 2016-09-09 商品过期日期(YYYY-MM-DD) └ produceCode String P1234 生产批号 └ snCode String X1234 商品序列号 └ remark String 备注信息备注

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
InventorycheckQueryRequest req = new InventorycheckQueryRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setOwnerCode("H1234");
req.setWarehouseCode("C1234");
req.setCheckOrderCode("P1234");
req.setCheckOrderId("PID1234");
req.setPage(1L);
req.setPageSize(20L);
InventorycheckQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
InventorycheckQueryRequest req = new InventorycheckQueryRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.OwnerCode = "H1234";
req.WarehouseCode = "C1234";
req.CheckOrderCode = "P1234";
req.CheckOrderId = "PID1234";
req.Page = 1L;
req.PageSize = 20L;
InventorycheckQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenInventorycheckQueryRequest;
$request = new InventoryCheckQueryRequest;
$request->owner_code="H1234";
$request->warehouse_code="C1234";
$request->check_order_code="P1234";
$request->check_order_id="PID1234";
$request->page="1";
$request->page_size="20";
$request->extend_props="";
$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.inventorycheck.query&sign=ACAF0F7FA4244CFD0AA783A86E6F293F&sign_method=md5&timestamp=2024-05-06+13%3A18%3A24&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <ownerCode>H1234</ownerCode>
  <pageSize>20</pageSize>
  <page>1</page>
  <warehouseCode>C1234</warehouseCode>
  <checkOrderId>PID1234</checkOrderId>
  <checkOrderCode>P1234</checkOrderCode>
</request>'

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

req=top.api.QimenInventorycheckQueryRequest(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.inventorycheck.query");
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.inventorycheck.query', {
	'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>
    <totalLines>12</totalLines>
    <warehouseCode>W1234</warehouseCode>
    <checkOrderCode>P1234</checkOrderCode>
    <checkOrderId>PS1234</checkOrderId>
    <ownerCode>H1234</ownerCode>
    <checkTime>2016-09-09 12:00:00</checkTime>
    <remark>备注信息</remark>
    <items>
        <item>
            <itemCode>I1234</itemCode>
            <itemId>ID1234</itemId>
            <inventoryType>ZP</inventoryType>
            <quantity>12</quantity>
            <batchCode>P1234</batchCode>
            <productDate>2016-09-09</productDate>
            <expireDate>2016-09-09</expireDate>
            <produceCode>P1234</produceCode>
            <snCode>X1234</snCode>
            <remark>备注信息</remark>
        </item>
    </items>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey",
        "totalLines":12,
        "warehouseCode":"W1234",
        "checkOrderCode":"P1234",
        "checkOrderId":"PS1234",
        "ownerCode":"H1234",
        "checkTime":"2016-09-09 12:00:00",
        "remark":"备注信息",
        "items":{
            "item":[
                {
                    "itemCode":"I1234",
                    "itemId":"ID1234",
                    "inventoryType":"ZP",
                    "quantity":12,
                    "batchCode":"P1234",
                    "productDate":"2016-09-09",
                    "expireDate":"2016-09-09",
                    "produceCode":"P1234",
                    "snCode":"X1234",
                    "remark":"备注信息"
                }
            ]
        }
    }
}

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.inventorycheck.query (库存盘点查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈