万店掌 开放平台 事件追溯上报接口
{ "idx": null }

open.ovopark.event.sendEventOrder （事件追溯上报接口）

事件追溯上报接口

接口描述 #

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

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 是 20 开放平台系统编号，固定为S107 S107
_akey String 是 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 是 100 接口名称 open.ovopark.event.sendEventOrder
_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 1
enterpriseId		 int √ 11 业务平台企业id 1
iposJson		 JSON √ - json字符串 查看
    
eventNum		 string √ 100 事件编码 906166561
    
areaNumber		 string √ 100 区域编号 1
    
eventTimeStr		 string √ 100 事件时间 2021-05-10 18:48:14
    
eventName		 string √ 100 事件名称(通过https://docs.open.ovopark.com/apidoc/detail/11/744/open.ovopark.pos.getDictsByTree/v1/0 接口获取) type=event_type，取【name】属性 晨会追溯
    
eventType		 string √ 1 事件类型(通过https://docs.open.ovopark.com/apidoc/detail/11/744/open.ovopark.pos.getDictsByTree/v1/0 接口获取) type=event_type，取【value】属性 3
    
userId		 string × 100 操作人ID 1
    
userName		 string × 100 操作人 卢松和5
    
depId		 int √ 11 门店ID 31279
    
participants		 int × 11 参与人数 1

公共响应参数 #

参数 类型 最大长度 描述 示例值
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格式数据，具体数据格式会在业务返回参数中定义) 查看

业务返回参数 #

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

公共返回码 #

返回码名称 返回码 返回码描述 解决方案
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服务调用异常
EVENT_NUM_DUPLICATION		 208021 事件编码重复
NOT_EXIST_EVENT_TYPE		 208022 事件类型不存在