文档中心 > API类目 > 阿里健康-本地医疗-通用预约服务

qimen.alibaba.alihealth.medical.reservation.reserve (预约)

阿里健康消费医疗,通用发起预约接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
isvStoreId String 可选 123 服务商系统的门店id
scheduledFinishTime String 可选 2021-07-20 00:00:00 预约结束时间
consumerAddress ConsumerAddress 可选 消费地址信息
  • └ address
  • String
  • 可选
  • 阿里巴巴
  • 地址
  • └ districtCode
  • String
  • 可选
  • 330106
  • 区域码
  • └ cityName
  • String
  • 可选
  • 杭州市
  • 城市名
  • └ districtName
  • String
  • 可选
  • 西湖区
  • 区域名
  • └ cityCode
  • String
  • 可选
  • 330100
  • 城市码
  • └ countryCode
  • String
  • 可选
  • 100000
  • 国家码
  • └ provinceCode
  • String
  • 可选
  • 330000
  • 省份码
  • └ latitude
  • String
  • 可选
  • 30.266786
  • 纬度
  • └ countryName
  • String
  • 可选
  • 中华人民共和国
  • 国家名
  • └ provinceName
  • String
  • 可选
  • 浙江省
  • 省份名
  • └ longitude
  • String
  • 可选
  • 120.10675
  • 经度
scheduledTime String 可选 2021-07-20 00:00:00 预约开始时间
reservationResource QuantityOfResources [] 可选
  • 最大列表长度:999999
  • 预约资源
    • └ quantity
    • Number
    • 可选
    • 1
    • 数量
    • └ isvItemSkuId
    • String
    • 可选
    • ITEM_SKU_01
    • 服务商系统的skuId,如果是在商家后台发品,对应”服务商系统的套餐ID“字段
    alihealthReservationRecordId String 可选 1600000092410004122 阿里健康预约记录id
    consumer Consumer 可选 预约人信息
    • └ birthday
    • String
    • 可选
    • 2021-07-20
    • 生日
    • └ phoneNumber
    • String
    • 可选
    • 18673331416
    • 手机号
    • └ gender
    • String
    • 可选
    • MALE
    • 性别(MALE:男 FEMALE:女)
    • └ name
    • String
    • 可选
    • 啊里健康测试验收
    • 姓名
    • └ certificateNo
    • String
    • 可选
    • 430221199012045614
    • 证件号码
    • └ maritalStatus
    • String
    • 可选
    • UNMARRIED
    • 婚姻状况(UNMARRIED:未婚 MARRIED:已婚)
    • └ certificateType
    • String
    • 可选
    • ID_CARD
    • 证件类型(ID_CARD:身份证,PASSPORT:护照)
    serviceSiteType String 可选 TO_DOOR 服务地址类型(TO_DOOR:上门服务 TO_STORE:到店服务)
    bizSiteIdentity String 可选 ALIPAY 预约归属业务域标识(支付宝:ALIPAY,天猫:TMALL)
    orderId String 可选 3877397065908155240 订单id

    响应参数

    名称 类型 示例值 描述
    isvReservationRecordId String 12345678 isv预约记录id。长度不超过64位
    resultStatus String SUCCESS 预约结果,值是以下几种: SUCCESS:预约成功。 ACCEPT:收到预约请求,需要二次确认。此时预约状态为预约中,需要isv调alibaba.alihealth.medical.reservation.confirm接口确认预约 FAIL:预约失败 UNKNOWN:未知
    resultCode String RESERVATION_CONFIRMING 由isv定义并且返回
    resultMsg String CONFIRMING 结果信息
    voucherCode String QASSD6123AADS 预约电子凭证码值,若返回凭证码值,会展示在订单详情。用户到店/上门后,可以通过该码值来验证订单,不同预约码值不能重复。长度不超过64位

    请求示例

    {"isvStoreId":"123","scheduledFinishTime":"2021-07-20 00:00:00","consumerAddress":{"address":"阿里巴巴","districtCode":"330106","cityName":"杭州市","districtName":"西湖区","cityCode":"330100","countryCode":"100000","provinceCode":"330000","latitude":"30.266786","countryName":"中华人民共和国","provinceName":"浙江省","longitude":"120.10675"},"scheduledTime":"2021-07-20 00:00:00","orderId":"3877397065908155240","reservationResource":[{"isvItemSkuId":"ITEM_SKU_01","quantity":1}],"alihealthReservationRecordId":"1600000092410004122","consumer":{"birthday":"2021-07-20","phoneNumber":"18673331416","gender":"MALE","name":"啊里健康测试验收","certificateNo":"430221199012045614","maritalStatus":"UNMARRIED","certificateType":"ID_CARD"},"serviceSiteType":"TO_DOOR","bizSiteIdentity":"ALIPAY"}

    响应示例

    {
        "isvReservationRecordId":"12345678",
        "resultStatus":"SUCCESS",
        "resultCode":"RESERVATION_CONFIRMING",
        "resultMsg":"CONFIRMING",
        "voucherCode":"QASSD6123AADS"
    }

    验签示例

    {"resultStatus":"UNKNOWN","resultCode":"sign-check-failure","resultMsg":"Illegal request"}

    错误码解释

    错误码 错误描述 解决方案
    isp.http-read-timeout
    response-body-parse-error
    isp.http-closed
    isp.http-connection-timeout

    API工具

    FAQ

    返回
    顶部