LKC Open API 用户开发文档
使用方法
系统简介
- 零库存医疗供应链系统是以国家卫生行政部门相关政策法规为基础,结合市场需求,基于目前主流互联网应用模式进行开发,其SaaS产品围绕医疗机构。针对第三方业务开展进行量身定制,通过对信息流、物流和服务流等的控制,将上下游、委托方业务和第三方企业连成一个整体的功能网链式结构。
- 采用一物一码条码式管理, 产品器械的入库、库存清点、出库等各环节均使用条码管理,实现产品的可追溯。针对效期管理, 做到库存效期预警和使用效期提醒。与委托方、配送商、第三方企业等进行数据对接,实现信息共享,减少信息手工传递,提高工作效率。及时得到各类信息的反馈,包括:不良事件、质量管理等。优化库存结构、规范业务操作、全面加强流通各流通环节的效率与质量。
对接说明
- 零库存医疗供应链系统为了实现与第三方委托企业的服务信息化,设置了和委托企业系统对接的功能。零库存系统提供了标准开放接口(API),第三方委托企业需要和零库存进行业务系统打通时,只需要经过零库存的授权,客户业务系统只要调用零库存的标准接口,或者由第三方委托企业开放其标准开放接口,即可实现双方业务系统数据的实时数据交互,同时也实现了产品追溯和业务流程追踪的效果。
对接技术和安全性说明
- 零库存医疗供应链系统提供了标准开放接口(API)地址: https://docs-api.lkcgyl.com/,接口采用http接口形式,以https安全加密传输,遵照Restful 接口规范,可以支持客户任何语言开发的业务系统与之对接。
- 在安全认证措施上,采用有过期时限的访问令牌机制,每次获取数据之前必须先获取临时访问令牌,后续调用业务接口只需要传送临时访问令牌,很大程度减少了认证密钥泄露的风险。
- 为了保证双方业务系统的实时数据交互,每个接口都必须传本地timestamp(时间戳)参数,双方服务器时间戳在10分钟误差范围内才允许继续调用业务,否则判定为非法调用,返回错误代码,避免双方业务系统时间和业务不同步。
数据交换与实际业务流程说明
- 1、前期委托方信息维护:由委托方向被委托方提供相应的资质文件(营业执照、经营许可证或生产许可证等)、委托授权文件(包括委托业务范围和委托期限等)和委托产品信息(名称、规格型号、产品注册证、效期等),可通过数据交换系统接口协议,由被委托方将其数据获取并且记录在系统中,进行委托业务范围和期限管理。
- 2、库存托管:委托方发起库存托管,将其库存产品信息委托入库给被委托方,通过数据交换接口,零库存系统接收相应的入库数据,待收货和验收合格后入库上架。通过库存变动来核实委托双方的库存准确性,保证双方账实一致。
- 3、出库委派:委托方发起出库指令,通过订单信息接口传输给被委托方,被委托方根据订单详情和地址出库配送至指定地址,待客户签收后,将出库信息传输给委托方,更新库存信息。
- 3、委托方补库:委托方根据出库汇总,确认一段时间内的出库明细,并通过补货模式,将这些产品补充给被委托方,待被委托方收货和验收后入库上架。所有委托过程中,必须要符合资质要求和严格遵循GSP管理规范进行配送和存储等。
规范说明
- API访问使用https协议。API统一调用地址是:https://api.lkcgyl.com/。
- API接口按照RESTful风格,根据API路径和HTTP谓词(GET、POST、PUT、DELETE)来区分业务类型。
- API提交参数和返回数据字符统一使用UTF8编码。
- API返回格式统一为JSON(application/json),JSON内容格式为:{"error_code":0,"error_msg":"OK","data":[]}。error_code:错误代码,error_msg:错误描述,data:数据列表。错误代码含义见错误代码表。
- 参数或键值命名使用下划线命名法,字母全部小写,比如:access_token、error_code等。
- API授权鉴定使用access_token形式,即用户需要首先调用/token接口,提供API ID和API Secret进行验证授权,验证通过后返回本次得到的access_token,有效期7200秒。超过有效期或者获取新的token,原token失效。
- 调用后续接口都需要提供有效的access_token用于身份验证,不提供token或token已失效则返回鉴权失败。此时请重新获取access_token。
请求格式
[ GET | POST ] https://api.lkcgyl.com/{api_name}?{query_string}
通用参数
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 |
|---|---|---|---|
| access_token | String | 是 | 用户获得的访问令牌access_token |
| timestamp | Number | 是 | 本次请求的linux时间戳,与服务器时间对比10分钟内有效 |
返回参数
| 参数名称 | 数据类型 | 是否必需 | 描述 |
|---|---|---|---|
| error_code | Int | 是 | 返回码 |
| error_msg | String | 是 | 返回码描述 |
| data | List | 否 | 数据列表 |
错误代码表
| HTTP状态码 | error_code | error_msg | 描述 |
|---|---|---|---|
| 200 | 0 | OK | 正确,处理成功 |
| 500 | 1 | Internal Server Error | 服务器内部错误,服务器繁忙 |
| 400 | 2 | Request params not valid | 请求参数无效 |
| 403 | 3 | Authentication failed | 授权鉴定失败 |
| 401 | 4 | API account was locked | API账号暂时被锁定 |
| 404 | 5 | Resource not found | 资源未找到,API接口名或调用方式错误 |
| 401 | 6 | Access token not valid or expired | acess_token无效或已过期 |
| 405 | 7 | Method not allowed | 未授权的业务类型,请检查参数 |
| 408 | 8 | Request timestamp not valid | timestamp不正确,客户端时间与服务器时间相差超过10分钟 |
| 204 | 9 | No matching data | 没有匹配的数据,或指定页码超出总页数 |
| 406 | 10 | Repeated submission | API重复提交,没有处理成功的API可以重发3次,处理成功的API再次重发就会返回重复提交 |
| 406 | 11 | Some items failure | 部分数据处理失败,请确认 |
公用接口
token
功能
生成鉴权,access_token。
请求方式
GET
URL示例
https://api.lkcgyl.com/token?grant_type=client_credential&api_id=APIID&api_secret=APISECRET&timestamp=1402378179
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| grant_type | String | 是 | 获取access_token填写client_credential | client_credential |
| api_id | String | 是 | 第三方应用对接凭证 | Qby095u6 |
| api_secret | String | 是 | 第三方应用对接密钥 | 1weH8gl1JAUt43Cwc0xL5iKL |
返回参数
| 参数名称 | 描述 |
|---|---|
| access_token | 获取到的访问令牌,64位长随机字符串 |
| expires_time | 访问令牌失效时间 |
| data | 返回数据列表 |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": {
"access_token": "iTSUZR5RLP1TKgKaSr0VXvyZTli44gBrnGeSnrz1ShAtGZUhYDSDleP1v5N6BS6X",
"expires_time": "2014-06-13 10:16:33"
}
}analyse
功能
条码解析,传入一个条码,返回该条码的产品编号、生产批号、有效期等。
请求方式
GET
URL示例
https://api.lkcgyl.com/analyse?access_token=ACCESS_TOKEN&barcode=0104035479058630171112312125716496&timestamp=1402378179
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| barcode | String | 是 | 条码字符串,不包含括号 | 0104035479058630171112312125716496 |
返回参数
| 参数名称 | 描述 |
|---|---|
| data | 条码解析后的信息 |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": {
"barcode": "0104035479058630171112312125716496",
"master_flag": "1",
"spec_no": "04035479058630",
"spec_guid": "",
"goods_name": "",
"common_name": "",
"spec_size": ""
"batch_no": "25716496",
"product_date": "",
"expired_date": "2011-12-31",
"expired_status": "Expired",
"disinfect_no": "",
"disinfect_expired": "",
"lot_no": ""
}
}第三方接口
customers
功能
委托方向被委托方(第三方企业)提供相应的收货客户资质,包括营业执照、法人、企业负责人、经营许可证/备案凭证等文件,对其进行经营资质和经营范围管理。
请求方式
GET
URL示例
https://api.lkcgyl.com/customers?access_token=ACCESS_TOKEN&cust_type=2&page_size=30&page=2&start_time=20140615195320&end_time=20140615205320&timestamp=1402378179
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| cust_guid | String | 否 | 客户唯一键,不限时间指定获取某个客户,传空不指定客户 | D7075184534E49779D8E92B684CBE8F1 |
| cust_type | Int | 否 | 客户类型:1委托方客户 | 1 |
| page_size | Int | 否 | 每页取多少行数据,默认10 | 30 |
| page | Int | 否 | 获取第几页数据,默认1 | 2 |
| start_time | String | 否 | 指定修改时间的起始时间,不指定则不限制修改时间的开始时间。 | 20140615195320 |
| end_time | String | 否 | 指定修改时间的结束时间,不指定则不限制修改时间的结束时间。 | 20140615205320 |
返回参数
| 参数名称 | 描述 |
|---|---|
| data | 返回数据列表 |
| row_count | 数据总行数 |
| page_count | 总页数 |
| page_num | 第几页 |
| list | 数据列表,具体数据栏位含义见数据字典 |
返回字段
| 字段名称 | 数据类型 | 可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| cust_id | Int | 否 | 客户唯一ID | 91 |
| cust_guid | String | 否 | 客户唯一GUID,不限时间指定获取某个客户,传空不指定客户 | D7075184534E49779D8E92B684CBE8F1 |
| cust_name | String | 否 | 客户名称 | 绚琪贸易商行 |
| cust_no | String | 否 | 营业执照编号 | 41000002201612020078 |
| cust_tax_no | String | 是 | 客户税号 | 91310116MA1JB0A0XN |
| cust_legal_person | String | 是 | 法人 | 张三 |
| cust_bank_name | String | 是 | 开户行 | |
| cust_bank_no | String | 是 | 银行账号 | |
| cust_linkman | String | 是 | 联系人 | 李四 |
| cust_tel | String | 是 | 联系电话 | 0571-88256500 |
| cust_phone | String | 是 | 手机 | |
| cust_addr_detail | String | 是 | 详细地址 | |
| cust_postcode | String | 是 | 邮编 | |
| edit_time | String | 否 | 最后变动时间 | 2013-12-28 10:49:23 |
| del_flag | String | 否 | 状态:0正常、1作废 | 0 |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": {
"row_count": 3,
"page_count": 2,
"page_num": 1,
"list": [
{
"item": "1",
"cust_id": "91",
"cust_guid": "D7075184534E49779D8E92B684CBE8F1",
"cust_name": "绚琪贸易商行",
"cust_no": "41000002201612020078",
"cust_tax_no": "91310116MA1JB0A0XN",
"cust_legal_person": "张三",
"cust_bank_name": "",
"cust_bank_no": "",
"cust_linkman": "李四",
"cust_tel": "0571-88256500",
"cust_phone": "13800138000",
"cust_addr_detail": "",
"cust_postcode": "",
"edit_time": "2013-12-28 10:49:23",
"del_flag": 0
}
]
}
}suppliers
功能
第三方企业获取委托方列表,与零库存委托方目录同步。获取的委托方数据包括委托方企业名称、营业执照、住所、法定代表人、企业负责人、经营场所、库房地址、经营范围、经营许可证或备案凭证号、委托时间和期限、委托业务范围等。
请求方式
GET
URL示例
https://api.lkcgyl.com/suppliers?access_token=ACCESS_TOKEN&page_size=30&page=1&start_time=20140615195320&end_time=20140615205320&timestamp=1402378179
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| spl_guid | String | 否 | 委托方唯一键,不限时间指定获取某个委托方,传空不指定委托方 | 534F41143EEF49769622333551F046A5 |
| page_size | Int | 否 | 每页取多少行数据,默认10 | 30 |
| page | Int | 否 | 获取第几页数据,默认1 | 1 |
| start_time | String | 否 | 指定修改时间的起始时间,不指定则不限制修改时间的开始时间。 | 20140615195320 |
| end_time | String | 否 | 指定修改时间的结束时间,不指定则不限制修改时间的结束时间。 | 20140615205320 |
返回参数
| 参数名称 | 描述 |
|---|---|
| data | 返回数据列表 |
| row_count | 数据总行数 |
| page_count | 总页数 |
| page_num | 第几页 |
| list | 数据列表,具体数据栏位含义见数据字典 |
返回字段
| 字段名称 | 数据类型 | 是否可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| spl_name | String | 否 | 委托方企业名称 | 上海零库存医疗供应链管理有限公司 |
| spl_no | String | 否 | 营业执照号 | 91310116MA1J9E3A4H |
| address | String | 否 | 住所 | 上海市辖区金山区金山工业区亭卫公路6495弄168号5幢西区一层 |
| spl_legal_person | String | 否 | 法定代表人 | 曹武军 |
| company_leader | String | 否 | 企业负责人 | 曹武军 |
| spl_office_addr | String | 否 | 经营场所 | 金山区金山工业区亭卫公路6495弄168号5幢西区一层 |
| warehouse_addr | String | 否 | 库房地址 | 金山区金山工业区亭卫公路6495弄168号5幢西区二、三层 |
| permit_business_sphere | String | 否 | 经营范围 | [6810]矫形外科(骨科)手术器械,Ⅰ类,Ⅱ类,Ⅲ类,[6815]注射穿刺器械... |
| permit_no | String | 否 | 经营许可证号 | 沪金食药监械经营许20170224号 |
| permit_defer_no | String | 否 | 许可证效期 | 2022-06-15 |
| permit_end_date | String | 否 | 备案凭证号 | 沪金食药监械经营备20170307号 |
| permit_defer_to_date | String | 否 | 备案日期 | 2018-10-29 |
| permit_orgatition | String | 否 | 发证机关 | 上海市金山区市场监督管理局 |
| auth_date | String | 否 | 开始委托时间 | 2019-01-01 |
| expired_date | String | 否 | 停止委托时间 | 2019-12-31 |
| auth_time | String | 否 | 委托期限 | 364天 |
| stock_address | String | 否 | 库存地址 | 上海零库存金山仓库 |
| tag_flag | String | 否 | 是否加贴中文标签 | 否 |
| spl_desc | String | 否 | 委托业务范围 | 三类:6810矫形外科(骨科)手术器械;6815注射穿刺器械(含一次性使用重点监管)... |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": {
"row_count": 2,
"page_count": 1,
"page_num": 1,
"list": [
{
"item": "1",
"spl_name": "上海零库存医疗供应链管理有限公司",
"spl_no": "91310116MA1J9E3A4H",
"address": "上海市辖区金山区金山工业区亭卫公路6495弄168号5幢西区一层",
"spl_legal_person": "曹武军",
"company_leader": "曹武军",
"spl_office_addr": "金山区金山工业区亭卫公路6495弄168号5幢西区一层",
"warehouse_addr": "金山区金山工业区亭卫公路6495弄168号5幢西区二、三层",
"permit_business_sphere": "[6810]矫形外科(骨科)手术器械,Ⅰ类,Ⅱ类,Ⅲ类,[6815]注射穿刺器械,Ⅰ类,Ⅱ类,Ⅲ类,[6821]医用电子仪器设备,Ⅰ类,Ⅱ类,Ⅲ类,[6822]医用光学器具/仪器及内窥镜设备,Ⅰ类,Ⅱ类,Ⅲ类,[6825]医用高频仪器设备,Ⅰ类,Ⅱ类,Ⅲ类,[6846]植入材料和人工器官,Ⅰ类,Ⅱ类,Ⅲ类,[6854]手术室/急救室/诊疗室设备及器具,Ⅰ类,Ⅱ类,Ⅲ类,[6863]口腔科材料,Ⅰ类,Ⅱ类,Ⅲ类,[6864]医用卫生材料及敷料,Ⅰ类,Ⅱ类,Ⅲ类,[6865]医用缝合材料及粘合剂,Ⅰ类,Ⅱ类,Ⅲ类,[6866]医用高分子材料及制品,Ⅰ类,Ⅱ类,Ⅲ类,[6877]介入器材,Ⅰ类,Ⅱ类,Ⅲ类",
"permit_no": "沪金食药监械经营许20170224号",
"permit_defer_no": "2022-06-15",
"permit_end_date": "沪金食药监械经营备20170307号",
"permit_defer_to_date": "2018-10-29",
"permit_orgatition": "上海市金山区市场监督管理局",
"auth_date": "2019-01-01",
"expired_date": "2019-12-31",
"auth_time": "364天",
"stock_address": "上海零库存金山仓库",
"tag_flag": "否",
"spl_desc": "三类:6810矫形外科(骨科)手术器械;6815注射穿刺器械(含一次性使用重点监管);6821医用电子仪器设备;6822医用光学器具、仪器及内窥镜设备(不含植入类重点监管);6825医用高频仪器设备;6846植入材料和人工器官;6854手术室、急救室、诊疗室设备及器具;6863口腔科材料;6864医用卫生材料及敷料;6865医用缝合材料及粘合剂;6866医用高分子材料及制品(含重点监管产品);6877介入器材;***",
}
]
}
}dicts
功能
委托方开放耗材字典目录,与零库存系统耗材字典目录进行获取和同步。数据包括委托产品名称、规格、产品注册证号/备案凭证号、注册证有效时间、单位、生产厂家、储运条件等。
请求方式
GET
URL示例
https://api.lkcgyl.com/dicts?access_token=ACCESS_TOKEN&page_size=10&page=1&start_time=20140615195320&end_time=20140615205320&timestamp=1402378179
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| spec_guid | String | 否 | 字典唯一键,不限时间指定获取某个字典,传空不指定字典 | FA819460313E0C9CE040A8C00A015F36 |
| page_size | Int | 否 | 每页取多少行数据,默认10 | 10 |
| page | Int | 否 | 获取第几页数据,默认1 | 1 |
| start_time | String | 否 | 指定修改时间的起始时间,不指定则不限制修改时间的开始时间。 | 20140615195320 |
| end_time | String | 否 | 指定修改时间的结束时间,不指定则不限制修改时间的结束时间。 | 20140615205320 |
返回参数
| 参数名称 | 描述 |
|---|---|
| data | 返回数据列表 |
| row_count | 数据总行数 |
| page_count | 总页数 |
| page_num | 第几页 |
| list | 数据列表,具体数据栏位含义见数据字典 |
返回字段
| 字段名称 | 数据类型 | 是否可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| goods_name | String | 否 | 委托产品名称 | 亲水纤维敷料 |
| spec_size | String | 否 | 规格(型号) | 片状敷料10cm*10cm |
| reg_no | String | 否 | 产品注册证号/备案凭证号 | 国械注进20153643046 |
| reg_date | String | 否 | 注册证批准日期 | 2015-09-24 |
| reg_expired_date | String | 否 | 注册证有效期 | 2019-09-23 |
| fac_name | String | 否 | 生产企业 | LABORATOIRES URGO |
| pro_no | String | 否 | 生产企业许可证号/备案凭证号 | 沪徐食药监械经营许20150170号 |
| spec_unit | String | 否 | 单位 | 盒 |
| storage_condition | String | 否 | 储运条件 | 温控15至25度 |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": {
"row_count": 458,
"page_count": 229,
"page_num": 1,
"list": [
{
"item": "1",
"goods_name": "亲水纤维敷料",
"spec_size": "片状敷料10cm*10cm",
"reg_no": "国械注进20153643046",
"reg_date": "2015-09-24",
"reg_expired_date": "2019-09-23",
"fac_name": "LABORATOIRES URGO",
"pro_no": "沪徐食药监械经营许20150170号",
"spec_unit": "盒",
"storage_condition": "温控15至25度"
}
]
}
}stockin
功能
委托方企业提供耗材入库(补货)记录,与零库存软件中的委托入库业务同步。入库单对接数据包括入库日期、产品名称、规格型号、生产企业、产品注册证号/备案凭证号、生产批号/序列号、生产日期和有效期、数量、单位、储运单位、入库货位号、质量状态等。
货位号是由第三方企业验收上架后,将货位信息反馈给委托方。
请求方式
GET
URL示例
https://api.lkcgyl.com/stockin?access_token=ACCESS_TOKEN&form_type=1&page_size=2&page=1&start_time=20140614170650&end_time=20140614171650&timestamp=1402378179
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| form_type | Int | 是 | 业务类型:1委托入库 | 1 |
| form_no | String | 否 | 单据号码,指定获取某个单据 | 201406040208001 |
| item_index | Int | 否 | 单据明细序号,指定获取某个单据明细 | 2 |
| page_size | Int | 否 | 每页取多少行数据,默认10 | 2 |
| page | Int | 否 | 获取第几页数据,默认1 | 1 |
| start_time | String | 否 | 指定单据时间的起始时间,精确到秒,默认10分钟以前 | 20140614170650 |
| end_time | String | 否 | 指定单据时间的结束时间,精确到秒,默认当前分钟 | 20140614171650 |
返回参数
| 参数名称 | 描述 |
|---|---|
| data | 返回数据列表 |
| row_count | 数据总行数 |
| page_count | 总页数 |
| page_num | 第几页 |
| list | 数据列表,具体数据栏位含义见数据字典 |
返回字段
| 字段名称 | 数据类型 | 是否可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| add_time | String | 否 | 入库日期 | 2019-10-25 |
| form_type | String | 否 | 入库类型 | 委托入库 |
| goods_name | String | 否 | 产品名称 | 亲水纤维敷料 |
| spec_size | String | 否 | 规格型号 | 条状敷料2.5cm*40 cm, 5' |
| factory_name | String | 否 | 生产企业 | LABORATOIRES URGO |
| reg_no | String | 否 | 产品注册证号/备案凭证号 | 国械注进20153643046 |
| batch_no | String | 否 | 生产批号/序列号 | TC028118A/ |
| product_date | String | 否 | 生产日期 | 2018-07-26 |
| expired_date | String | 否 | 有效期 | 2021-06-30 |
| stock_in_qty | String | 否 | 数量 | 1 |
| spec_unit | String | 否 | 单位 | 盒 |
| storage_condition | String | 否 | 储运条件 | 温控15至25度 |
| stock_area | String | 否 | 入库货位号 | H1-1-2 |
| stock_address | String | 否 | 库存地址 | 上海零库存金山仓库 |
| quality_status | String | 否 | 质量状态 | 合格 |
| remark | String | 否 | 备注 |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": {
"row_count": 2,
"page_count": 1,
"page_num": 1,
"list": [
{
"item": "1",
"add_time": "2019-10-25",
"form_type": "委托入库",
"goods_name": "亲水纤维敷料",
"spec_size": "条状敷料2.5cm*40 cm, 5'",
"factory_name": "LABORATOIRES URGO",
"reg_no": "国械注进20153643046",
"batch_no": "TC028118A/",
"product_date": "2018-07-26",
"expired_date": "2021-06-30",
"stock_in_qty": "1",
"spec_unit": "盒",
"storage_condition": "温控15至25度",
"stock_area": "H1-1-2",
"stock_address": "上海零库存金山仓库",
"quality_status": "合格",
"remark": ""
}
]
}
}stockout
功能
第三方根据订单信息完成出库指令,确认客户完成验收后,将出库信息反馈给委托方,保证出库过程的闭环信息对接。出库信息对接数据包括出库日期、产品名称、规格型号、产品注册证号/备案凭证号、生产批号/序列号、储运条件、单位、数量、收货客户名称、收货地址、联系人、联系方式、确认收货等。
请求方式
GET
URL示例
https://api.lkcgyl.com/stockout?access_token=ACCESS_TOKEN&form_type=2&page_size=2&page=1&start_time=20140614170650&end_time=20140614171650&timestamp=1402378179
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| form_type | Int | 是 | 业务类型:2出库记录 | 2 |
| form_no | String | 否 | 单据号码,指定获取某个单据 | 201406040208001 |
| item_index | Int | 否 | 单据明细序号,指定获取某个单据明细 | 2 |
| page_size | Int | 否 | 每页取多少行数据,默认10 | 2 |
| page | Int | 否 | 获取第几页数据,默认1 | 1 |
| start_time | String | 否 | 指定单据时间的起始时间,精确到秒,默认10分钟以前 | 20140614170650 |
| end_time | String | 否 | 指定单据时间的结束时间,精确到秒,默认当前分钟 | 20140614171650 |
返回参数
| 参数名称 | 描述 |
|---|---|
| data | 返回数据列表 |
| row_count | 数据总行数 |
| page_count | 总页数 |
| page_num | 第几页 |
| list | 数据列表,具体数据栏位含义见数据字典 |
返回字段
| 字段名称 | 数据类型 | 是否可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| form_type | String | 否 | 出库类型 | 委托出库 |
| goods_name | String | 否 | 产品名称 | 亲水纤维敷料 |
| spec_size | String | 否 | 规格型号 | 条状敷料2.5cm*40 cm, 5' |
| factory_name | String | 否 | 生产企业 | LABORATOIRES URGO |
| reg_no | String | 否 | 产品注册证号/备案凭证号 | 国械注进20153643046 |
| batch_no | String | 否 | 生产批号/序列号 | TC028118A/ |
| storage_condition | String | 否 | 储运条件 | 温控15至25度 |
| spec_unit | String | 否 | 单位 | 盒 |
| stock_out_qty | String | 否 | 数量 | 1 |
| aim_name | String | 否 | 收货客户名称 | 上海渝禄贸易商行 |
| receive_address | String | 否 | 收货地址 | 重庆市沙坪坝区天星桥晒光坪80号五矿仓库第四楼 |
| picker_name | String | 否 | 联系人 | 成应忠 |
| contact_phone | String | 否 | 联系方式 | 18580596513 |
| remark | String | 否 | 备注 |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": {
"row_count": 1,
"page_count": 1,
"page_num": 1,
"list": [
{
"item": "1",
"form_type": "委托出库",
"goods_name": "亲水纤维敷料",
"spec_size": "条状敷料2.5cm*40 cm, 5'",
"factory_name": "LABORATOIRES URGO",
"reg_no": "国械注进20153643046",
"batch_no": "TC028118A/",
"storage_condition": "温控15至25度",
"spec_unit": "盒",
"stock_out_qty": "1",
"aim_name": "上海渝禄贸易商行",
"receive_address": "重庆市沙坪坝区天星桥晒光坪80号五矿仓库第四楼",
"picker_name": "成应忠",
"contact_phone": "18580596513",
"remark": ""
}
]
}
}stock
功能
库存信息由第三方传输当前的库存信息,与委托方库存数据进行确认。库存对接数据包括有入库日期、产品名称、规格型号、生产企业、产品注册证号/备案凭证号、生产批号/序列号、生产日期和有效期、库存数量、存储货位号、储运条件、质量状态等。
请求方式
GET
URL示例
https://api.lkcgyl.com/stock?access_token=ACCESS_TOKEN&wh_id=0&timestamp=1531221406
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| wh_id | Int | 是 | 库房ID | 6 |
| data | String | 是 | 产品编号列表 | 见下方详细示例 |
data示例
[
{
"spec_no": "MB1RB55250"
}
]
返回字段
| 字段名称 | 数据类型 | 是否可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| add_time | String | 否 | 入库日期 | 2019-10-25 |
| goods_name | String | 否 | 产品名称 | 亲水纤维敷料 |
| spec_size | String | 否 | 规格型号 | 条状敷料2.5cm*40 cm, 5' |
| factory_name | String | 否 | 生产企业 | LABORATOIRES URGO |
| reg_no | String | 否 | 产品注册证号/备案凭证号 | 国械注进20153643046 |
| batch_no | String | 否 | 生产批号/序列号 | TC028118A/ |
| product_date | String | 否 | 生产日期 | 2018-07-26 |
| expired_date | String | 否 | 有效期 | 2021-06-30 |
| stock_qty | String | 否 | 数量 | 0 |
| spec_unit | String | 否 | 单位 | 盒 |
| stock_area | String | 否 | 入库货位号 | H1-1-2 |
| stock_address | String | 否 | 库存地址 | 上海零库存金山仓库 |
| storage_condition | String | 否 | 储运条件 | 温控15至25度 |
| quality_status | String | 否 | 质量状态 | 合格 |
| remark | String | 否 | 备注 |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": [
{
"item": "1",
"add_time": "2019-10-25",
"goods_name": "亲水纤维敷料",
"spec_size": "条状敷料2.5cm*40 cm, 5'",
"factory_name": "LABORATOIRES URGO",
"reg_no": "国械注进20153643046",
"batch_no": "TC028118A/",
"product_date": "2018-07-26",
"expired_date": "2021-06-30",
"stock_qty": "0",
"spec_unit": "盒",
"stock_area": "H1-1-2",
"stock_address": "上海零库存金山仓库",
"storage_condition": "温控15至25度",
"quality_status": "合格",
"remark": ""
}
]
}
exchange
功能
第三方企业完成出库后,实时更新库存变动记录数据,与委托方信息的数据进行核实,保证双方数据的准确性,委托方可以实时获取第三方企业的库存信息和出入库信息等。
请求方式
GET
URL示例
https://api.lkcgyl.com/exchange?access_token=ACCESS_TOKEN&start_time=20170101000000&end_time=20180103000000&wh_id=0&start&timestamp=1531970866
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| start_time | String | 否 | 指定单据时间的起始时间,精确到秒 | 20170101000000 |
| end_time | String | 否 | 指定单据时间的结束时间,精确到秒 | 20180103000000 |
| wh_id | Int | 是 | 库房ID | 6 |
返回字段
| 字段名称 | 数据类型 | 是否可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| add_time | String | 否 | 入库日期 | 2019-10-25 |
| goods_name | String | 否 | 产品名称 | 亲水纤维敷料 |
| spec_size | String | 否 | 规格型号 | 条状敷料2.5cm*40 cm, 5' |
| factory_name | String | 否 | 生产企业 | LABORATOIRES URGO |
| reg_no | String | 否 | 产品注册证号/备案凭证号 | 国械注进20153643046 |
| batch_no | String | 否 | 生产批号/序列号 | TC028118A/ |
| product_date | String | 否 | 生产日期 | 2018-07-26 |
| expired_date | String | 否 | 有效期 | 2021-06-30 |
| stock_in_qty | String | 否 | 入库数量 | 10 |
| stock_out_qty | String | 否 | 出库数量 | 10 |
| stock_qty | String | 否 | 数量 | 0 |
| spec_unit | String | 否 | 单位 | 盒 |
| stock_area | String | 否 | 入库货位号 | H1-1-2 |
| stock_address | String | 否 | 库存地址 | 上海零库存金山仓库 |
| storage_condition | String | 否 | 储运条件 | 温控15至25度 |
| quality_status | String | 否 | 质量状态 | 合格 |
| remark | String | 否 | 备注 |
返回示例
{
"error_code": 0,
"error_msg": "OK",
"data": [
{
"item": "1",
"add_time": "2019-10-25",
"goods_name": "亲水纤维敷料",
"spec_size": "条状敷料2.5cm*40 cm, 5'",
"factory_name": "LABORATOIRES URGO",
"reg_no": "国械注进20153643046",
"batch_no": "TC028118A/",
"product_date": "2018-07-26",
"expired_date": "2021-06-30",
"stock_in_qty": "10",
"stock_out_qty": "10",
"stock_qty": "0",
"spec_unit": "盒",
"stock_area": "H1-1-2",
"stock_address": "上海零库存金山仓库",
"storage_condition": "温控15至25度",
"quality_status": "合格",
"remark": ""
}
}
customers
功能
被委托方也可以通过客户信息同步接口向委托方直接获取收货客户信息,保证业务的流畅性。
请求方式
POST
URL示例
https://api.lkcgyl.com/customers?access_token=ACCESS_TOKEN&wh_id=0&timestamp=1531221406
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| data | String | 是 | 客户明细列表 | 见下方详细示例 |
传入字段
| 字段名称 | 数据类型 | 是否可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| spl_name | String | 否 | 委托方企业名称 | 上海零库存医疗供应链管理有限公司 |
| spl_no | String | 否 | 营业执照号 | 91310116MA1J9E3A4H |
| address | String | 否 | 住所 | 上海市辖区金山区金山工业区亭卫公路6495弄168号5幢西区一层 |
| spl_legal_person | String | 否 | 法定代表人 | 曹武军 |
| company_leader | String | 否 | 企业负责人 | 曹武军 |
| spl_office_addr | String | 否 | 经营场所 | 金山区金山工业区亭卫公路6495弄168号5幢西区一层 |
| warehouse_addr | String | 否 | 库房地址 | 金山区金山工业区亭卫公路6495弄168号5幢西区二、三层 |
| permit_business_sphere | String | 否 | 经营范围 | [6810]矫形外科(骨科)手术器械,Ⅰ类,Ⅱ类,Ⅲ类,[6815]注射穿刺器械... |
| permit_no | String | 否 | 经营许可证号 | 沪金食药监械经营许20170224号 |
| permit_defer_no | String | 否 | 许可证效期 | 2022-06-15 |
| permit_end_date | String | 否 | 备案凭证号 | 沪金食药监械经营备20170307号 |
| permit_defer_to_date | String | 否 | 备案日期 | 2018-10-29 |
| permit_orgatition | String | 否 | 发证机关 | 上海市金山区市场监督管理局 |
| auth_date | String | 否 | 开始委托时间 | 2019-01-01 |
| expired_date | String | 否 | 停止委托时间 | 2019-12-31 |
| auth_time | String | 否 | 委托期限 | 364天 |
| stock_address | String | 否 | 库存地址 | 上海零库存金山仓库 |
| tag_flag | String | 否 | 是否加贴中文标签 | 否 |
| spl_desc | String | 否 | 委托业务范围 | 三类:6810矫形外科(骨科)手术器械;6815注射穿刺器械(含一次性使用重点监管)... |
data示例
[
{
"item": "1",
"spl_name": "上海零库存医疗供应链管理有限公司",
"spl_no": "91310116MA1J9E3A4H",
"address": "上海市辖区金山区金山工业区亭卫公路6495弄168号5幢西区一层",
"spl_legal_person": "曹武军",
"company_leader": "曹武军",
"spl_office_addr": "金山区金山工业区亭卫公路6495弄168号5幢西区一层",
"warehouse_addr": "金山区金山工业区亭卫公路6495弄168号5幢西区二、三层",
"permit_business_sphere": "[6810]矫形外科(骨科)手术器械,Ⅰ类,Ⅱ类,Ⅲ类,[6815]注射穿刺器械,Ⅰ类,Ⅱ类,Ⅲ类,[6821]医用电子仪器设备,Ⅰ类,Ⅱ类,Ⅲ类,[6822]医用光学器具/仪器及内窥镜设备,Ⅰ类,Ⅱ类,Ⅲ类,[6825]医用高频仪器设备,Ⅰ类,Ⅱ类,Ⅲ类,[6846]植入材料和人工器官,Ⅰ类,Ⅱ类,Ⅲ类,[6854]手术室/急救室/诊疗室设备及器具,Ⅰ类,Ⅱ类,Ⅲ类,[6863]口腔科材料,Ⅰ类,Ⅱ类,Ⅲ类,[6864]医用卫生材料及敷料,Ⅰ类,Ⅱ类,Ⅲ类,[6865]医用缝合材料及粘合剂,Ⅰ类,Ⅱ类,Ⅲ类,[6866]医用高分子材料及制品,Ⅰ类,Ⅱ类,Ⅲ类,[6877]介入器材,Ⅰ类,Ⅱ类,Ⅲ类",
"permit_no": "沪金食药监械经营许20170224号",
"permit_defer_no": "2022-06-15",
"permit_end_date": "沪金食药监械经营备20170307号",
"permit_defer_to_date": "2018-10-29",
"permit_orgatition": "上海市金山区市场监督管理局",
"auth_date": "2019-01-01",
"expired_date": "2019-12-31",
"auth_time": "364天",
"stock_address": "上海零库存金山仓库",
"tag_flag": "否",
"spl_desc": "三类:6810矫形外科(骨科)手术器械;6815注射穿刺器械(含一次性使用重点监管);6821医用电子仪器设备;6822医用光学器具、仪器及内窥镜设备(不含植入类重点监管);6825医用高频仪器设备;6846植入材料和人工器官;6854手术室、急救室、诊疗室设备及器具;6863口腔科材料;6864医用卫生材料及敷料;6865医用缝合材料及粘合剂;6866医用高分子材料及制品(含重点监管产品);6877介入器材;***",
}
]
返回示例
{
"error_code": 0,
"error_msg": "OK"
}
orders
功能
订单信息由委托方发出,订单信息内容包括产品名称、规格型号、注册证号、批号序列号、生产有效期、数量、单位、生产厂家、收货客户名称、收货地址、联系人、联系方式等,第三方收到相应的订单信息后,安排出库。
请求方式
POST
URL示例
https://api.lkcgyl.com/orders?access_token=ACCESS_TOKEN&wh_id=0&timestamp=1531221406
传入参数
| 参数名称 | 数据类型 | 是否必需 | 描述 | 示例 |
|---|---|---|---|---|
| data | String | 是 | 订单明细 | 见下方详细示例 |
传入字段
| 字段名称 | 数据类型 | 是否可空 | 描述 | 示例 |
|---|---|---|---|---|
| item | Int | 否 | 序号 | 1 |
| form_type | String | 否 | 出库类型 | 委托出库 |
| spl_name | String | 否 | 委托方名称 | 上海零库存医疗供应链管理有限公司 |
| goods_name | String | 否 | 产品名称 | 亲水纤维敷料 |
| spec_size | String | 否 | 规格型号 | 条状敷料2.5cm*40 cm, 5' |
| factory_name | String | 否 | 生产企业 | LABORATOIRES URGO |
| reg_no | String | 否 | 产品注册证号/备案凭证号 | 国械注进20153643046 |
| batch_no | String | 否 | 生产批号/序列号 | TC028118A/ |
| storage_condition | String | 否 | 储运条件 | 温控15至25度 |
| spec_unit | String | 否 | 单位 | 盒 |
| stock_out_qty | String | 否 | 数量 | 1 |
| aim_name | String | 否 | 收货客户名称 | 上海渝禄贸易商行 |
| receive_address | String | 否 | 收货地址 | 重庆市沙坪坝区天星桥晒光坪80号五矿仓库第四楼 |
| picker_name | String | 否 | 联系人 | 成应忠 |
| contact_phone | String | 否 | 联系方式 | 18580596513 |
| remark | String | 否 | 备注 |
data示例
[
{
"item": "1",
"form_type": "委托出库",
"spl_name": "上海零库存医疗供应链管理有限公司",
"goods_name": "亲水纤维敷料",
"spec_size": "条状敷料2.5cm*40 cm, 5'",
"factory_name": "LABORATOIRES URGO",
"reg_no": "国械注进20153643046",
"batch_no": "TC028118A/",
"storage_condition": "温控15至25度",
"spec_unit": "盒",
"stock_out_qty": "1",
"aim_name": "上海渝禄贸易商行",
"receive_address": "重庆市沙坪坝区天星桥晒光坪80号五矿仓库第四楼",
"picker_name": "成应忠",
"contact_phone": "18580596513",
"remark": ""
}
]
返回示例
{
"error_code": 0,
"error_msg": "OK"
}
