食品流通信息化质量管理体系建设规范

1食品配送企业食品追溯系统数据接口规范本标准规定了食品配送企业食品追溯系统数据接口的术语和定义、数据接口及认证方式、数据接口说明以及接口验收标准。本标准适用于食品配送企业食品追溯系统的接入与应用，也可用于指导食品配送企业食品追溯系统的开发。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T1.1-2009标准的结构和编写GB/T2659-2000世界各国和地区名称代码GB/T7635.1-2002T全国主要产品分类与代码3术语和定义下列术语和定义适用于本文件。3.1数据接口Datainterface计算机软件系统之间传送数据、交换信息的接口，以电子文件的形式实现。3.2食品配送企业食品追溯系统DataInterfaceSpecificationForFoodTraceabilitySystemOfFoodDistributionEnterprises“食品配送企业食品追溯系统”是一个能够连接食品生产、检验、监管、配送和消费各个环节，让消费者了解符合卫生安全的生产和流通过程，提高消费者放心程度的信息管理系统。4缩略语下列缩略语适用于本文件。HTTP：超文本传输协议（HyperTextTransferProtocol）JSON：JavaScript对象标记语言（JavaScriptObjectNotation）2T/GDFCA019—20195数据接口及认证方式5.1数据接口范围及内容食品配送企业食品追溯系统应提供一系列的接口，应包括且不限于如图所示功能：图1食品配送企业食品追溯系统接口范围5.2认证方式本系统中，接口使用方在调用数据接口前必须经过认证，接口提供方需提供认证接口给接口使用方进行认证操作。接口提供方为每个接口使用方分配应用标识和凭据（authID和authKey接口使用方调用认证接口，通过应用标识和凭据获取具有一定时效性的有效令牌，之后调用数据接口均需带上该令牌。6数据接口说明6.1数据格式本系统需采用JSON作为系统间的数据传输格式，调用接口时请求数据和返回数据均采用JSON格式。系统中传输的数据格式如表1所示，在定义参数类型时只能从这六种类型中选取。表1数据传输格式类型格式示例字符字符串userName:“张三”数字整型、浮点型YYYY-MM-DDbirthday:“1983-12-05”YYYY-MM-DDHH:mm:sscreateTime:“1983-12-0513:05:00”数组列表data：[{11,12},{21,22}]布尔型布尔型isDeleted:“false”6.2企业信息查询接口6.2.1概述主要功能是获取企业信息。6.2.2企业信息查询接口函数a)接口说明：获取企业信息b)接口地址：http://serverurl/eniotis/enterpriseInfo.do?action=listc)请求方式：post。a)请求参数列表：见表2。表2查询企业信息列表接口请求参数列表参数是否必填说明数据类型enterpriseName否企业名称字符串linkMan否联系人字符串linkPhone否联系电话字符串enterpriseType否企业类型字符串b)返回参数说明：见表3。b)表3查询企业信息列表接口返回参数列表参数说明数据类型Code状态码：成功返回0，失败返回非0数字Message状态说明数字dataPage页码数字Total返回记录数数字Records总记录数数字rows数字enterpriseType企业类型字符串enterpriseName企业名称字符串manager联系人字符串managerPhone联系电话字符串remark备注字符串c)返回参数示列：{"code":"0","message":"success","page":"1","total":"10","records":"35","id":"245461234564546","enterpriseType":"企业类型","enterpriseName":"企业名称","manager":"联系人","managerPhone":"联系电话","remark":"备注"}}6.3新增或修改企业信息查询接口6.3.1概述主要功能是新增或修改企业信息。4T/GDFCA019—20196.3.2新增或修改企业信息接口函数d)接口说明：新增或修改企业信息e)接口地址：http://serverurl/eniotis/enterpriseInfo.do?action=saveEnterpriseInfof)请求方式：postd)请求参数列表：见表4。表4新增或修改企业信息接口请求参数列表参数是否必填说明数据类型否数字enterpriseName否企业名称字符串creditCode是统一信用代码字符串enterpriseType否企业类型字符串manager否联系人字符串managerPhone否联系电话字符串enterpriseLegaler否企业法人字符串legalerPhone否法人电话字符串address否企业地址字符串返回参数说明：见表5。表5新增或修改企业信息接口返回参数列表参数说明数据类型Code状态码：成功返回0，失败返回非0数字Message状态说明数字data数字f)返回参数示列：{"code":"0","message":"success",}}6.4产品信息列表查询接口6.4.1概述主要功能是获取产品信息列表。6.4.2产品信息列表查询接口函数g)接口说明：查询产品信息列表h)接口地址：http://serverurl/eniotis/productInfo.do?action=listi)请求方式：post。g)请求参数列表：见表6。表6查询产品信息列表接口请求参数列表参数是否必填说明数据类型productName否产品名称字符串barCode否商品条码字符串rows否每页多少条数字page否第几页数字h)返回参数说明：见表7。h)表7查询产品信息列表接口返回参数列表参数说明数据类型Code状态码：成功返回0，失败返回数字Message状态说明数字dataPage页码数字Total返回记录数数字Records总记录数数字rows数字productName产品名称字符串barCode商品条形码字符串productTypeName产品分类字符串brand字符串specifications产品规格字符串specificationUnit规格单位字符串i)返回参数示列：{"code":"0","message":"success","page":"1","total":"10","records":"35","productName":"产品名称","barCode":"商品条形码","productTypeName":"产品分类","specifications":"产品规格","specificationUnit":"规格单位"6T/GDFCA019—2019}}6.5批次信息列表查询接口6.5.1概述主要功能是获取批次信息列表。6.5.2批次信息列表查询接口函数j)接口说明：查询批次信息列表k)接口地址：http://serverurl/eniotis/productInfo.do?action=listl)请求方式：post。j)请求参数列表：见表8。表8查询批次信息列表接口请求参数列表参数是否必填说明数据类型batchCode否批次号字符串productName否商品名称字符串k)返回参数说明：见表9。k)表9查询批次信息列表接口返回参数列表参数说明数据类型Code状态码：成功返回0，失败返回数字Message状态说明数字dataPage页码数字Total返回记录数数字Records总记录数数字rows数字batchCode批次号字符串productName产品名称字符串number数量字符串unitName单位名称字符串formState启用字符串l)返回参数示列：{"code":"0","message":"success","page":"1","total":"10","records":"35","batchCode":"批次号","productName":"产品名称","number":"数量","unitName":"单位名称","formState":"状态"}}6.6装箱事件接口6.6.1概述主要功能是装箱事件操作。6.6.2装箱事件接口函数m)接口说明：装箱事件n)接口地址：http://serverurl/eniotis/packageevent.do?action=packageEvento)请求方式：post。f)请求参数列表：见表10。表10装箱事件接口请求参数列表参数是否必填说明数据类型packageInfoJson是{isUpdate;//BooleanboxCode;//箱码traceCodeList[{traceCode;//被装物品码}字符串返回参数说明：见表11。参数说明数据类型Code状态码：成功返回0，失败返回数字Message状态说明数字h)返回参数示列：{"code":"0","message":"success"8T/GDFCA019—2019}6.7拆箱事件接口6.7.1概述主要功能是拆箱事件操作。6.7.2拆箱事件接口函数p)接口说明：拆箱事件q)接口地址：http://serverurl/eniotis/packageevent.do?action=unpackageEventr)请求方式：post。j)请求参数列表：见表12。表12拆箱事件接口请求参数列表参数是否必填说明数据类型boxCode是箱码字符串k)返回参数说明：见表13。k)表13拆箱事件接口返回参数列表参数说明数据类型Code状态码：成功返回0，失败返回数字Message状态说明数字l)返回参数示列：{"code":"0","message":"success"}m)6.8成品退库和原料退库列表接口6.8.1概述主要功能是查询成品退库和原料退库列表。6.8.2成品退库和原料退库列表接口函数s)接口说明：成品退库和原料退库列表t)接口地址：http://serverurl/eniotis/formInfo.do?action=listReturnOrderu)请求方式：postn)请求参数列表：见表14。表14成品退库和原料退库列表接口请求参数列表参数是否必填说明数据类型formNumber否订单号数字enterpriseName否供应商/经销商字符串productName是原料/成品名称字符串batch否批次号字符串formType否MaterialCancel("原料退库"),ProductCancel("成品退库字符串o)返回参数说明：见表15。o)表15成品退库和原料退库列表接口返回参数列表参数说明数据类型Code状态码：成功返回0，失败返回非0数字Message状态说明数字dataPage页码数字Total返回记录数数字Records总记录数数字rows数字formDate退库日期字符串formNumber订单号字符串enterpriseName供应商/经销商名称字符串productName原料/成名名称字符串p)返回参数示列：{"code":"0","message":"success","formDate":"退库日期"，"formNumber":"订单号"，"enterpriseName":"供应商/经销商名称"，"productName":"原料/成名名称"}}6.9召回订单列表接口6.9.1概述主要功能是查询召回订单列表。6.9.2召回订单列表接口函数v)接口说明：召回订单列表T/GDFCA019—2019w)接口地址：http://serverurl/eniotis/recallFormInfo.do?action=listx)请求方式：postq)请求参数列表：见表16。表16召回订单列表接口请求参数列表参数是否必填说明数据类型productName否成品名称字符串batch否批次号字符串r)返回参数说明：见表17。r)表17召回订单列表接口返回参数列表参数说明数据类型Code状态码：成功返回0，失败返回非0数字Message状态说明数字dataPage页码数字Total返回记录数数字Records总记录数数字rows数字productName商品名称字符串batch批次号字符串produceDate生产日期字符串formStateHasWithDraw("已撤回"),NormalOrder("正常")字符串expiryDate有效期字符串recallNumber召回数量字符串reason原因字符串s)返回参数示列