Register

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

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

Interface Description #

Environment Interface Method Submission Method Requires Signature The identifier of the http request
Formal environment open.ovopark.pos.sendOrder POST true https://openapi.opretail.com/cloud.api

Public Request Parameters #

Parameter Type Required Max Length Description Example Value
_aid String Yes 20 Open platform system ID, fixed as S107 S107
_akey String Yes 20 Developer key assigned by Wanzdianzhang Open Platform to third parties Obtained after authenticating platform developer
_mt String Yes 100 Interface name open.ovopark.pos.sendOrder
_sm String Yes 100 Signature algorithm md5, sha1 md5
_requestMode String Yes 100 Request method post, get POST
_version String Yes 100 Version number v2
_timestamp String Yes 100 Timestamp yyyyMMddHHmmss format
_sig String Yes 32 Signature token Generated according to signature algorithm, see signature algorithm rules for details
_format String No 10 Format type Currently only json is supported by default

Business Request Parameters #

Parameter Type Required Max Length Description Example Value
orgId int √ 11 Open platform enterprise id 1
enterpriseId int √ 11 Business platform enterprise id 1
iposJson JSON √ json string of pos data object View
shopId string √ 60 Store id three-party store id DM001
depId int √ 20 Wandian palm store id (shopId and depId must be passed one, both fields are passed the depId value) 12
shopName string × 512 Store name Suzhou Center Flagship Store
machineId string √ 60 Cashier id (this field must be passed if you need to use the ticket superimposition function to associate the cashier with video traceback 001
cashierId int × 20 Cashier id 1
cashierName string × 100 Cashier name Zhang San
guideId int × 20 Shopping guide id 121
guideNo string × 100 Shopping guide number dm0011
ticketId string √ 60 order number dm265462654610
ticketTimeStr string √ 60 Order time, time stamp, seconds (not milliseconds, note) 1553187235
vipCard string × 50 membership card 00121
guidePrice double × 15,2 Guide price 12.33
price double √ 15,2 Actual transaction price [small ticket overlay details display] 11.22
received double × 15,2 Collection 11.22
returned double × 15,2 Change 1.1
refund int × 3 Whether to return (1: return, 0: non-return) 0
goods JSON √ Product information View
goodsId string √ 60 Product Number p0124
goodsName string √ 100 Product name [Small ticket overlay details display] Cola
quantity double √ 15,2 Quantity [Small ticket overlay details display] 2
guidePrice double √ 15,2 Guide price [small ticket overlay details display] 2.5
unitPrice double √ 15,2 Unit price [Small ticket overlay details display] 2.5
discount double √ 15.2 Discount [Ticket overlay details display] 0.3
price double √ 15,2 Actual transaction price [small ticket overlay details display] 2.2
colourId string × 60 Color number 0202
colourName string × 60 Color name red
sizeId string × 60 Size number 1
sizeName string × 60 Size name 1
payments JSON √ Payment methods View
paymentType string √ 32 Payment type [Small ticket overlay details display] 1
paymentName string √ 32 Payment name [Small ticket overlay details display] cash
price double √ 15.2 Amount [Small ticket overlay details display] 1.33

Public Response Parameters #

Parameter Type Max Length Description Example Value
stat JSON - Gateway status (specific parameters are described as follows: View
stat.cid String 100 The identifier of the http request
stat.code String 100 Gateway return code
stat.codename String 100 Gateway return code name
stat.systime String Long The current time of the interface call
result String 100 The interface returns prompt information
data JSON - Business information returned by the interface call (usually in JSON format, the specific data format will be defined in the business return parameters) View

Business Response Parameters #

apiDetail.parameterName Type Required Max Length Description Example Value

Public Return Codes #

Return code name Return code Return Code Description Solution
SUCCESS 0 Call success
KEY_NOTNULL 1 _akey cannot be empty Pass in the _akey parameter when calling the interface
KEY_UNLAWFUL 2 _akey is illegal The key is illegal, enter the correct key
KEY_HAS_EXPIRED 3 _akey has expired Please renew your service or contact the platform administrator
SIGN_METHOD_NOTNULL 4 The _sm parameter cannot be empty Pass in the _sm parameter when calling the interface
SIGN_TYPE_NOTEXIST 5 _sm type does not exist Currently only supports md5, sha1
SIGN_NOTNULL 6 The _sig parameter cannot be empty Pass in the _sig parameter when calling the interface
SIGN_WRONG 7 Invalid signature, please check the parameters and signature format The _sig value is generated according to the signature algorithm
METHOD_NOTNULL 8 apiDetail.mtParameterCannotBeEmpty apiDetail.passInTheMtParameterWhenCallingTheInterface
METHOD_NOTEXIST_CODE 9 The method name corresponding to _mt does not exist or is not registered in the service Check whether the method corresponding to the _mt method name and _version version number has an error in passing
REQUESTMODE_NOTNULL 10 The _requestMode parameter cannot be empty Pass in the _requestMode parameter when calling the interface
APPLICATIONID_NOTNULL 11 _aid parameter cannot be empty Pass in the _aid parameter when calling the interface
APPLICATIONID_NOTSAME 12 _aid does not match the current key _aid and _akey must correspond one to one
VERSION_NOTNULL 13 _version version number cannot be empty Version number
TIMESTAMP_NOTNULL 14 _timestamp timestamp cannot be empty Pass in the _timestamp parameter when calling the interface
TIMESTAMP_FORMAT_ERROR 15 _timestamp timestamp format error Follow the yyyyMMddHHmmss format
TIMESTAMP_OVERTIME 16 _timestamp has expired _timestamp is regenerated each time the interface is called
FORMAT_TYPE_NOTEXIST 17 _format type does not exist Currently only supports json (default), xml
API_CALL_REPEAT -100 Interface duplicate call Interface platform call exception
API_SYSTEM_CALL_ERROR -500 API call failed, system exception Interface platform call exception
UNKNOWN_ERROR -999 Open platform system exception Reinitiate request

Business Return Codes #

Return code name Return code Return Code Description
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服务未知异常