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

请求地址：

环境	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	Request	可选
└ oaid String 可选订单收件人 ID, string (50) 订单收件人 ID, string (50) └ deliveryOrderCode String 必须出库单号, string (50) , 必填出库单号, string (50) , 必填 └ ownerCode String 可选货主ID, string (50) 货主ID └ warehouseCode String 可选 WS1231，string (64) 仓库编码 └ scene String 可选使用场景, string(10)，必填使用场景。1001，顺丰电子面单发货；1002，4通一达电子面单发货；1003，EMS电子面单发货；1004，其他电子面单发货；2001，客户售后服务

名称	类型	示例值	描述
response	Response
└ flag String success\|failure，必填 success\|failure，必填 └ code String 响应码响应码 └ message String 响应信息响应信息 └ oaid String 订单收件人 ID, string (50) 订单收件人 ID, string (50) └ deliveryOrderCode String 出库单号, string (50) , 必填出库单号, string (50) , 必填 receiverInfo ReceiverInfo 收货人信息 └ oaid String 订单收件人 ID, string (50) 订单收件人 ID, string (50) └ name String 姓名, string (50) , 必填姓名, string (50) , 必填 └ tel String 固定电话, string (50) 固定电话, string (50) └ mobile String 移动电话, string (50) , 必填移动电话, string (50) , 必填 └ countryCode String 国家二字码，string(50) 国家二字码，string(50) └ province String 省份, string (50) , 必填省份, string (50) , 必填 └ detailAddress String 详细地址, string (200) , 必填详细地址, string (200) , 必填 └ city String 杭州收件人所在城市 └ district String 余杭区收件人所在区 └ town String 五常街道收件人所在街道

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
ReceiverinfoQueryRequest req = new ReceiverinfoQueryRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setOaid("订单收件人 ID, string (50)");
req.setDeliveryOrderCode("出库单号, string (50) , 必填");
req.setOwnerCode("货主ID, string (50)");
req.setWarehouseCode("WS1231，string (64)");
req.setScene("使用场景, string(10)，必填");
ReceiverinfoQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
ReceiverinfoQueryRequest req = new ReceiverinfoQueryRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.Oaid = "订单收件人 ID, string (50)";
req.DeliveryOrderCode = "出库单号, string (50) , 必填";
req.OwnerCode = "货主ID, string (50)";
req.WarehouseCode = "WS1231，string (64)";
req.Scene = "使用场景, string(10)，必填";
ReceiverinfoQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenReceiverinfoQueryRequest;
$request = new Request;
$request->oaid="订单收件人 ID, string (50)";
$request->delivery_order_code="出库单号, string (50) , 必填";
$request->owner_code="货主ID, string (50)";
$request->warehouse_code="WS1231，string (64)";
$request->scene="使用场景, string(10)，必填";
$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.receiverinfo.query&sign=365A560855C3B9664314DABE67A9B44A&sign_method=md5&timestamp=2024-05-06+17%3A37%3A19&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <ownerCode>货主ID, string (50)</ownerCode>
  <deliveryOrderCode>出库单号, string (50) , 必填</deliveryOrderCode>
  <oaid>订单收件人 ID, string (50)</oaid>
  <warehouseCode>WS1231，string (64)</warehouseCode>
  <scene>使用场景, string(10)，必填</scene>
</request>'

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

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

XML示例
JSON示例

<response>
    <flag>success|failure，必填</flag>
    <code>响应码</code>
    <message>响应信息</message>
    <oaid>订单收件人 ID, string (50)</oaid>
    <deliveryOrderCode>出库单号, string (50) , 必填</deliveryOrderCode>
    <receiverInfo>
        <oaid>订单收件人 ID, string (50)</oaid>
        <name>姓名, string (50) , 必填</name>
        <tel>固定电话, string (50)</tel>
        <mobile>移动电话, string (50) , 必填</mobile>
        <countryCode>国家二字码，string(50)</countryCode>
        <province>省份, string (50) , 必填</province>
        <detailAddress>详细地址, string (200) , 必填</detailAddress>
        <city>杭州</city>
        <district>余杭区</district>
        <town>五常街道</town>
    </receiverInfo>
</response>

{
    "response":{
        "flag":"success|failure，必填",
        "code":"响应码",
        "message":"响应信息",
        "oaid":"订单收件人 ID, string (50)",
        "deliveryOrderCode":"出库单号, string (50) , 必填",
        "receiverInfo":{
            "oaid":"订单收件人 ID, string (50)",
            "name":"姓名, string (50) , 必填",
            "tel":"固定电话, string (50)",
            "mobile":"移动电话, string (50) , 必填",
            "countryCode":"国家二字码，string(50)",
            "province":"省份, string (50) , 必填",
            "detailAddress":"详细地址, string (200) , 必填",
            "city":"杭州",
            "district":"余杭区",
            "town":"五常街道"
        }
    }
}

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.receiverinfo.query (OAID 收件人信息解密接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈