淘宝开放平台

请求地址：

环境	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_list_user_qwyfx_equity_request	InsListUserQwyfxEquityRequest	可选			权益列表请求参数
└ page_size Number 必须 10 分页大小 └ type String 可选 YFX_WYG_DISCOUNT_300 权益详细类型：YFX_WYG_DISCOUNT_300，QWYFX_DISCOUNT_INIT_FREIGHT 首重券，可以用来单独查询券类型 └ user_id Number 必须 2088302777333094 用户id └ page_num Number 必须 1 页码 └ alipay_user_id String 可选 2088302777333094 支付宝id └ biz_pd_code String 必须 YFX_WYG_DISCOUNT 权益类型（YFX_WYG_DISCOUNT）写死 └ user_type String 必须 TAOBAO 用户类型：TAOBAO,ALIPAY

名称	类型	示例值	描述
qwyfx_success	Boolean	true	是否成功
qwyfx_error_code	String	-1	错误码
model	InsListUserQwyfxEquityResponse		权益信息列表
└ page_num Number 1 页码 └ total_count Number 100 总数 benefit_list YfxUserBenefitDTO [] 权益列表 └ benefit_equity_id String 2303434 权益id └ effect_start_time Date 2022-09-01 00:00:00 权益开始时间 └ effect_end_time Date 2023-09-01 00:00:00 权益结束时间 └ type String YFX_WYG_DISCOUNT_300 权益类型:YFX_WYG_DISCOUNT_300 3元券，QWYFX_DISCOUNT_INIT_FREIGHT 首重券 └ name String 运费险减3元权益名称 └ desc String 运费险减3元权益描述 └ status Number 1 权益状态0:初始 1:"有效" 2:"失效" 5：锁定。你们默认取1 └ page_size Number 10 分页大小
error_msg	String	-1	错误信息
is_success	Boolean	true	是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlipayBaoxianQwyfxEquityListRequest req = new AlipayBaoxianQwyfxEquityListRequest();
AlipayBaoxianQwyfxEquityListRequest.InsListUserQwyfxEquityRequest obj1 = new AlipayBaoxianQwyfxEquityListRequest.InsListUserQwyfxEquityRequest();
obj1.setPageSize(10L);
obj1.setType("YFX_WYG_DISCOUNT_300");
obj1.setUserId(2088302777333094L);
obj1.setPageNum(1L);
obj1.setAlipayUserId("2088302777333094");
obj1.setBizPdCode("YFX_WYG_DISCOUNT");
obj1.setUserType("TAOBAO");
req.setInsListUserQwyfxEquityRequest(obj1);
AlipayBaoxianQwyfxEquityListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlipayBaoxianQwyfxEquityListRequest req = new AlipayBaoxianQwyfxEquityListRequest();
AlipayBaoxianQwyfxEquityListRequest.InsListUserQwyfxEquityRequestDomain obj1 = new AlipayBaoxianQwyfxEquityListRequest.InsListUserQwyfxEquityRequestDomain();
obj1.PageSize = 10L;
obj1.Type = "YFX_WYG_DISCOUNT_300";
obj1.UserId = 2088302777333094L;
obj1.PageNum = 1L;
obj1.AlipayUserId = "2088302777333094";
obj1.BizPdCode = "YFX_WYG_DISCOUNT";
obj1.UserType = "TAOBAO";
req.InsListUserQwyfxEquityRequest_ = obj1;
AlipayBaoxianQwyfxEquityListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlipayBaoxianQwyfxEquityListRequest;
$ins_list_user_qwyfx_equity_request = new InsListUserQwyfxEquityRequest;
$ins_list_user_qwyfx_equity_request->page_size="10";
$ins_list_user_qwyfx_equity_request->type="YFX_WYG_DISCOUNT_300";
$ins_list_user_qwyfx_equity_request->user_id="2088302777333094";
$ins_list_user_qwyfx_equity_request->page_num="1";
$ins_list_user_qwyfx_equity_request->alipay_user_id="2088302777333094";
$ins_list_user_qwyfx_equity_request->biz_pd_code="YFX_WYG_DISCOUNT";
$ins_list_user_qwyfx_equity_request->user_type="TAOBAO";
$req->setInsListUserQwyfxEquityRequest(json_encode($ins_list_user_qwyfx_equity_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.list' \
-d 'partner_id=apidoc' \
-d 'sign=E959880E83F5B45AC659DC583266BBCB' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+14%3A06%3A43' \
-d 'v=2.0' \
-d 'ins_list_user_qwyfx_equity_request=null'

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

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

req.ins_list_user_qwyfx_equity_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.list");
add_param(pRequest,"ins_list_user_qwyfx_equity_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.list', {
	'ins_list_user_qwyfx_equity_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alipay_baoxian_qwyfx_equity_list_response>
    <qwyfx_success>true</qwyfx_success>
    <qwyfx_error_code>-1</qwyfx_error_code>
    <model>
        <page_num>1</page_num>
        <total_count>100</total_count>
        <benefit_list>
            <yfx_user_benefit_d_t_o>
                <benefit_equity_id>2303434</benefit_equity_id>
                <effect_start_time>2022-09-01 00:00:00</effect_start_time>
                <effect_end_time>2023-09-01 00:00:00</effect_end_time>
                <type>YFX_WYG_DISCOUNT_300</type>
                <name>运费险减3元</name>
                <desc>运费险减3元</desc>
                <status>1</status>
            </yfx_user_benefit_d_t_o>
        </benefit_list>
        <page_size>10</page_size>
    </model>
    <error_msg>-1</error_msg>
    <is_success>true</is_success>
</alipay_baoxian_qwyfx_equity_list_response>

{
    "alipay_baoxian_qwyfx_equity_list_response":{
        "qwyfx_success":true,
        "qwyfx_error_code":"-1",
        "model":{
            "page_num":1,
            "total_count":100,
            "benefit_list":{
                "yfx_user_benefit_d_t_o":[
                    {
                        "benefit_equity_id":"2303434",
                        "effect_start_time":"2022-09-01 00:00:00",
                        "effect_end_time":"2023-09-01 00:00:00",
                        "type":"YFX_WYG_DISCOUNT_300",
                        "name":"运费险减3元",
                        "desc":"运费险减3元",
                        "status":1
                    }
                ]
            },
            "page_size":10
        },
        "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.list (用户全网运费险权益列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ