万店掌 开放平台 查询pos订单
联系我们

open.ovopark.pos.searchPos (查询pos订单)沙箱调试

查询pos订单,需要在请求头中添加token,token获取可以在此接口https://docs.open.ovopark.com/apidoc/detail/12/118/open.shopweb.security.mobileLogin/v1中获得

接口描述#

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

公共请求参数#

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

业务请求参数#

参数类型是否必填最大长度描述示例值
depId
int11万店掌门店id(系统默认分配)17465
startTime
string60起始时间2020-04-15 11:30:46
endTime
string60结束时间2020-04-15 11:32:47
no
string11页码1
size
string11每页大小最大限制50

公共响应参数#

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

业务返回参数#

参数名称类型是否一定返回返回最大长度描述示例值
id
int×20id2123
shopName
string×512门店名称苏州中心旗舰店
ticketTime
string×60订单时间2020-04-15 11:30:46
machineId
string×60收银台 id(如需要视频追溯关联收银台使用小票叠加功能)001
cashierId
string×60收银员 id001
cashierName
string×100收银员姓名cw
guideId
string×60导购id001
guideNo
string×100导购员编号2546
vipCard
string×50会员卡 (输出的是手机号)18695855547
tGuidePrice
double×60指导价 (即零售金额,计算折让金额时使用)12.33
tPrice
double×60实际成交价【小票叠加详情展示】11.22
received
double×60收款【小票叠加详情展示】11.22
returned
double×60找零【小票叠加详情展示】1.1
refund
int×3是否退货(1:退货,0:非退货)0
depId
int×20万店掌门店id(系统默认分配)12
tTicketId
string×60订单号Tk2020300354
shopId
string×60商店id三方店铺id7194
goodsVos
JSON×商品信息查看
    
goodsId
string×60商品编号DM3652
    
goodsName
string×100商品名小伙子
    
colourId
string×60颜色编号2655
    
colourName
string×60颜色名
    
sizeId
string×60尺寸编号2254
    
sizeName
string×60尺寸名1
    
unitPrice
double×15,2单价【小票叠加详情展示】2.5
    
discount
double×15,2折扣【小票叠加详情展示】0.3
    
price
double×15,2实际成交价【小票叠加详情展示】4.4
    
guidePrice
double×15,2指导价(原价)【小票叠加详情展示】5
    
quantity
double×15,2数量【小票叠加详情展示】2
    
saleNum
int×销售数量1
posPaymentsVos
JSON×付费方式查看
    
paymentType
string×32支付种类【小票叠加详情展示】1
    
paymentName
string×32支付名称【小票叠加详情展示】现金
    
price
double×15,2金额1.33

公共返回码#

返回码名称返回码返回码描述解决方案
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_UNBOUN
206003业务平台未做绑定,请联系客服
DEPARTMENT_NOT_EXIST
206004部门不存在
AGENT_PERMISSION_DENIED
206006代理商没有此企业权限
API_SERVICE_ERROR
999999api服务未知异常
GOODS_NOT_BE_EMPTY_CODE
208004商品详情不能为空
DATE_FORMAT_ERROR_CODE
208006日期格式化错误
QUERY_SIZE_LIMIT_ERROR_CODE
208015每页查询大小不可超过100个
QUERY_TIME_LIMIT_ERROR_CODE
208016最大查询时间范围 1 小时
CALL_TIMES_LIMIT_ERROR_CODE
208017调用次数超过上限300次
POS_DATA_IS_EMPTY_CODE
208018POS数据不存在