# 拉取保单信息

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：insurance_freight_getorderlist

本接口用于拉取保单信息

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/business/insurance_freight/getorderlist?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：139

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "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`

```json
[
  {
    "参数名": "total",
    "类型": "number",
    "说明": "总数"
  },
  {
    "参数名": "list",
    "类型": "objarray",
    "说明": "保单列表"
  }
]
```

">

### Res.list(Array) `Object Payload`

保单列表

```json
[
  {
    "参数名": "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`

保单状态

```json
[
  {
    "枚举值": "2",
    "描述": "保障中"
  },
  {
    "枚举值": "4",
    "描述": "理赔中"
  },
  {
    "枚举值": "5",
    "描述": "理赔成功"
  },
  {
    "枚举值": "6",
    "描述": "理赔失败"
  },
  {
    "枚举值": "7",
    "描述": "投保过期"
  }
]
```

### Body.sort_direct `Enum`

排序方式

```json
[
  {
    "枚举值": "0",
    "描述": "create_time正序"
  },
  {
    "枚举值": "1",
    "描述": "create_time倒序"
  }
]
```

__status">

### Res.list(Array).status `Enum`

保单状态

```json
[
  {
    "枚举值": "2",
    "描述": "保障中"
  },
  {
    "枚举值": "4",
    "描述": "理赔中"
  },
  {
    "枚举值": "5",
    "描述": "理赔成功"
  },
  {
    "枚举值": "6",
    "描述": "理赔失败"
  },
  {
    "枚举值": "7",
    "描述": "投保过期"
  }
]
```

__is_home_pick_up">

### Res.list(Array).is_home_pick_up `Enum`

是否上门取件

```json
[
  {
    "枚举值": "0",
    "描述": "否"
  },
  {
    "枚举值": "1",
    "描述": "是"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

请求示例

```json
{
    "status_list": [
        2, 4, 5
    ],
    "offset": 0,
    "limit": 20
}
```

返回示例

```json
{
    "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. 错误码

此接口没有特殊错误码，可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

## 8. 适用范围

本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明，均不可调用。