万店掌 开放平台 效期数据上报
{ "idx": null }

open.ovopark.expiryDate.sendExpiryDateRecord （效期数据上报）

效期系统：指物料到期检测系统。 业务流程：店员A打票，票信息包含（物料名称、物料份数、打印票数、打票时间a、保存时间）——用完/报损（报损量），即票的状态变更 效期编号：票的id，系统中具有唯一性，类似pos系统中的订单id；

接口描述 #

环境 接口方法 提交方式 是否需要签名 HTTP请求路由
正式环境 open.ovopark.expiryDate.sendExpiryDateRecord POST true http://cloudapi.ovopark.com/cloud.api

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 是 20 开放平台系统编号，固定为S107 S107
_akey String 是 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 是 100 接口名称 open.ovopark.expiryDate.sendExpiryDateRecord
_sm String 是 100 签名算法 md5,sha1 md5
_requestMode String 是 100 请求方式post,get POST
_version String 是 100 版本号 v1
_timestamp String 是 100 时间戳 yyyyMMddHHmmss格式
_sig String 是 32 签名token 根据签名算法生成，详情见签名算法规则
_format String 否 10 format类型 目前默认仅支持json

业务请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
orgId		 int √ 11 开放平台企业ID 66
enterpriseId		 int √ 11 万店掌企业ID 1084
iposJson		 JSON √ 0 请求JSON格式消息体 查看
    
shopId		 string √ 100 三方店铺id(shopId与depId二选一，必传一个) test001
    
depId		 string √ 100 万店掌店铺id(shopId与depId二选一，必传一个) 30806
    
expiryDateNo		 string √ 100 效期编号（唯一） t-000000000001
    
inputer		 string √ 100 操作人 jack
    
expiryDateDeviceNo		 string √ 100 效期设备编号（与视频设备绑定后用于指定此条记录的追溯） 001
    
ticketTime		 string √ 100 开封时间(用于视频追溯的时间点 , yyyy:MM:dd HH:mm:ss 格式) 2023-03-08 08:00:00
    
stuff		 string √ 100 物料 绿茶
    
saveMode		 string √ 100 保存方式 常温
    
saveTime		 dubble × 10 保存时间,默认单位是小时，允许小数点后最多1位(例如10.5小时)，saveTime 和saveTimeMinute 只能传1个 24
    
saveTimeMinute		 dubble × 10 保存时间(分钟) ，saveTime 和saveTimeMinute 只能传1个 30
    
handlingStatus		 int × 1 处理状态(1：未处理，2：已用完，3：已报损) 1
    
handlingTime		 string × 100 处理时间(yyyy:MM:dd HH:mm:ss 格式) 2023-03-09 16:00:00
    
remarks		 string × 100 当保存时间不传的时候，例如传明天打样的时候，传此字段 明天打样
    
totalCopies		 int × 11 总物料 10
    
usedCopies		 int × 11 已使用物料 5
    
reportingCopies		 int × 11 已报损物料 5
    
unitOfCopies		 string × 100 份数单位 斤
    
expireTime		 string × 0 到期时间

公共响应参数 #

参数 类型 最大长度 描述 示例值
stat JSON - 网关状态(具体参数描述如下：) 查看
stat.cid String 100 http请求的标识符
stat.code String 100 网关返回码
stat.codename String 100 网关返回码名称
stat.systime String Long 接口调用的当前时间
result String 100 接口返回提示信息
data JSON - 接口调用返回的业务信息(一般是json格式数据，具体数据格式会在业务返回参数中定义) 查看

业务返回参数 #

参数名称 类型 是否一定返回 返回最大长度 描述 示例值
code		 int × 0 0 success

公共返回码 #

返回码名称 返回码 返回码描述 解决方案
SUCCESS 0 调用成功
KEY_NOTNULL 1 _akey和不能为空 接口调用时传入_akey参数
KEY_UNLAWFUL 2 _akey不合法 key是非法的,传入正确的key
KEY_HAS_EXPIRED 3 _akey已过期 请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL 4 _sm参数不能为空 接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST 5 _sm类型不存在 目前仅支持md5,sha1
SIGN_NOTNULL 6 _sig参数不能为空 接口调用时传入_sig参数
SIGN_WRONG 7 无效的签名，请检查参数和签名格式 _sig值根据签名算法生成
METHOD_NOTNULL 8 _mt参数不能为空 接口调用时传入_mt参数
METHOD_NOTEXIST_CODE 9 _mt对应的方法名不存在或未注册进服务 检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL 10 _requestMode参数不能为空 接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL 11 _aid参数不能为空 接口调用时传入_aid参数
APPLICATIONID_NOTSAME 12 _aid与当前key不匹配 _aid与_akey必须一一对应
VERSION_NOTNULL 13 _version版本号不能为空 接口调用时传入_version参数
TIMESTAMP_NOTNULL 14 _timestamp时间戳不能为空 接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR 15 _timestamp时间戳格式化错误 按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME 16 _timestamp已失效 _timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST 17 _format类型不存在 目前仅支持json(默认),xml
API_CALL_REPEAT -100 接口重复调用 接口平台调用异常
API_SYSTEM_CALL_ERROR -500 api调用失败，系统发生异常 接口平台调用异常
UNKNOWN_ERROR -999 开放平台系统异常 重新发起请求

业务返回码 #

返回码名称 返回码 返回码描述
OPEN_USER_IS_NULL		 206001 开放平台用户不存在
BUSINESS_PLATFORM_UNBOUND		 206003 业务平台未做绑定,请联系客服
DEPARTMENT_NOT_EXIST		 206004 部门不存在
ORGANIZATIONAL_MISMATCH		 206005 组织架构不匹配
AGENT_PERMISSION_DENIED		 206006 代理商没有此企业权限
BUSINESS_BASE_ERROR		 206999 business-base服务调用异常
EXPIRYDATE_UPDATE_ERROR		 208027 效期数据更新异常,缺少处理状态或处理时间字段
API_SERVICE_ERROR		 999999 api服务未知异常