淘宝开放平台 - 文档中心

请求地址：

环境	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	OrderCallbackRequestDO	可选
└ warehouseCode String 可选奇门仓储字段,C123,string(50),, 奇门仓储字段,C123,string(50),, └ ownerCode String 可选奇门仓储字段,C123,string(50),, 奇门仓储字段,C123,string(50),, └ deliveryOrderCode String 可选奇门仓储字段,C123,string(50),, 奇门仓储字段,C123,string(50),, └ orderId String 可选奇门仓储字段,C123,string(50),, 奇门仓储字段,C123,string(50),, └ expressCode String 可选 123456789 运单号 └ extendProps Map 可选请求扩展属性

名称	类型	示例值	描述
response	OrderCallbackResponseDO
└ 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),, └ extendProps String map返回结构扩展属性

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
OrderCallbackRequest req = new OrderCallbackRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setWarehouseCode("奇门仓储字段,C123,string(50),,");
req.setOwnerCode("奇门仓储字段,C123,string(50),,");
req.setDeliveryOrderCode("奇门仓储字段,C123,string(50),,");
req.setOrderId("奇门仓储字段,C123,string(50),,");
req.setExpressCode("123456789");
OrderCallbackResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
OrderCallbackRequest req = new OrderCallbackRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.WarehouseCode = "奇门仓储字段,C123,string(50),,";
req.OwnerCode = "奇门仓储字段,C123,string(50),,";
req.DeliveryOrderCode = "奇门仓储字段,C123,string(50),,";
req.OrderId = "奇门仓储字段,C123,string(50),,";
req.ExpressCode = "123456789";
OrderCallbackResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenOrderCallbackRequest;
$request = new OrderCallbackRequestDO;
$request->warehouse_code="奇门仓储字段,C123,string(50),,";
$request->owner_code="奇门仓储字段,C123,string(50),,";
$request->delivery_order_code="奇门仓储字段,C123,string(50),,";
$request->order_id="奇门仓储字段,C123,string(50),,";
$request->express_code="123456789";
$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.order.callback&sign=D6C976D23E966088631BFE7A2D22CA13&sign_method=md5&timestamp=2025-04-28+18%3A23%3A34&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <ownerCode>奇门仓储字段,C123,string(50),,</ownerCode>
  <orderId>奇门仓储字段,C123,string(50),,</orderId>
  <expressCode>123456789</expressCode>
  <deliveryOrderCode>奇门仓储字段,C123,string(50),,</deliveryOrderCode>
  <warehouseCode>奇门仓储字段,C123,string(50),,</warehouseCode>
</request>'

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

req=top.api.QimenOrderCallbackRequest(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.order.callback");
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.order.callback', {
	'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>
    <extendProps>map返回结构</extendProps>
</response>

{
    "response":{
        "flag":"响应结果:success|failure,success,string(10),必填,",
        "code":"响应码,0,string(50),,",
        "message":"响应信息,invalid appkey,string(100),,",
        "extendProps":"map返回结构"
    }
}

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.order.callback (配送拦截接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ