万店掌 开放平台 订单数据上报(支持代理商权限)

open.ovopark.pos.sendOrder (订单数据上报(支持代理商权限))

订单数据上报(支持代理商权限),代理商权限根据【权限API】open.gateway.getBusinessOrg接口获取

接口描述 #

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

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 20 开放平台系统编号,固定为S107 S107
_akey String 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 100 接口名称 open.ovopark.pos.sendOrder
_sm String 100 签名算法 md5,sha1 md5
_requestMode String 100 请求方式post,get POST
_version String 100 版本号 v2
_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 500 pos数据对象的json字符串 查看
    
shopId
string 60 商店id三方店铺id(shopId与depId必传其一,两个字段都传值以depId值为准) DM001
    
depId
int × 20 万店掌门店id(shopId与depId必传其一,两个字段都传值以depId值为准) 12
    
shopName
string × 512 门店名称 苏州中心旗舰店
    
machineId
string 60 收银台 id(如需要视频追溯关联收银台使用小票叠加功能,此字段必传) 001
    
cashierId
int × 20 收银员 id 1
    
cashierName
string × 100 收银员姓名 张三
    
guideId
int × 20 导购员 id 121
    
guideNo
string × 100 导购员编号 dm0011
    
ticketId
string 60 订单号 TD-265462654610
    
formerId
string × 60 原订单号(退单场景必传) SALES-265462654610
    
ticketTimeStr
string 60 订单时间,时间戳,秒数(非毫秒,注 意) 1553187235
    
vipCard
string × 50 会员卡 00121
    
guidePrice
double 15 指导价(即零售金额,计算折让金额时使用)【小票叠加详情展示】 12.33
    
price
double 15 实际成交价【小票叠加详情展示】 11.22
    
received
double × 15 收款【小票叠加详情展示】 11.22
    
returned
double × 15 找零【小票叠加详情展示】 1.1
    
refund
int × 3 是否退货(1:退货,0:非退货) 0
    
vipPhone
string × 50 会员手机号 18852023879
    
orderType
int × 1 订单来源:1常规订单:2线下预存:3批发订单;4行清订单;5取消订单;6网上订单 1
    
orderRemarks
string 500 订单备注 这是订单备注
    
goods
JSON 11 商品信息 查看
        
goodsId
string 60 商品编号 p0124
        
goodsName
string 100 商品名【小票叠加详情展示】 可乐
        
quantity
double 15 数量【小票叠加详情展示】 2
        
guidePrice
double 15 指导价(原价)【小票叠加详情展示】 5
        
unitPrice
double 15 单价【小票叠加详情展示】 2.5
        
discount
double 15 折扣【小票叠加详情展示】 0.3
        
price
double 15 实际成交价【小票叠加详情展示】 4.4
        
colourId
string × 60 颜色编号 0202
        
colourName
string × 60 颜色名 红色
        
sizeId
string × 60 尺寸编号 1
        
sizeName
string × 60 尺寸名 1
        
salesType
string × 100 销售类型 通过open.ovopark.pos.getDictsByTree接口sales_type获取销售类型
        
salesName
string × 100 销售类型名称
    
payments
JSON 500 付费方式 查看
        
paymentType
string 32 支付种类【小票叠加详情展示】 1,2,3,4,5,6,7,8,9,10
        
paymentName
string 32 支付名称【小票叠加详情展示】 现金,支付宝,微信,银行卡,医保卡,收钱吧,信用卡,京东支付,抵用券,购物卡
        
price
double 15 金额【小票叠加详情展示】 1.33

公共响应参数 #

参数 类型 最大长度 描述 示例值
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 × 11 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服务调用异常
ORDER_NUMBER_DUPLICATION
208003 订单号重复
API_SERVICE_ERROR
999999 api服务未知异常