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

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

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

接口描述#

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

公共请求参数#

参数类型是否必填最大长度描述示例值
_aidString20开放平台系统编号,固定为S107S107
_akeyString20万店掌开放平台分配给第三方的开发者key认证平台开发者后获取
_mtString100接口名称open.ovopark.pos.sendOrder
_smString100签名算法 md5,sha1md5
_requestModeString100请求方式post,getPOST
_versionString100版本号v2
_timestampString100时间戳yyyyMMddHHmmss格式
_sigString32签名token根据签名算法生成,详情见签名算法规则
_formatString10format类型目前默认仅支持json

业务请求参数#

参数类型是否必填最大长度描述示例值
orgId
int11开放平台企业id1
enterpriseId
int11业务平台企业id1
iposJson
JSONpos数据对象的json字符串查看
    
shopId
string60商店id三方店铺id(shopId与depId必传其一,两个字段都传值以depId值为准)DM001
    
depId
int20万店掌门店id(shopId与depId必传其一,两个字段都传值以depId值为准)12
    
shopName
string×512门店名称苏州中心旗舰店
    
machineId
string60收银台 id(如需要视频追溯关联收银台使用小票叠加功能,此字段必传)001
    
cashierId
int×20收银员 id1
    
cashierName
string×100收银员姓名张三
    
guideId
int×20导购员 id121
    
guideNo
string×100导购员编号dm0011
    
ticketId
string60订单号TD-265462654610
    
formerId
string×60原订单号(退单场景必传)SALES-265462654610
    
ticketTimeStr
string60订单时间,时间戳,秒数(非毫秒,注 意)1553187235
    
vipCard
string×50会员卡00121
    
guidePrice
double15,2指导价(即零售金额,计算折让金额时使用)【小票叠加详情展示】12.33
    
price
double15,2实际成交价【小票叠加详情展示】11.22
    
received
double×15,2收款【小票叠加详情展示】11.22
    
returned
double×15,2找零【小票叠加详情展示】1.1
    
refund
int×3是否退货(1:退货,0:非退货)0
    
goods
JSON商品信息查看
        
goodsId
string60商品编号p0124
        
goodsName
string100商品名【小票叠加详情展示】可乐
        
quantity
double15,2数量【小票叠加详情展示】2
        
guidePrice
double15,2指导价(原价)【小票叠加详情展示】5
        
unitPrice
double15,2单价【小票叠加详情展示】2.5
        
discount
double15.2折扣【小票叠加详情展示】0.3
        
price
double15,2实际成交价【小票叠加详情展示】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付费方式查看
        
paymentType
string32支付种类【小票叠加详情展示】1,2,3,4,5,6,7,8,9,10
        
paymentName
string32支付名称【小票叠加详情展示】现金,支付宝,微信,银行卡,医保卡,收钱吧,信用卡,京东支付,抵用券,购物卡
        
price
double15.2金额【小票叠加详情展示】1.33

公共响应参数#

参数类型最大长度描述示例值
statJSON-网关状态(具体参数描述如下:)查看
stat.cidString100http请求的标识符
stat.codeString100网关返回码
stat.codenameString100网关返回码名称
stat.systimeStringLong接口调用的当前时间
resultString100接口返回提示信息
dataJSON-接口调用返回的业务信息(一般是json格式数据,具体数据格式会在业务返回参数中定义)查看

业务返回参数#

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

公共返回码#

返回码名称返回码返回码描述解决方案
SUCCESS0调用成功
KEY_NOTNULL1_akey和不能为空接口调用时传入_akey参数
KEY_UNLAWFUL2_akey不合法key是非法的,传入正确的key
KEY_HAS_EXPIRED3_akey已过期请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL4_sm参数不能为空接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST5_sm类型不存在目前仅支持md5,sha1
SIGN_NOTNULL6_sig参数不能为空接口调用时传入_sig参数
SIGN_WRONG7无效的签名,请检查参数和签名格式_sig值根据签名算法生成
METHOD_NOTNULL8_mt参数不能为空接口调用时传入_mt参数
METHOD_NOTEXIST_CODE9_mt对应的方法名不存在或未注册进服务检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL10_requestMode参数不能为空接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL11_aid参数不能为空接口调用时传入_aid参数
APPLICATIONID_NOTSAME12_aid与当前key不匹配_aid与_akey必须一一对应
VERSION_NOTNULL13_version版本号不能为空接口调用时传入_version参数
TIMESTAMP_NOTNULL14_timestamp时间戳不能为空接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR15_timestamp时间戳格式化错误按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME16_timestamp已失效_timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST17_format类型不存在目前仅支持json(默认),xml
API_CALL_REPEAT-100接口重复调用接口平台调用异常
API_SYSTEM_CALL_ERROR-500api调用失败,系统发生异常接口平台调用异常
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
206999business-base服务调用异常
ORDER_NUMBER_DUPLICATION
208003订单号重复
API_SERVICE_ERROR
999999api服务未知异常