# 发货时投保
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:insurance_freight_createorder
本接口用于发货时投保
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/insurance_freight/createorder?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,必须和理赔openid一致 |
| order_no | string | 是 | 微信支付单号,一个微信支付单号只能投保一次 |
| pay_time | number | 是 | 微信支付时间,秒级时间戳,时间误差3天内 |
| pay_amount | number | 是 | 微信支付金额(单位:分) |
| delivery_no | string | 是 | 发货运单号 |
| delivery_place | object | 是 | 发货地址 |
| receipt_place | object | 是 | 收货地址 |
| product_info | object | 是 | 投保订单信息,用于微信下发投保和理赔通知给用户,用户点击可查看投保订单,点击订单可跳回商家小程序 |
# Body.delivery_place Object Payload
发货地址
以下参数也使用此结构:
- Body.receipt_place : 收货地址
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| province | string | 是 | 省 |
| city | string | 是 | 市 |
| county | string | 是 | 区 |
| address | string | 是 | 详细地址 |
# Body.product_info Object Payload
投保订单信息,用于微信下发投保和理赔通知给用户,用户点击可查看投保订单,点击订单可跳回商家小程序
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| order_path | string | 是 | 投保订单在商家小程序的path |
| goods_list | objarray | 是 | 投保商品list,一个元素为对象的数组 |
# Body.product_info.goods_list(Array) Object Payload
投保商品list,一个元素为对象的数组
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 投保商品名称 |
| url | string | 是 | 投保商品图片url |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| policy_no | string | 保单号 |
| insurance_end_date | string | 保险止期,格式: yyyy-mm-dd hh24:mi:ss |
| estimate_amount | number | 保险公司预估理赔金额,单位: 分 |
| premium | number | 保费,单位: 分 |
| errcode | number | 错误码 |
| errmsg | string | 错误描述 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"openid":"oZGTP5DwGDPfEf1EBBHH_oxHw2aU",
"order_no": "4200001197202103228672982585",
"pay_amount": 1,
"pay_time": 1679473667,
"delivery_place":{
"province":"广东省",
"city": "广州市",
"county": "海珠区",
"address": "创业园23号"
},
"receipt_place":{
"province":"广东省",
"city": "惠州市",
"county": "惠普区",
"address": "龙山村10-2"
},
"delivery_no": "d20230322001"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"policy_no": "10288003264673876282",
"insurance_end_date": "2023-06-20 16:36:54",
"estimate_amount": 1200
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 41009 | missing openid |
# 7. 适用范围
本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明,均不可调用。