订单时段查询简单说明:
开放平台提供了根据下单时间段查询批量查询的接口。
接口最多一次查询7天数据,每次查询最多返回50条数据。开发者可根据返回数据中的hasNextPage字段判断是否有下一页数据。根据currentPage(当前页码),并使用pageOffset参数(currentPage+1)指定数据页码。
请求地址: https://m-api.lejian.com/open-api/V2/order/queryOrder?accessToken=ACCESS_TOKEN
请求协议:HTTPS
请求方式:POST
需要签名:否
URL参数:
| 参数名 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| accessToken | 是 | string | 当前有效的accessToken |
| pageOffset | 否 | integer | 页码 |
POST参数示例
{"beginDate":"2017-08-10","endDate":"2017-08-16","pageOffset":"2"}
| 参数名 | 是否必须 | 类型 | 说明 |
|---|---|---|---|
| beginDate | 是 | string | 开始查询时间 |
| endDate | 是 | string | 结束查询时间 |
| pageOffset | 是 | integer | 数据分页时的页码,如果返回数据hasNextPage为true,则 pageOffset = currentPage+1 |
起始时间和结束时间跨度最大不超过7天,且结束时间当天的订单不会被查询。
返回示例:
{"success":"T","data":{"currentPage":1,"hasNextPage":false,"orders":[{"mealName":"套餐名称","orderNum":"20170602182719769255420","status":2,"exportStatus":0"hospitalName":"体检中心名称","hospitalId":"1","createTime":"2017-06-02 06:27:19","examDate":"2017-06-20 12:00:00","orderPrice":2000,"items":[{"name":"内科检查1","price":1000},{"name":"耳鼻喉科","price":1000}]}]},"msg":"success"}
返回参数说明:
通俗易懂的参数不再说明
| 字段 | 类型 | 说明 |
|---|---|---|
| currentPage | integer | 当前页码 |
| hasNextPage | boolean | 本次查询是否还有下一页数据 |
| orders | Array | 订单列表 |
| items | JSONObject | 订单单项 |
| exportStatus | integer | 订单导出状态(0:未导出 1:已导出) |
| refundAmount | integer | 订单退款金额(当订单状态为examined时,会返回) |
| openId | String | 用户在开放平台的唯一标识(用户注册下单则返回该信息) |
| status | int | 订单状态,可能民营机构会存在中间态,如预约中,对接消息推送会获取终态 |
注意:公立医院订单导出状态指的是该订单信息是否进入到体检中心系统,如果为已导出状态(错误码:201017),说明该订单已经进入体检中心系统,接口不能进行改期和撤销操作,如果确实需要进行以上操作,请人工联系每天健康客服
status对照表状态流转
| 状态 | 说明 |
|---|---|
| 0 | 待支付 |
| 2 | 已预约 |
| 20 | 预约失败 |
| 21 | 预约中 |
| 3 | 体检完成 |
| 41 | 改期中 |
| 5 | 已撤销 |
| 51 | 撤销中 |
| 6 | 删除 |
| 8 | 关闭 |
注意:黑体加粗状态只会出现在爱康、美年、瑞慈、慈铭民营医院
备注:
- 更多返回错误代码请看接口返回码说明
文档更新时间: 2021-07-28 09:29