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

请求地址：

环境	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	RequestDO	可选
└ ownerCode String 可选货主编码,H123,string(50),必填, 货主编码,H123,string(50),必填, └ itemCode String 可选商品编码,S1234,string(50),必填, 商品编码,S1234,string(50),必填, └ itemId String 可选仓储系统商品编码,C123,string(50),必填, 仓储系统商品编码,C123,string(50),必填,

名称	类型	示例值	描述
response	ResponseDO
└ flag String 响应结果:success\|failure,success,string(10),必填, 响应结果:success\|failure,success,string(10),必填, └ code String 响应码,0,string(50),, 响应码,0,string(50),, └ message String 响应信息,invalid appkey,string(100),, 响应信息,invalid appkey,string(100),, item Item item └ itemCode String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ itemId String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ goodsCode String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ itemName String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ shortName String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ englishName String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ barCode String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ skuProperty String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ stockUnit String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ length String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ width String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ height String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ volume String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ grossWeight String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ netWeight String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ color String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ size String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ title String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ categoryId String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ categoryName String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ pricingCategory String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ safetyStock String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ itemType String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ tagPrice String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ retailPrice String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ costPrice String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ purchasePrice String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ seasonCode String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ seasonName String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ brandCode String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ brandName String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isSNMgmt String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ productDate String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ expireDate String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isShelfLifeMgmt String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ shelfLife String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ rejectLifecycle String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ lockupLifecycle String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ adventLifecycle String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isBatchMgmt String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ batchCode String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ batchRemark String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ packCode String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ pcs String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ originAddress String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ approvalNumber String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isFragile String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isHazardous String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ remark String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ createTime String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ updateTime String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isValid String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isSku String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ packageMaterial String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isAreaSale String 奇门仓储字段,H123,string(50),必填, 奇门仓储字段,H123,string(50),必填, └ isLiquid String Y 是否液体, Y/N, (默认为N)

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
SingleitemQueryRequest req = new SingleitemQueryRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setOwnerCode("货主编码,H123,string(50),必填,");
req.setItemCode("商品编码,S1234,string(50),必填,");
req.setItemId("仓储系统商品编码,C123,string(50),必填,");
SingleitemQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
SingleitemQueryRequest req = new SingleitemQueryRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.OwnerCode = "货主编码,H123,string(50),必填,";
req.ItemCode = "商品编码,S1234,string(50),必填,";
req.ItemId = "仓储系统商品编码,C123,string(50),必填,";
SingleitemQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenSingleitemQueryRequest;
$request = new RequestDO;
$request->owner_code="货主编码,H123,string(50),必填,";
$request->item_code="商品编码,S1234,string(50),必填,";
$request->item_id="仓储系统商品编码,C123,string(50),必填,";
$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.singleitem.query&sign=FE3ED1AF61F1A1B50DF8476507180DDB&sign_method=md5&timestamp=2024-05-06+16%3A17%3A33&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <itemId>仓储系统商品编码,C123,string(50),必填,</itemId>
  <ownerCode>货主编码,H123,string(50),必填,</ownerCode>
  <itemCode>商品编码,S1234,string(50),必填,</itemCode>
</request>'

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

req=top.api.QimenSingleitemQueryRequest(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.singleitem.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.singleitem.query', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<response>
    <flag>响应结果:success|failure,success,string(10),必填,</flag>
    <code>响应码,0,string(50),,</code>
    <message>响应信息,invalid appkey,string(100),,</message>
    <item>
        <itemCode>奇门仓储字段,H123,string(50),必填,</itemCode>
        <itemId>奇门仓储字段,H123,string(50),必填,</itemId>
        <goodsCode>奇门仓储字段,H123,string(50),必填,</goodsCode>
        <itemName>奇门仓储字段,H123,string(50),必填,</itemName>
        <shortName>奇门仓储字段,H123,string(50),必填,</shortName>
        <englishName>奇门仓储字段,H123,string(50),必填,</englishName>
        <barCode>奇门仓储字段,H123,string(50),必填,</barCode>
        <skuProperty>奇门仓储字段,H123,string(50),必填,</skuProperty>
        <stockUnit>奇门仓储字段,H123,string(50),必填,</stockUnit>
        <length>奇门仓储字段,H123,string(50),必填,</length>
        <width>奇门仓储字段,H123,string(50),必填,</width>
        <height>奇门仓储字段,H123,string(50),必填,</height>
        <volume>奇门仓储字段,H123,string(50),必填,</volume>
        <grossWeight>奇门仓储字段,H123,string(50),必填,</grossWeight>
        <netWeight>奇门仓储字段,H123,string(50),必填,</netWeight>
        <color>奇门仓储字段,H123,string(50),必填,</color>
        <size>奇门仓储字段,H123,string(50),必填,</size>
        <title>奇门仓储字段,H123,string(50),必填,</title>
        <categoryId>奇门仓储字段,H123,string(50),必填,</categoryId>
        <categoryName>奇门仓储字段,H123,string(50),必填,</categoryName>
        <pricingCategory>奇门仓储字段,H123,string(50),必填,</pricingCategory>
        <safetyStock>奇门仓储字段,H123,string(50),必填,</safetyStock>
        <itemType>奇门仓储字段,H123,string(50),必填,</itemType>
        <tagPrice>奇门仓储字段,H123,string(50),必填,</tagPrice>
        <retailPrice>奇门仓储字段,H123,string(50),必填,</retailPrice>
        <costPrice>奇门仓储字段,H123,string(50),必填,</costPrice>
        <purchasePrice>奇门仓储字段,H123,string(50),必填,</purchasePrice>
        <seasonCode>奇门仓储字段,H123,string(50),必填,</seasonCode>
        <seasonName>奇门仓储字段,H123,string(50),必填,</seasonName>
        <brandCode>奇门仓储字段,H123,string(50),必填,</brandCode>
        <brandName>奇门仓储字段,H123,string(50),必填,</brandName>
        <isSNMgmt>奇门仓储字段,H123,string(50),必填,</isSNMgmt>
        <productDate>奇门仓储字段,H123,string(50),必填,</productDate>
        <expireDate>奇门仓储字段,H123,string(50),必填,</expireDate>
        <isShelfLifeMgmt>奇门仓储字段,H123,string(50),必填,</isShelfLifeMgmt>
        <shelfLife>奇门仓储字段,H123,string(50),必填,</shelfLife>
        <rejectLifecycle>奇门仓储字段,H123,string(50),必填,</rejectLifecycle>
        <lockupLifecycle>奇门仓储字段,H123,string(50),必填,</lockupLifecycle>
        <adventLifecycle>奇门仓储字段,H123,string(50),必填,</adventLifecycle>
        <isBatchMgmt>奇门仓储字段,H123,string(50),必填,</isBatchMgmt>
        <batchCode>奇门仓储字段,H123,string(50),必填,</batchCode>
        <batchRemark>奇门仓储字段,H123,string(50),必填,</batchRemark>
        <packCode>奇门仓储字段,H123,string(50),必填,</packCode>
        <pcs>奇门仓储字段,H123,string(50),必填,</pcs>
        <originAddress>奇门仓储字段,H123,string(50),必填,</originAddress>
        <approvalNumber>奇门仓储字段,H123,string(50),必填,</approvalNumber>
        <isFragile>奇门仓储字段,H123,string(50),必填,</isFragile>
        <isHazardous>奇门仓储字段,H123,string(50),必填,</isHazardous>
        <remark>奇门仓储字段,H123,string(50),必填,</remark>
        <createTime>奇门仓储字段,H123,string(50),必填,</createTime>
        <updateTime>奇门仓储字段,H123,string(50),必填,</updateTime>
        <isValid>奇门仓储字段,H123,string(50),必填,</isValid>
        <isSku>奇门仓储字段,H123,string(50),必填,</isSku>
        <packageMaterial>奇门仓储字段,H123,string(50),必填,</packageMaterial>
        <isAreaSale>奇门仓储字段,H123,string(50),必填,</isAreaSale>
        <isLiquid>Y</isLiquid>
    </item>
</response>

{
    "response":{
        "flag":"响应结果:success|failure,success,string(10),必填,",
        "code":"响应码,0,string(50),,",
        "message":"响应信息,invalid appkey,string(100),,",
        "item":{
            "itemCode":"奇门仓储字段,H123,string(50),必填,",
            "itemId":"奇门仓储字段,H123,string(50),必填,",
            "goodsCode":"奇门仓储字段,H123,string(50),必填,",
            "itemName":"奇门仓储字段,H123,string(50),必填,",
            "shortName":"奇门仓储字段,H123,string(50),必填,",
            "englishName":"奇门仓储字段,H123,string(50),必填,",
            "barCode":"奇门仓储字段,H123,string(50),必填,",
            "skuProperty":"奇门仓储字段,H123,string(50),必填,",
            "stockUnit":"奇门仓储字段,H123,string(50),必填,",
            "length":"奇门仓储字段,H123,string(50),必填,",
            "width":"奇门仓储字段,H123,string(50),必填,",
            "height":"奇门仓储字段,H123,string(50),必填,",
            "volume":"奇门仓储字段,H123,string(50),必填,",
            "grossWeight":"奇门仓储字段,H123,string(50),必填,",
            "netWeight":"奇门仓储字段,H123,string(50),必填,",
            "color":"奇门仓储字段,H123,string(50),必填,",
            "size":"奇门仓储字段,H123,string(50),必填,",
            "title":"奇门仓储字段,H123,string(50),必填,",
            "categoryId":"奇门仓储字段,H123,string(50),必填,",
            "categoryName":"奇门仓储字段,H123,string(50),必填,",
            "pricingCategory":"奇门仓储字段,H123,string(50),必填,",
            "safetyStock":"奇门仓储字段,H123,string(50),必填,",
            "itemType":"奇门仓储字段,H123,string(50),必填,",
            "tagPrice":"奇门仓储字段,H123,string(50),必填,",
            "retailPrice":"奇门仓储字段,H123,string(50),必填,",
            "costPrice":"奇门仓储字段,H123,string(50),必填,",
            "purchasePrice":"奇门仓储字段,H123,string(50),必填,",
            "seasonCode":"奇门仓储字段,H123,string(50),必填,",
            "seasonName":"奇门仓储字段,H123,string(50),必填,",
            "brandCode":"奇门仓储字段,H123,string(50),必填,",
            "brandName":"奇门仓储字段,H123,string(50),必填,",
            "isSNMgmt":"奇门仓储字段,H123,string(50),必填,",
            "productDate":"奇门仓储字段,H123,string(50),必填,",
            "expireDate":"奇门仓储字段,H123,string(50),必填,",
            "isShelfLifeMgmt":"奇门仓储字段,H123,string(50),必填,",
            "shelfLife":"奇门仓储字段,H123,string(50),必填,",
            "rejectLifecycle":"奇门仓储字段,H123,string(50),必填,",
            "lockupLifecycle":"奇门仓储字段,H123,string(50),必填,",
            "adventLifecycle":"奇门仓储字段,H123,string(50),必填,",
            "isBatchMgmt":"奇门仓储字段,H123,string(50),必填,",
            "batchCode":"奇门仓储字段,H123,string(50),必填,",
            "batchRemark":"奇门仓储字段,H123,string(50),必填,",
            "packCode":"奇门仓储字段,H123,string(50),必填,",
            "pcs":"奇门仓储字段,H123,string(50),必填,",
            "originAddress":"奇门仓储字段,H123,string(50),必填,",
            "approvalNumber":"奇门仓储字段,H123,string(50),必填,",
            "isFragile":"奇门仓储字段,H123,string(50),必填,",
            "isHazardous":"奇门仓储字段,H123,string(50),必填,",
            "remark":"奇门仓储字段,H123,string(50),必填,",
            "createTime":"奇门仓储字段,H123,string(50),必填,",
            "updateTime":"奇门仓储字段,H123,string(50),必填,",
            "isValid":"奇门仓储字段,H123,string(50),必填,",
            "isSku":"奇门仓储字段,H123,string(50),必填,",
            "packageMaterial":"奇门仓储字段,H123,string(50),必填,",
            "isAreaSale":"奇门仓储字段,H123,string(50),必填,",
            "isLiquid":"Y"
        }
    }
}

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.singleitem.query (商品查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈