淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
insurance_order_page_query_request	InsuranceOrderPageQueryRequest	可选			保单查询
└ gmt_create_start Date 可选 2024-05-10 14:58:06 创建开始时间 └ insurant_name String 可选被保人名字被保人名字 └ gmt_modified_end Date 可选 2024-05-10 14:58:06 修改结束时间 └ gmt_modified_start Date 可选 2024-05-10 14:58:06 修改开始时间 └ page_size Number 可选 20 分页大小 └ insurance_order_id Number 可选 1213 保单号 └ insurant_id Number 可选 121313 被保人id └ out_order_type Number 可选 1 外部单据类型，1服务单，2工单 └ gmt_effect_end Date 可选 2024-05-10 14:58:06 生效开始时间 └ out_id String 可选 1131 唯一键 └ insurance_application_no String 可选 131323 保单号 └ gmt_effect_start Date 可选 2024-05-10 14:58:06 生效开始时间 └ gmt_expiry_start Date 可选 2024-05-10 14:58:06 失效开始时间 └ gmt_create_end Date 可选 2024-05-10 14:58:06 创建结束时间 └ insurant_phone String 可选 1 被保人手机号 └ product_code String 可选 WORKER_ACCIDENT_INSURANCE 保险产品编码 └ insurant_identity_id String 可选 12342314 被保人身份证号 └ page_index Number 可选 1 当前页 └ out_order_id String 可选 12341231 工单id,服务单id └ applicant_phone String 可选投保人手机号被保人身份证号 └ gmt_expiry_end Date 可选 2024-05-10 14:58:06 保单失效结束时间 └ status Number 可选 0 保单状态，0创建，1投保成功，2投保失败，3投保中，101退保成功，102退保失败，103退保中

名称	类型	示例值	描述
data	Data []		data
└ insurant_name String xxx 被保人 └ gmt_modified Date 1715069642000 修改时间 └ insure_fail_reason String 投保失败原因 insureFailReason └ service_code String HANKAIJIECESHIANZHUANGFUWU493A serviceCode └ biz_code String tm_appliance_install_licensing bizCode └ insurant_id Number 213123214 被保人id └ service_unit_price Number 1 服务费单价 └ endorse_application_no String 2134214123 批改单申请号 └ service_total_price Number 1 服务费总价 └ total_insurance_amount Number 1200000 总保额 └ gmt_auction_trade_success Date 1715216400000 实物确认收货时间 └ out_order_type Number 2 外部单据类型，1服务单，2工单 └ out_id String 908662004_2_WORKER_ACCIDENT_INSURANCE outId └ reverse_fail_reason String 退保失败原因退保失败原因 └ id Number 240507103300272000 id └ insurance_application_no String 保单号保单号 └ gmt_expiry Date 1715065286000 失效时间 └ insurance_unit_price Number 3 投保费 └ insurance_total_price Number 3 投保费总价 └ gmt_create Date 1715065287000 创建时间 └ total_insurance_shares Number 1 保险份数 └ endorse_fail_reason String 批改失败原因批改失败原因 └ insurance_company_name String 保险公司名称保险公司名称 └ remain_insurance_amount Number 1200000 剩余保额 └ remain_insurance_shares Number 1 剩余保险份数 └ insurant_phone String 182xxxx4307 被保人手机号 └ product_code String WORKER_ACCIDENT_INSURANCE 保险产品编码 └ out_order_id String 908662004 工单或者服务单号 └ gmt_effect Date 1715216400000 保单生效时间 └ attributes String {"workcardActionTime":"1715069640000","workcardCancelTime":"1715069640000","workcardAction":"cancel"} 扩展信息 └ insurant_type Number 3 被保人类型 └ status Number 101 保单状态，0创建，1投保成功，2投保失败，3投保中，101退保成功，102退保失败，103退保中 └ insurant_identity_id String xxxxxxxxxx 被保人身份证号
error_message	String	错误信息	errorMessage
page_size	Number	1	pageSize
total_count	Number	80	totalCount
fail	Boolean	false	fail
display_message	String	错误信息	displayMessage
page_index	Number	1	pageIndex
total_pages	Number	80	totalPages

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaYichaoInsuranceQueryRequest req = new AlibabaYichaoInsuranceQueryRequest();
AlibabaYichaoInsuranceQueryRequest.InsuranceOrderPageQueryRequest obj1 = new AlibabaYichaoInsuranceQueryRequest.InsuranceOrderPageQueryRequest();
obj1.setGmtCreateStart(StringUtils.parseDateTime("2024-05-10 14:58:06"));
obj1.setInsurantName("被保人名字");
obj1.setGmtModifiedEnd(StringUtils.parseDateTime("2024-05-10 14:58:06"));
obj1.setGmtModifiedStart(StringUtils.parseDateTime("2024-05-10 14:58:06"));
obj1.setPageSize(20L);
obj1.setInsuranceOrderId(1213L);
obj1.setInsurantId(121313L);
obj1.setOutOrderType(1L);
obj1.setGmtEffectEnd(StringUtils.parseDateTime("2024-05-10 14:58:06"));
obj1.setOutId("1131");
obj1.setInsuranceApplicationNo("131323");
obj1.setGmtEffectStart(StringUtils.parseDateTime("2024-05-10 14:58:06"));
obj1.setGmtExpiryStart(StringUtils.parseDateTime("2024-05-10 14:58:06"));
obj1.setGmtCreateEnd(StringUtils.parseDateTime("2024-05-10 14:58:06"));
obj1.setInsurantPhone("1");
obj1.setProductCode("WORKER_ACCIDENT_INSURANCE");
obj1.setInsurantIdentityId("12342314");
obj1.setPageIndex(1L);
obj1.setOutOrderId("12341231");
obj1.setApplicantPhone("投保人手机号");
obj1.setGmtExpiryEnd(StringUtils.parseDateTime("2024-05-10 14:58:06"));
obj1.setStatus(0L);
req.setInsuranceOrderPageQueryRequest(obj1);
AlibabaYichaoInsuranceQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaYichaoInsuranceQueryRequest req = new AlibabaYichaoInsuranceQueryRequest();
AlibabaYichaoInsuranceQueryRequest.InsuranceOrderPageQueryRequestDomain obj1 = new AlibabaYichaoInsuranceQueryRequest.InsuranceOrderPageQueryRequestDomain();
obj1.GmtCreateStart = DateTime.Parse(2024-05-10 14:58:06");
obj1.InsurantName = "被保人名字";
obj1.GmtModifiedEnd = DateTime.Parse(2024-05-10 14:58:06");
obj1.GmtModifiedStart = DateTime.Parse(2024-05-10 14:58:06");
obj1.PageSize = 20L;
obj1.InsuranceOrderId = 1213L;
obj1.InsurantId = 121313L;
obj1.OutOrderType = 1L;
obj1.GmtEffectEnd = DateTime.Parse(2024-05-10 14:58:06");
obj1.OutId = "1131";
obj1.InsuranceApplicationNo = "131323";
obj1.GmtEffectStart = DateTime.Parse(2024-05-10 14:58:06");
obj1.GmtExpiryStart = DateTime.Parse(2024-05-10 14:58:06");
obj1.GmtCreateEnd = DateTime.Parse(2024-05-10 14:58:06");
obj1.InsurantPhone = "1";
obj1.ProductCode = "WORKER_ACCIDENT_INSURANCE";
obj1.InsurantIdentityId = "12342314";
obj1.PageIndex = 1L;
obj1.OutOrderId = "12341231";
obj1.ApplicantPhone = "投保人手机号";
obj1.GmtExpiryEnd = DateTime.Parse(2024-05-10 14:58:06");
obj1.Status = 0L;
req.InsuranceOrderPageQueryRequest_ = obj1;
AlibabaYichaoInsuranceQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaYichaoInsuranceQueryRequest;
$insurance_order_page_query_request = new InsuranceOrderPageQueryRequest;
$insurance_order_page_query_request->gmt_create_start="2024-05-10 14:58:06";
$insurance_order_page_query_request->insurant_name="被保人名字";
$insurance_order_page_query_request->gmt_modified_end="2024-05-10 14:58:06";
$insurance_order_page_query_request->gmt_modified_start="2024-05-10 14:58:06";
$insurance_order_page_query_request->page_size="20";
$insurance_order_page_query_request->insurance_order_id="1213";
$insurance_order_page_query_request->insurant_id="121313";
$insurance_order_page_query_request->out_order_type="1";
$insurance_order_page_query_request->gmt_effect_end="2024-05-10 14:58:06";
$insurance_order_page_query_request->out_id="1131";
$insurance_order_page_query_request->insurance_application_no="131323";
$insurance_order_page_query_request->gmt_effect_start="2024-05-10 14:58:06";
$insurance_order_page_query_request->gmt_expiry_start="2024-05-10 14:58:06";
$insurance_order_page_query_request->gmt_create_end="2024-05-10 14:58:06";
$insurance_order_page_query_request->insurant_phone="1";
$insurance_order_page_query_request->product_code="WORKER_ACCIDENT_INSURANCE";
$insurance_order_page_query_request->insurant_identity_id="12342314";
$insurance_order_page_query_request->page_index="1";
$insurance_order_page_query_request->out_order_id="12341231";
$insurance_order_page_query_request->applicant_phone="投保人手机号";
$insurance_order_page_query_request->gmt_expiry_end="2024-05-10 14:58:06";
$insurance_order_page_query_request->status="0";
$req->setInsuranceOrderPageQueryRequest(json_encode($insurance_order_page_query_request));
$resp = $c->execute($req, $sessionKey);

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=alibaba.yichao.insurance.query' \
-d 'partner_id=apidoc' \
-d 'session=3c78c1eb-b53c-494f-90cf-57cd2895fc12' \
-d 'sign=AE0810A586B94CE78E38E87CA1E33A84' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A38%3A21' \
-d 'v=2.0' \
-d 'insurance_order_page_query_request=null'

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

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

req.insurance_order_page_query_request="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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,"alibaba.yichao.insurance.query");
add_param(pRequest,"insurance_order_page_query_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('alibaba.yichao.insurance.query', {
	'insurance_order_page_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_yichao_insurance_query_response>
    <data>
        <data>
            <insurant_name>xxx</insurant_name>
            <gmt_modified>1715069642000</gmt_modified>
            <insure_fail_reason>投保失败原因</insure_fail_reason>
            <service_code>HANKAIJIECESHIANZHUANGFUWU493A</service_code>
            <biz_code>tm_appliance_install_licensing</biz_code>
            <insurant_id>213123214</insurant_id>
            <service_unit_price>1</service_unit_price>
            <endorse_application_no>2134214123</endorse_application_no>
            <service_total_price>1</service_total_price>
            <total_insurance_amount>1200000</total_insurance_amount>
            <gmt_auction_trade_success>1715216400000</gmt_auction_trade_success>
            <out_order_type>2</out_order_type>
            <out_id>908662004_2_WORKER_ACCIDENT_INSURANCE</out_id>
            <reverse_fail_reason>退保失败原因</reverse_fail_reason>
            <id>240507103300272000</id>
            <insurance_application_no>保单号</insurance_application_no>
            <gmt_expiry>1715065286000</gmt_expiry>
            <insurance_unit_price>3</insurance_unit_price>
            <insurance_total_price>3</insurance_total_price>
            <gmt_create>1715065287000</gmt_create>
            <total_insurance_shares>1</total_insurance_shares>
            <endorse_fail_reason>批改失败原因</endorse_fail_reason>
            <insurance_company_name>保险公司名称</insurance_company_name>
            <remain_insurance_amount>1200000</remain_insurance_amount>
            <remain_insurance_shares>1</remain_insurance_shares>
            <insurant_phone>182xxxx4307</insurant_phone>
            <product_code>WORKER_ACCIDENT_INSURANCE</product_code>
            <out_order_id>908662004</out_order_id>
            <gmt_effect>1715216400000</gmt_effect>
            <attributes>{&quot;workcardActionTime&quot;:&quot;1715069640000&quot;,&quot;workcardCancelTime&quot;:&quot;1715069640000&quot;,&quot;workcardAction&quot;:&quot;cancel&quot;}</attributes>
            <insurant_type>3</insurant_type>
            <status>101</status>
            <insurant_identity_id>xxxxxxxxxx</insurant_identity_id>
        </data>
    </data>
    <error_message>错误信息</error_message>
    <page_size>1</page_size>
    <total_count>80</total_count>
    <fail>false</fail>
    <display_message>错误信息</display_message>
    <page_index>1</page_index>
    <total_pages>80</total_pages>
</alibaba_yichao_insurance_query_response>

{
    "alibaba_yichao_insurance_query_response":{
        "data":{
            "data":[
                {
                    "insurant_name":"xxx",
                    "gmt_modified":"1715069642000",
                    "insure_fail_reason":"投保失败原因",
                    "service_code":"HANKAIJIECESHIANZHUANGFUWU493A",
                    "biz_code":"tm_appliance_install_licensing",
                    "insurant_id":213123214,
                    "service_unit_price":1,
                    "endorse_application_no":"2134214123",
                    "service_total_price":1,
                    "total_insurance_amount":1200000,
                    "gmt_auction_trade_success":"1715216400000",
                    "out_order_type":2,
                    "out_id":"908662004_2_WORKER_ACCIDENT_INSURANCE",
                    "reverse_fail_reason":"退保失败原因",
                    "id":240507103300272000,
                    "insurance_application_no":"保单号",
                    "gmt_expiry":"1715065286000",
                    "insurance_unit_price":3,
                    "insurance_total_price":3,
                    "gmt_create":"1715065287000",
                    "total_insurance_shares":1,
                    "endorse_fail_reason":"批改失败原因",
                    "insurance_company_name":"保险公司名称",
                    "remain_insurance_amount":1200000,
                    "remain_insurance_shares":1,
                    "insurant_phone":"182xxxx4307",
                    "product_code":"WORKER_ACCIDENT_INSURANCE",
                    "out_order_id":"908662004",
                    "gmt_effect":"1715216400000",
                    "attributes":"{\"workcardActionTime\":\"1715069640000\",\"workcardCancelTime\":\"1715069640000\",\"workcardAction\":\"cancel\"}",
                    "insurant_type":3,
                    "status":101,
                    "insurant_identity_id":"xxxxxxxxxx"
                }
            ]
        },
        "error_message":"错误信息",
        "page_size":1,
        "total_count":80,
        "fail":false,
        "display_message":"错误信息",
        "page_index":1,
        "total_pages":80
    }
}

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下载

开放平台

天猫服务平台

alibaba.yichao.insurance.query (蚁巢保单查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ