淘宝开放平台

登录
文档中心 > API类目 > 体检机构API

体检机构API

alibaba.alihealth.examination.goods.publish (体检机构对接_商品发布／更新)

体检机构对接_商品发布／更新

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
group_id String 必须 001
  • 最大长度：100
    		•  商品id，机构保证全局唯一
    group_name String 必须 精英套餐
  • 最大长度：100
    		•  商品名称
    package_list Package [] 可选
  • 最大列表长度：200
    		•  套餐列表
    • └ contract_price
    • String
    • 必须
    • 13000
    • 售卖价（单位分）（数值需要大于100，且大于settlement_price字段的数值），精确到分，民营商品必需要，并且一个商品组下面的所有套餐售卖价必须一样
    • item_list
    • Item []
    • 可选
    • 体检项列表
    • └ title
    • String
    • 必须
    • 基础五项
    • 体检标题
    • └ detail
    • String
    • 可选
    • 身高、体重
    • 体检项描述
    • └ sub_title
    • String
    • 可选
    • 体检五项
    • 子标题
    • └ item_code
    • String
    • 可选
    • JK001
    • 体检项编码
    • └ item_group_code
    • String
    • 可选
    • JK
    • 体检组编码
    • └ item_group_weight
    • String
    • 可选
    • 9
    • 体检组显示权重
    • └ settlement_price
    • String
    • 必须
    • 12000
    • 结算价（单位分）（数值需要大于100），精确到分
    • └ package_code
    • String
    • 必须
    • 001
    • 套餐代码，机构保证全局唯一
    • └ package_name
    • String
    • 可选
    • 精英男士
    • 套餐名称（必填！！！）
    • └ package_detail
    • String
    • 可选
    • 男士选择
    • 最多500个字，套餐详情
    • └ gender
    • String
    • 必须
    • 0
    • 性别（0：男，1：女，2：通用）
    • └ marital_status
    • String
    • 必须
    • 2
    • 婚否（0：未婚，1：已婚，2：通用）
    • └ labels
    • String []
    • 可选
    • 套餐类型标签
    • T+1生效，体检业务：入职体检,父母体检,女性体检,中青年体检,肿瘤筛查,肠胃套餐,健康证,儿童体检,婚前孕前,高端体检,核酸检测,妇科检查,特价体检,证件体检,专科检查,健康优选,减重服务 护理/检测业务：上门换药,陪诊/陪护,小儿护理,日常护理,置管护理,上门核酸,上门体检,传染病检测,慢病检测,肿瘤早筛,甲状腺检测,专项检测,卵巢检测,打针/采血,核酸团检,中医养生,过敏原检测,小儿检测,基因检测,皮肤检测,过敏检测,肠胃检查,甲状腺检查 心理健康业务：心理测评,心理咨询,在线咨询,情感分析,情感顾问,测评,心理医生,咨询,心理辅导,情感咨询,心理电话咨询,心理门店咨询,恋爱情感,焦虑缓解,职业规划,家庭教育,一对一服务,猜你喜欢,推荐,专家课程,线上陪伴营,专家预约,团体治疗,亲子关系,抑郁焦虑 口腔齿科业务：洗牙,儿童口腔,美白,拔牙,烤瓷牙; 多个请用逗号分隔，不建议跨行业/业务使用上述标签；个人到店核酸检测请选择'核酸检测', 上门核酸检测请选择'上门核酸', 上门核酸团检请选择'核酸团检'
    • └ feature_item
    • String []
    • 可选
    • 体检项目标签
    • T+1生效，体检业务：三高检测,肿瘤筛查,前列腺检查,宫颈癌筛查,妇科检查,甲状腺检查,心脑血管检查,胸肺部检查,肝胆检查,乳腺检查,颈椎腰椎,肠胃疾病,专项检查,脱发检测,脊椎检测 心理健康业务：1V1专业沟通,专业量表,全面报告,专业心理评估,60分钟深入咨询,个性化定制方案,系统稳定咨询 口腔齿科业务：预防牙周病,清洁牙齿,清除色素,效果更佳,牙齿防蛀,重点保护,促进钙化,全口防蛀,一次搞定,全面检查,赠送X光片,进口树脂,美观耐用,纳米树脂,及时止龋,为换牙护航,微创拔牙,解除隐患,预防感染,进口材料,SPA式体验,不酸不痛,牙齿美白,数字化定制,仿若真牙,认证医生,专业服务; 多个请用逗号分隔，不建议跨行业/业务使用上述标签
    • └ detail_image
    • String
    • 可选
    • 套餐详情头图图片url（传前先找运营同学要图片规范，别瞎传）
    • http://123123.jpg
    • └ list_image
    • String
    • 可选
    • 套餐列表图片url（传前先找对接同学要图片规范，别瞎传）
    • http://123123.jpg
    • └ mark_price
    • String
    • 可选
    • 20000
    • 市场价（单位分）民营平台商品必需要，并且一个商品组下面的所有套餐市场价必须一样
    • └ service_types
    • String []
    • 可选
    • ONSITE_SERVICE
    • 服务类型 ：ONSITE_SERVICE（到店检测）, DOOR_TO_DOOR_SERVICE（上门检测） ; 多种服务类型用逗号分隔
    • └ info_image
    • String
    • 可选
    • 套餐详情内容图片url（传前先找运营同学要图片规范，别瞎传）
    • http://123123.jpg
    • └ free
    • Boolean
    • 可选
    • false
    • 是否免费，仅部分场景适用，默认传false
    • └ allow_offline_pay
    • Boolean
    • 可选
    • false
    • 是否允许线下支付，仅部分场景适用，默认传false
    • └ report_generation_max_duration_business_commitment
    • Number
    • 可选
    • 1
    • 报告最大产出时长，服务商承诺，单位小时;0: 无效值，默认为0; 1~4: 4小时出报告, 5~6: 6小时出报告, 7~12: 12小时出报告, 13~24: 24小时出报告
    • └ only_as_sku_item
    • Boolean
    • 可选
    • false
    • 是否只作为加项
    • └ sku_item_codes
    • String []
    • 可选
    • 关联加项编码
    • └ recommend_sku_item_codes
    • String []
    • 可选
    • 推荐加项编码
    • └ sku_item_codes_no_data
    • Boolean
    • 可选
    • false
    • 标记加项编码为空，用于清空加项
    • └ sell_along_price
    • String
    • 可选
    • 1200
    • 搭售价，单位分，如搭售价存在则自动参与搭售优惠活动；搭售价为优惠后价格，不低于销售价70%；更改搭售价时传入新价格即可，如需清空搭售价传入0
    • └ inventory_independence
    • Boolean
    • 可选
    • false
    • 是否库存无关：false库存有关，true库存无关；非加项套餐默认为false，加项套餐默认为true
    • └ channel_contract_price
    • String
    • 可选
    • 13000
    • 渠道售卖价（单位分）
    • └ channel_settlement_price
    • String
    • 可选
    • 13000
    • 渠道结算价（单位分）
    type String 必须 publish 操作类型: publish=发布，update=更新, 更新时如果套餐列表内套餐有移除则视为删除套餐
    goods_desc String 可选 商品描述 最多200个字，界面对应商品详情页描述
    target_group String 可选 商品的目人群 最多256个字，界面对应列表文字；为空是自动取套餐的package_detail字段值
    label String 可选 B
  • 默认值：C
    		•  标签值给C，传错C端将无法透出
    category_id String 可选 1
  • 默认值：1
    		•  商品类目，1：体检 ，2：核酸，4 ：健康证
    mode String 可选 0
  • 默认值：0
    		•  0自营商品，1平台商品
    backend_category_id Number 可选 20210204000005 类目ID，填入叶子类目ID，儿童体检: 20210204000004, 中青年体检: 20210204000005, 老年体检: 20210204000006, 证件体检（含入职）: 20210204000007, 核酸检测（到店服务）: 20210204000008, 专科服务（不包含核酸检测）: 20210204000009, 上门检测: 202102040000010, 上门护理: 202102040000011, 上门体检 202102040000012
    reservation_api_version Number 可选 1
  • 默认值：0
    		•  预约服务版本号, 控制预约链路, 仅支持新增, 不支持更新; 1: 路由至预约系统，0:系统默认；
    inventory_api_version Number 可选 0 库存接口版本：0走examination.stock，1走medical.inventory

    响应参数

    名称 类型 示例值 描述
    result ServiceResult json对象 返回结果
    • └ err_message
    • String
    • 查询结果为空
    • 详细错误信息
    • └ data
    • String
    • {}
    • 结果数据，通常为空
    • └ err_code
    • String
    • 501
    • 错误码
    • └ success
    • Boolean
    • true
    • 执行成功标示

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthExaminationGoodsPublishRequest req = new AlibabaAlihealthExaminationGoodsPublishRequest();
req.setGroupId("001");
req.setGroupName("精英套餐");
List<AlibabaAlihealthExaminationGoodsPublishRequest.Package> list2 = new ArrayList<AlibabaAlihealthExaminationGoodsPublishRequest.Package>();
AlibabaAlihealthExaminationGoodsPublishRequest.Package obj3 = new AlibabaAlihealthExaminationGoodsPublishRequest.Package();
list2.add(obj3);
obj3.setContractPrice("13000");
List<AlibabaAlihealthExaminationGoodsPublishRequest.Item> list6 = new ArrayList<AlibabaAlihealthExaminationGoodsPublishRequest.Item>();
AlibabaAlihealthExaminationGoodsPublishRequest.Item obj7 = new AlibabaAlihealthExaminationGoodsPublishRequest.Item();
list6.add(obj7);
obj7.setTitle("基础五项");
obj7.setDetail("身高、体重");
obj7.setSubTitle("体检五项");
obj7.setItemCode("JK001");
obj7.setItemGroupCode("JK");
obj7.setItemGroupWeight("9");
list4.setItemList(list6);
obj3.setSettlementPrice("12000");
obj3.setPackageCode("001");
obj3.setPackageName("精英男士");
obj3.setPackageDetail("男士选择");
obj3.setGender("0");
obj3.setMaritalStatus("2");
obj3.setLabels("套餐类型标签");
obj3.setFeatureItem("体检项目标签");
obj3.setDetailImage("套餐详情头图图片url（传前先找运营同学要图片规范，别瞎传）");
obj3.setListImage("套餐列表图片url（传前先找对接同学要图片规范，别瞎传）");
obj3.setMarkPrice("20000");
obj3.setServiceTypes("ONSITE_SERVICE");
obj3.setInfoImage("套餐详情内容图片url（传前先找运营同学要图片规范，别瞎传）");
obj3.setFree(false);
obj3.setAllowOfflinePay(false);
obj3.setReportGenerationMaxDurationBusinessCommitment(1L);
obj3.setOnlyAsSkuItem(false);
obj3.setSkuItemCodes("");
obj3.setRecommendSkuItemCodes("");
obj3.setSkuItemCodesNoData(false);
obj3.setSellAlongPrice("1200");
obj3.setInventoryIndependence(false);
obj3.setChannelContractPrice("13000");
obj3.setChannelSettlementPrice("13000");
req.setPackageList(list2);
req.setType("publish");
req.setGoodsDesc("商品描述");
req.setTargetGroup("商品的目人群");
req.setLabel("B");
req.setCategoryId("1");
req.setMode("0");
req.setBackendCategoryId(20210204000005L);
req.setReservationApiVersion(1L);
req.setInventoryApiVersion(0L);
AlibabaAlihealthExaminationGoodsPublishResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alibaba_alihealth_examination_goods_publish_response>
    <result>
        <err_message>查询结果为空</err_message>
        <data>{}</data>
        <err_code>501</err_code>
        <success>true</success>
    </result>
</alibaba_alihealth_examination_goods_publish_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    API测试工具 错误码查询工具 SDK下载

    如何获得此API

    FAQ

    我要提问
    返回
    顶部