订单下单接口

该下单接口返回不一定是预约成功，消息推送会通知最终订单状态

请求URL:

https://m-api.lejian.com/open-api/V2/order/bookByStandard?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN

请求协议：HTTPS
请求方式：POST
需要签名: 是
URL参数:
参数名 是否必须 类型 说明
accessToken 是 string 当前有效的accessToken
nonce 是 string 当前有效的nonce
sign 是 string 数据sign值

关于nonce和sign请查看 数据签名。

POST参数示例
  1. {
  2.     "examDate":"2017-09-18",
  3.     "examTimeIntervalId":1020,
  4.     "mealId":12878,
  5.     "hospitalId":2188,
  6.     "mobile":"18668182661",
  7.     "examAccountName":"测试A",
  8.     "idType":1,
  9.     "idCard":"220102199003077434",
  10.     "married":1,
  11.     "gender":0,
  12.     "age":30,
  13.     "bookBirthYear":1990,
  14.     "bookDateBirth":"0307",
  15.     "pkgIds":[1,2,3],
  16.     "companyId":4308812,
  17.     "thirdNum":"1471656381419081728"
  18. }
参数名 是否必须 类型 说明
examDate 是 string 体检日期（格式：yyyy-mm-dd）
examTimeIntervalId 否 int 体检时段，取返回值period,参考套餐排期
mealId 是 int 套餐编码
hospitalId 是 int 体检中心id
pkgIds 否 Array[] 加项包集合id
mobile 是 string 体检人手机号码
idCard 是 string 体检人证件号
examAccountName 是 string 体检人姓名
married 是 int 婚否，0:未婚，1：已婚 注：女性套餐的部分项目只有已婚女性才能做
gender 是 int 性别 0：男 1：女
age 是 int 年龄
bookBirthYear 是 int 出生年份
bookDateBirth 是 string 月日
companyId 否 int 单位， 默认为空，特殊逻辑情况下，乐荐这边会提供
orderPrice 否 int 订单实际销售价格（价格可以不传，如果传入的话会校验系统价格是否匹配，为空时默认为套餐+加项包价格）
idType 是 int 证件类型 默认身份证 1:身份证 2：护照 3：军官证 4：港澳身份证 5：台胞证 0：其他； 注意：检查机构是否支持2，3，4请查看体检中心查询接口的返回值supportMultipleCertificate
thirdNum 否 string 第三方订单号 (一个外部订单号只对应一个正常状态的乐荐订单)

返回示例:

正确时返回:

  1.  {
  2.     "success":"T",
  3.     "data":{
  4.             "examDate":"2017-09-18 12:00:00",
  5.             "hospitalId":23,
  6.             "hospitalName":"浙江省中医院下沙院区体检中心",
  7.             "items": [
  8.                 {
  9.                     "name":"血压",
  10.                     "price":0
  11.                 }
  12.             ],
  13.             "mealName":"普通入职体检(男)"
  14.             "orderNum":"20170822194904339001236",
  15.             "orderPrice":17500,
  16.             "status":21
  17.     },
  18.     "msg":"success"
  19. }

返回参数说明:

参数名 类型 说明
hospitalName String 体检中心名称
hospitalId int 体检中心id
mealName string 套餐名称
orderPrice int 订单价格
orderNum string 订单号
examDate string 体检日期
status int 订单状态，可能会存在中间态，如预约中，对接消息推送会获取终态
items JSONObject 订单单项

订单状态对照表

状态 说明
0 待支付
2 预约成功
21 预约中
3 体检完成
4 改期成功
41 改期中
5 撤销成功
51 撤销中
6 删除
8 关闭
9 部分退


注意：黑体加粗状态只会出现在爱康、美年、瑞慈、慈铭民营医院

主要异常场景：
1、下单失败,原因:{0}
注意：此处失败的原因常见为：人数不足、性别不符、婚否不符等

  1.  {
  2.     "success":"F",
  3.     "errCode":"201006",
  4.     "msg":"Order book fail,reason:{0}"  //0为具体异常信息
  5. }

2、入参必传字段为空

  1.  {
  2.     "success":"F",
  3.     "errCode":"201003",
  4.     "msg":"Book fields is null: {0}"  //0为具体异常信息
  5. }

3、渠道账户余额不足，需要充值

  1.  {
  2.     "success":"F",
  3.     "errCode":"201012",
  4.     "msg":"balance not enough"
  5. }

备注:

文档更新时间: 2023-01-13 14:21