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

请求地址：

环境	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	OrderStatusBatchQueryRequest	可选
└ ownerCode String 必须 H1234 货主编码 └ warehouseCode String 可选 W1234 仓库编码 └ startTime String 必须 2016-09-09 12:00:00 订单最后操作时间(查询起始时间点;格式:YYYY-MM-DD hh:mm:ss) └ endTime String 可选 2016-09-09 12:00:00 订单最后操作时间(查询截止时间点;格式:YYYY-MM-DD hh:mm:ss) └ orderType String 可选 JYCK 单据类型(JYCK=一般交易出库单;HHCK=换货出库;BFCK=补发出库;PTCK=普通出库单;DBCK=调拨出库;QTCK=其他出库;B2BRK=B2B入库;B2BCK=B2B出库;CGRK=采购入库;DBRK=调拨入库;QTRK=其他入库;XTRK=销退入库;HHRK= 换货入库;CNJG= 仓内加工单) └ currentPage Number 必须 1 当前第几页(从1开始) └ pageSize Number 必须 20 页面大小(建议不超过100条) └ extendProps Map 可选扩展属性

名称	类型	示例值	描述
response	OrderStatusBatchQueryResponse
└ flag String success 响应结果:success\|failure └ code String 0 响应码 └ message String invalid appkey 响应信息 └ totalPage Number 100 总页数 orders Order [] 单据信息 └ orderCode String D1234 单据号 └ orderId String W1234 仓储系统单据号 orderSourceCodes OrderSourceCodes 交易单号信息（目前只支持一个交易单号） └ orderSourceCode String J1234 交易单号 └ orderType String JYCK 单据类型(JYCK=一般交易出库单;HHCK=换货出库;BFCK=补发出库;PTCK=普通出库单;DBCK=调拨出库;QTCK=其他出库;B2BRK=B2B入库;B2BCK=B2B出库;CGRK=采购入库;DBRK=调拨入库;QTRK=其他入库;XTRK=销退入库;HHRK= 换货入库;CNJG= 仓内加工单) └ warehouseCode String W1234 仓库编码 └ processStatus String NEW 当前单据状态(NEW=新增;ACCEPT=仓库接单;PRINT=打印;PICK=捡货;CHECK=复核;PACKAGE=打包;WEIGH=称重;READY=待提货;DELIVERED=已发货;EXCEPTION =异常;CLOSED=关闭;CANCELED= 取消;REJECT=仓库拒单;REFUSE=客户拒签;CANCELEDFAIL=取消失败;SIGN=签收;TMSCANCELED=快递拦截;PARTFULFILLED-部分收货完成;FULFILLED-收货完成;PARTDELIVERED=部分发货完成;OTHER=其他;只传英文编码) └ operatorCode String OP1234 该状态操作员编码 └ operatorName String N1234 该状态操作员姓名 └ operateTime String 2016-09-09 12:00:00 该状态操作时间(YYYY-MM-DD HH:MM:SS) └ operateInfo String 开始配送操作内容

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
OrderstatusBatchqueryRequest req = new OrderstatusBatchqueryRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setOwnerCode("H1234");
req.setWarehouseCode("W1234");
req.setStartTime("2016-09-09 12:00:00");
req.setEndTime("2016-09-09 12:00:00");
req.setOrderType("JYCK");
req.setCurrentPage(1L);
req.setPageSize(20L);
OrderstatusBatchqueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
OrderstatusBatchqueryRequest req = new OrderstatusBatchqueryRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.OwnerCode = "H1234";
req.WarehouseCode = "W1234";
req.StartTime = "2016-09-09 12:00:00";
req.EndTime = "2016-09-09 12:00:00";
req.OrderType = "JYCK";
req.CurrentPage = 1L;
req.PageSize = 20L;
OrderstatusBatchqueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenOrderstatusBatchqueryRequest;
$request = new OrderStatusBatchQueryRequest;
$request->owner_code="H1234";
$request->warehouse_code="W1234";
$request->start_time="2016-09-09 12:00:00";
$request->end_time="2016-09-09 12:00:00";
$request->order_type="JYCK";
$request->current_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.orderstatus.batchquery&sign=2F9CA5FC595A2454365F0B6304B0758A&sign_method=md5&timestamp=2024-05-06+16%3A33%3A11&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <orderType>JYCK</orderType>
  <ownerCode>H1234</ownerCode>
  <pageSize>20</pageSize>
  <startTime>2016-09-09 12:00:00</startTime>
  <endTime>2016-09-09 12:00:00</endTime>
  <currentPage>1</currentPage>
  <warehouseCode>W1234</warehouseCode>
</request>'

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

req=top.api.QimenOrderstatusBatchqueryRequest(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.orderstatus.batchquery");
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.orderstatus.batchquery', {
	'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>
    <totalPage>100</totalPage>
    <orders>
        <order>
            <orderCode>D1234</orderCode>
            <orderId>W1234</orderId>
            <orderSourceCodes>
                <orderSourceCode>J1234</orderSourceCode>
            </orderSourceCodes>
            <orderType>JYCK</orderType>
            <warehouseCode>W1234</warehouseCode>
            <processStatus>NEW</processStatus>
            <operatorCode>OP1234</operatorCode>
            <operatorName>N1234</operatorName>
            <operateTime>2016-09-09 12:00:00</operateTime>
            <operateInfo>开始配送</operateInfo>
        </order>
    </orders>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey",
        "totalPage":100,
        "orders":{
            "order":[
                {
                    "orderCode":"D1234",
                    "orderId":"W1234",
                    "orderSourceCodes":{
                        "orderSourceCode":"J1234"
                    },
                    "orderType":"JYCK",
                    "warehouseCode":"W1234",
                    "processStatus":"NEW",
                    "operatorCode":"OP1234",
                    "operatorName":"N1234",
                    "operateTime":"2016-09-09 12:00:00",
                    "operateInfo":"开始配送"
                }
            ]
        }
    }
}

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.orderstatus.batchquery (订单状态查询接口(批量))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈