# 拉取保单信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:insurance_freight_getorderlist
本接口用于拉取保单信息
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/insurance_freight/getorderlist?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:139
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 | 枚举 |
|---|---|---|---|---|
| openid | string | 否 | 买家openid,与投保理赔保持一致 | - |
| order_no | string | 否 | 微信支付单号,与投保理赔保持一致 | - |
| policy_no | string | 否 | 保单号 | - |
| report_no | string | 否 | 理赔报案号 | - |
| delivery_no | string | 否 | 发货运单号 | - |
| refund_delivery_no | string | 否 | 退款运单号 | - |
| begin_time | number | 否 | 查询开始时间,秒级时间戳 | - |
| end_time | number | 否 | 查询结束时间,秒级时间戳 | - |
| status_list | numarray | 否 | 保单状态 | 枚举值 |
| offset | number | 否 | 分页offset | - |
| limit | number | 否 | 分页limit(默认为100,最大为100) | - |
| sort_direct | number | 否 | 排序方式 | 枚举值 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| total | number | 总数 |
| list | objarray | 保单列表 |
# Res.list(Array) Object Payload
保单列表
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| order_no | string | 微信支付单号 | - |
| policy_no | string | 保单号 | - |
| report_no | string | 理赔报案号 | - |
| delivery_no | string | 发货运单号 | - |
| refund_delivery_no | string | 退款运单号 | - |
| premium | number | 保费(单位:分 ) | - |
| estimate_amount | number | 预估理赔金额(单位:分 ) | - |
| status | number | 保单状态 | 枚举值 |
| pay_fail_reason | string | 理赔打款失败原因 | - |
| pay_finish_time | number | 理赔款打给用户的时间 | - |
| is_home_pick_up | number | 是否上门取件 | 枚举值 |
# 4. 枚举信息
# Body.status_list Enum
保单状态
| 枚举值 | 描述 |
|---|---|
| 2 | 保障中 |
| 4 | 理赔中 |
| 5 | 理赔成功 |
| 6 | 理赔失败 |
| 7 | 投保过期 |
# Body.sort_direct Enum
排序方式
| 枚举值 | 描述 |
|---|---|
| 0 | create_time正序 |
| 1 | create_time倒序 |
# Res.list(Array).status Enum
保单状态
| 枚举值 | 描述 |
|---|---|
| 2 | 保障中 |
| 4 | 理赔中 |
| 5 | 理赔成功 |
| 6 | 理赔失败 |
| 7 | 投保过期 |
# Res.list(Array).is_home_pick_up Enum
是否上门取件
| 枚举值 | 描述 |
|---|---|
| 0 | 否 |
| 1 | 是 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
{
"status_list": [
2, 4, 5
],
"offset": 0,
"limit": 20
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"list": [
{
"order_no": "4200001197202103228672982584",
"policy_no": "10288003264673876281",
"report_no": "",
"status": 2,
"insurance_end_date": "2023-06-14 19:41:34",
"premium": 20,
"estimate_amount": 1200,
"delivery_no": "delivery20230321001",
"refund_delivery_no": "delivery20230322001",
"is_home_pick_up": 1
},
{
"order_no": "4200001197202103228672982585",
"policy_no": "10288003264673876282",
"report_no": "90581008120350195232",
"status": 4,
"insurance_end_date": "2023-06-20 16:36:54",
"premium": 20,
"estimate_amount": 1200,
"delivery_no": "delivery20230322001",
"refund_delivery_no": "delivery20230322001",
"is_home_pick_up": 1
}
],
"total": 2
}
# 7. 错误码
此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 8. 适用范围
本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明,均不可调用。