淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
ins_check_use_equity_admit_info_request	InsCheckUseEquityAdmitInfoRequest	可选			下单准入请求参数
└ biz_data String 可选 { "sender":"{\"area\":\"浦东新区\",\"areaCode\":\"310115\",\"address\":\"永泰路311号\",\"province\":\"上海\",\"phone\":\"13408222131\",\"city\":\"上海\",\"name\":\"测试\"}", "receiver":"{\"area\":\"浦东新区\",\"areaCode\":\"310115\",\"address\":\"永泰路311号\",\"province\":\"上海\",\"phone\":\"13408222131\",\"city\":\"上海\",\"name\":\"测试\"}", "reserveTime":"{\"startTime\":\"2021-09-01 00:00:00\",\"endTime\":\"2021-09-01 12:00:00\"}", "goodsKinds":"衣服", "entrance":"yfx", "remark":"备注" } 扩展字段 └ equity_id String 必须 43433 权益id └ user_id String 必须 234334 用户id └ image_url String 可选 /oss/s233 图片上传路径 └ alipay_user_id String 可选 2088343443 支付宝id └ user_type String 必须 TAOBAO 用户类型：TAOBAO,ALIPAY,BAOXIAN └ dispute_id Number 可选 2343 逆向id 退货 └ biz_order_id Number 可选 12343 订单id sender LogisticsAddress 可选寄件信息 └ area_code String 可选 330481 地址编码 └ address String 可选浙江省金华市东阳市浙江省-金华市-东阳市-吴宁街道吴宁镇竹园路详细地址 └ name String 可选张三姓名 └ phone String 可选 1234567855 联系方式 └ city String 可选金华市市 └ area String 可选东阳市区/县 └ province String 可选浙江省省 receiver LogisticsAddress 可选收件信息 └ area_code String 可选 330481 地址编码 └ address String 可选浙江省金华市东阳市浙江省-金华市-东阳市-吴宁街道吴宁镇竹园路详细地址 └ name String 可选张三姓名 └ phone String 可选 1234567855 联系方式 └ city String 可选金华市市 └ area String 可选东阳市区/县 └ province String 可选浙江省省 └ entrance String 可选 CAINIAO 渠道

名称	类型	示例值	描述
qwyfx_success	Boolean	true	是否成功
qwyfx_error_code	String	-1	错误码
model	InsCheckUseEquityAdmitInfoResponse		准入信息
└ is_admit Boolean true 是否准入 └ reject_code String 0_delivery image 拒绝准入错误码 └ reject_reason String 发货图片拒绝准入错误原因
error_msg	String	-1	错误信息
is_success	Boolean	true	是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlipayBaoxianQwyfxEquityAdmitRequest req = new AlipayBaoxianQwyfxEquityAdmitRequest();
AlipayBaoxianQwyfxEquityAdmitRequest.InsCheckUseEquityAdmitInfoRequest obj1 = new AlipayBaoxianQwyfxEquityAdmitRequest.InsCheckUseEquityAdmitInfoRequest();
obj1.setBizData("{     \"sender\":\"{\\"area\\":\\"浦东新区\\",\\"areaCode\\":\\"310115\\",\\"address\\":\\"永泰路311号\\",\\"province\\":\\"上海\\",\\"phone\\":\\"13408222131\\",\\"city\\":\\"上海\\",\\"name\\":\\"测试\\"}\",     \"receiver\":\"{\\"area\\":\\"浦东新区\\",\\"areaCode\\":\\"310115\\",\\"address\\":\\"永泰路311号\\",\\"province\\":\\"上海\\",\\"phone\\":\\"13408222131\\",\\"city\\":\\"上海\\",\\"name\\":\\"测试\\"}\",     \"reserveTime\":\"{\\"startTime\\":\\"2021-09-01 00:00:00\\",\\"endTime\\":\\"2021-09-01 12:00:00\\"}\",     \"goodsKinds\":\"衣服\",     \"entrance\":\"yfx\",     \"remark\":\"备注\" 	}");
obj1.setEquityId("43433");
obj1.setUserId("234334");
obj1.setImageUrl("/oss/s233");
obj1.setAlipayUserId("2088343443");
obj1.setUserType("TAOBAO");
obj1.setDisputeId(2343L);
obj1.setBizOrderId(12343L);
AlipayBaoxianQwyfxEquityAdmitRequest.LogisticsAddress obj2 = new AlipayBaoxianQwyfxEquityAdmitRequest.LogisticsAddress();
obj2.setAreaCode("330481");
obj2.setAddress("浙江省金华市东阳市浙江省-金华市-东阳市-吴宁街道吴宁镇竹园路");
obj2.setName("张三");
obj2.setPhone("1234567855");
obj2.setCity("金华市");
obj2.setArea("东阳市");
obj2.setProvince("浙江省");
obj1.setSender(obj2);
AlipayBaoxianQwyfxEquityAdmitRequest.LogisticsAddress obj3 = new AlipayBaoxianQwyfxEquityAdmitRequest.LogisticsAddress();
obj3.setAreaCode("330481");
obj3.setAddress("浙江省金华市东阳市浙江省-金华市-东阳市-吴宁街道吴宁镇竹园路");
obj3.setName("张三");
obj3.setPhone("1234567855");
obj3.setCity("金华市");
obj3.setArea("东阳市");
obj3.setProvince("浙江省");
obj1.setReceiver(obj3);
obj1.setEntrance("CAINIAO");
req.setInsCheckUseEquityAdmitInfoRequest(obj1);
AlipayBaoxianQwyfxEquityAdmitResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlipayBaoxianQwyfxEquityAdmitRequest req = new AlipayBaoxianQwyfxEquityAdmitRequest();
AlipayBaoxianQwyfxEquityAdmitRequest.InsCheckUseEquityAdmitInfoRequestDomain obj1 = new AlipayBaoxianQwyfxEquityAdmitRequest.InsCheckUseEquityAdmitInfoRequestDomain();
obj1.BizData = "{     \"sender\":\"{\\"area\\":\\"浦东新区\\",\\"areaCode\\":\\"310115\\",\\"address\\":\\"永泰路311号\\",\\"province\\":\\"上海\\",\\"phone\\":\\"13408222131\\",\\"city\\":\\"上海\\",\\"name\\":\\"测试\\"}\",     \"receiver\":\"{\\"area\\":\\"浦东新区\\",\\"areaCode\\":\\"310115\\",\\"address\\":\\"永泰路311号\\",\\"province\\":\\"上海\\",\\"phone\\":\\"13408222131\\",\\"city\\":\\"上海\\",\\"name\\":\\"测试\\"}\",     \"reserveTime\":\"{\\"startTime\\":\\"2021-09-01 00:00:00\\",\\"endTime\\":\\"2021-09-01 12:00:00\\"}\",     \"goodsKinds\":\"衣服\",     \"entrance\":\"yfx\",     \"remark\":\"备注\" 	}";
obj1.EquityId = "43433";
obj1.UserId = "234334";
obj1.ImageUrl = "/oss/s233";
obj1.AlipayUserId = "2088343443";
obj1.UserType = "TAOBAO";
obj1.DisputeId = 2343L;
obj1.BizOrderId = 12343L;
AlipayBaoxianQwyfxEquityAdmitRequest.LogisticsAddressDomain obj2 = new AlipayBaoxianQwyfxEquityAdmitRequest.LogisticsAddressDomain();
obj2.AreaCode = "330481";
obj2.Address = "浙江省金华市东阳市浙江省-金华市-东阳市-吴宁街道吴宁镇竹园路";
obj2.Name = "张三";
obj2.Phone = "1234567855";
obj2.City = "金华市";
obj2.Area = "东阳市";
obj2.Province = "浙江省";
obj1.Sender= obj2;
AlipayBaoxianQwyfxEquityAdmitRequest.LogisticsAddressDomain obj3 = new AlipayBaoxianQwyfxEquityAdmitRequest.LogisticsAddressDomain();
obj3.AreaCode = "330481";
obj3.Address = "浙江省金华市东阳市浙江省-金华市-东阳市-吴宁街道吴宁镇竹园路";
obj3.Name = "张三";
obj3.Phone = "1234567855";
obj3.City = "金华市";
obj3.Area = "东阳市";
obj3.Province = "浙江省";
obj1.Receiver= obj3;
obj1.Entrance = "CAINIAO";
req.InsCheckUseEquityAdmitInfoRequest_ = obj1;
AlipayBaoxianQwyfxEquityAdmitResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlipayBaoxianQwyfxEquityAdmitRequest;
$ins_check_use_equity_admit_info_request = new InsCheckUseEquityAdmitInfoRequest;
$ins_check_use_equity_admit_info_request->biz_data="{     \"sender\":\"{\\"area\\":\\"浦东新区\\",\\"areaCode\\":\\"310115\\",\\"address\\":\\"永泰路311号\\",\\"province\\":\\"上海\\",\\"phone\\":\\"13408222131\\",\\"city\\":\\"上海\\",\\"name\\":\\"测试\\"}\",     \"receiver\":\"{\\"area\\":\\"浦东新区\\",\\"areaCode\\":\\"310115\\",\\"address\\":\\"永泰路311号\\",\\"province\\":\\"上海\\",\\"phone\\":\\"13408222131\\",\\"city\\":\\"上海\\",\\"name\\":\\"测试\\"}\",     \"reserveTime\":\"{\\"startTime\\":\\"2021-09-01 00:00:00\\",\\"endTime\\":\\"2021-09-01 12:00:00\\"}\",     \"goodsKinds\":\"衣服\",     \"entrance\":\"yfx\",     \"remark\":\"备注\" 	}";
$ins_check_use_equity_admit_info_request->equity_id="43433";
$ins_check_use_equity_admit_info_request->user_id="234334";
$ins_check_use_equity_admit_info_request->image_url="/oss/s233";
$ins_check_use_equity_admit_info_request->alipay_user_id="2088343443";
$ins_check_use_equity_admit_info_request->user_type="TAOBAO";
$ins_check_use_equity_admit_info_request->dispute_id="2343";
$ins_check_use_equity_admit_info_request->biz_order_id="12343";
$sender = new LogisticsAddress;
$sender->area_code="330481";
$sender->address="浙江省金华市东阳市浙江省-金华市-东阳市-吴宁街道吴宁镇竹园路";
$sender->name="张三";
$sender->phone="1234567855";
$sender->city="金华市";
$sender->area="东阳市";
$sender->province="浙江省";
$ins_check_use_equity_admit_info_request->sender = $sender;
$receiver = new LogisticsAddress;
$receiver->area_code="330481";
$receiver->address="浙江省金华市东阳市浙江省-金华市-东阳市-吴宁街道吴宁镇竹园路";
$receiver->name="张三";
$receiver->phone="1234567855";
$receiver->city="金华市";
$receiver->area="东阳市";
$receiver->province="浙江省";
$ins_check_use_equity_admit_info_request->receiver = $receiver;
$ins_check_use_equity_admit_info_request->entrance="CAINIAO";
$req->setInsCheckUseEquityAdmitInfoRequest(json_encode($ins_check_use_equity_admit_info_request));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alipay.baoxian.qwyfx.equity.admit' \
-d 'partner_id=apidoc' \
-d 'sign=F33EFDC2B89B50C003AAB714EB823FFD' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+15%3A07%3A37' \
-d 'v=2.0' \
-d 'ins_check_use_equity_admit_info_request=null'

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

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

req.ins_check_use_equity_admit_info_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,"alipay.baoxian.qwyfx.equity.admit");
add_param(pRequest,"ins_check_use_equity_admit_info_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('alipay.baoxian.qwyfx.equity.admit', {
	'ins_check_use_equity_admit_info_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alipay_baoxian_qwyfx_equity_admit_response>
    <qwyfx_success>true</qwyfx_success>
    <qwyfx_error_code>-1</qwyfx_error_code>
    <model>
        <is_admit>true</is_admit>
        <reject_code>0_delivery image</reject_code>
        <reject_reason>发货图片</reject_reason>
    </model>
    <error_msg>-1</error_msg>
    <is_success>true</is_success>
</alipay_baoxian_qwyfx_equity_admit_response>

{
    "alipay_baoxian_qwyfx_equity_admit_response":{
        "qwyfx_success":true,
        "qwyfx_error_code":"-1",
        "model":{
            "is_admit":true,
            "reject_code":"0_delivery image",
            "reject_reason":"发货图片"
        },
        "error_msg":"-1",
        "is_success":true
    }
}

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

alipay.baoxian.qwyfx.equity.admit (用户全网运费险使用权益准入)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ