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

请求地址：

环境	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	StockOutQueryRequest	可选			cest
└ ownerCode String 可选 Owner1234 货主编码 └ warehouseCode String 可选 Warhouse1234 仓库编码 └ deliveryOrderCode String 必须 TB123789 出库单号 └ deliveryOrderId String 可选 TB12345id 仓储系统出库单号 └ page Number 必须 1 当前页 └ pageSize Number 必须 10 每页orderLine条数(最多100条) └ extendProps Map 可选扩展属性

名称	类型	示例值	描述
response	StockOutQueryResponse		response
└ flag String success 响应结果:success\|failure └ code String 0 响应码 └ message String invalid appkey 响应信息 └ totalLines Number 100 orderLines总条数 deliveryOrder DeliveryOrder 出库单信息 └ deliveryOrderCode String TB023145 出库单号 └ deliveryOrderId String TB2345id 仓储系统出库单号 └ warehouseCode String Ware123 仓库编码 └ orderType String PTCK 出库单类型 └ status String NEW 出库单状态 └ logisticsCode String SF 物流公司编码 └ logisticsName String 顺丰物流公司名称 └ expressCode String Y890234 运单号 └ orderConfirmTime String 2016-06-20 12:00:00 订单完成时间 packages Package [] 包裹信息 └ logisticsName String 顺丰物流公司名称 └ expressCode String Y123456 运单号 └ packageCode String B123456 包裹编号 └ length String 2.0 包裹长度(厘米) └ width String 2.0 包裹宽度(厘米) └ height String 2.0 包裹高度(厘米) └ weight String 23 包裹重量(千克) └ volume String 50 包裹体积(升L) packageMaterialList PackageMaterial [] 包材信息 └ type String XI-TB21 包材型号 └ quantity Number 11 包材的数量 items Item [] 商品信息列表 └ itemCode String Item123 商品编码 └ itemId String Item123id 商品仓储系统编码 └ quantity Number 11 包裹内该商品的数量 orderLines OrderLine [] 单据信息列表 └ orderLineNo String O1233 单据行号 └ itemCode String 0123id 商品编码 └ itemId String 0123id 商品仓储系统编码 └ itemName String 淘公仔商品名称 └ inventoryType String ZP 库存类型 └ actualQty Number 11 实发商品数量 └ batchCode String B111 批次编号 └ productDate String 2016-07-06 生产日期(YYYY-MM-DD) └ expireDate String 2016-07-06 过期日期(YYYY-MM-DD) └ produceCode String P123 生产批号

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
StockoutQueryRequest req = new StockoutQueryRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setOwnerCode("Owner1234");
req.setWarehouseCode("Warhouse1234");
req.setDeliveryOrderCode("TB123789");
req.setDeliveryOrderId("TB12345id");
req.setPage(1L);
req.setPageSize(10L);
StockoutQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
StockoutQueryRequest req = new StockoutQueryRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.OwnerCode = "Owner1234";
req.WarehouseCode = "Warhouse1234";
req.DeliveryOrderCode = "TB123789";
req.DeliveryOrderId = "TB12345id";
req.Page = 1L;
req.PageSize = 10L;
StockoutQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenStockoutQueryRequest;
$request = new StockOutQueryRequest;
$request->owner_code="Owner1234";
$request->warehouse_code="Warhouse1234";
$request->delivery_order_code="TB123789";
$request->delivery_order_id="TB12345id";
$request->page="1";
$request->page_size="10";
$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.stockout.query&sign=0C9096BF1C8A8C321DB10CDC6CECCFAC&sign_method=md5&timestamp=2024-05-06+16%3A02%3A22&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <ownerCode>Owner1234</ownerCode>
  <pageSize>10</pageSize>
  <extendProps/>
  <deliveryOrderCode>TB123789</deliveryOrderCode>
  <page>1</page>
  <warehouseCode>Warhouse1234</warehouseCode>
  <deliveryOrderId>TB12345id</deliveryOrderId>
</request>'

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

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

req.request=""
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.stockout.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.stockout.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>100</totalLines>
    <deliveryOrder>
        <deliveryOrderCode>TB023145</deliveryOrderCode>
        <deliveryOrderId>TB2345id</deliveryOrderId>
        <warehouseCode>Ware123</warehouseCode>
        <orderType>PTCK</orderType>
        <status>NEW</status>
        <logisticsCode>SF</logisticsCode>
        <logisticsName>顺丰</logisticsName>
        <expressCode>Y890234</expressCode>
        <orderConfirmTime>2016-06-20 12:00:00</orderConfirmTime>
    </deliveryOrder>
    <packages>
        <package>
            <logisticsName>顺丰</logisticsName>
            <expressCode>Y123456</expressCode>
            <packageCode>B123456</packageCode>
            <length>2.0</length>
            <width>2.0</width>
            <height>2.0</height>
            <weight>23</weight>
            <volume>50</volume>
            <packageMaterialList>
                <packageMaterial>
                    <type>XI-TB21</type>
                    <quantity>11</quantity>
                </packageMaterial>
            </packageMaterialList>
            <items>
                <item>
                    <itemCode>Item123</itemCode>
                    <itemId>Item123id</itemId>
                    <quantity>11</quantity>
                </item>
            </items>
        </package>
    </packages>
    <orderLines>
        <orderLine>
            <orderLineNo>O1233</orderLineNo>
            <itemCode>0123id</itemCode>
            <itemId>0123id</itemId>
            <itemName>淘公仔</itemName>
            <inventoryType>ZP</inventoryType>
            <actualQty>11</actualQty>
            <batchCode>B111</batchCode>
            <productDate>2016-07-06</productDate>
            <expireDate>2016-07-06</expireDate>
            <produceCode>P123</produceCode>
        </orderLine>
    </orderLines>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey",
        "totalLines":100,
        "deliveryOrder":{
            "deliveryOrderCode":"TB023145",
            "deliveryOrderId":"TB2345id",
            "warehouseCode":"Ware123",
            "orderType":"PTCK",
            "status":"NEW",
            "logisticsCode":"SF",
            "logisticsName":"顺丰",
            "expressCode":"Y890234",
            "orderConfirmTime":"2016-06-20 12:00:00"
        },
        "packages":{
            "package":[
                {
                    "logisticsName":"顺丰",
                    "expressCode":"Y123456",
                    "packageCode":"B123456",
                    "length":"2.0",
                    "width":"2.0",
                    "height":"2.0",
                    "weight":"23",
                    "volume":"50",
                    "packageMaterialList":{
                        "packageMaterial":[
                            {
                                "type":"XI-TB21",
                                "quantity":11
                            }
                        ]
                    },
                    "items":{
                        "item":[
                            {
                                "itemCode":"Item123",
                                "itemId":"Item123id",
                                "quantity":11
                            }
                        ]
                    }
                }
            ]
        },
        "orderLines":{
            "orderLine":[
                {
                    "orderLineNo":"O1233",
                    "itemCode":"0123id",
                    "itemId":"0123id",
                    "itemName":"淘公仔",
                    "inventoryType":"ZP",
                    "actualQty":11,
                    "batchCode":"B111",
                    "productDate":"2016-07-06",
                    "expireDate":"2016-07-06",
                    "produceCode":"P123"
                }
            ]
        }
    }
}

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.stockout.query (出库单查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈