open.ovopark.pos.reportSales (上报销售额(按天))
上报销售额(按天), 业务平台企业id可以通过权限api【open.gateway.authentication】获取
Interface Description #
| Environment | Interface Method | Submission Method | Requires Signature | The identifier of the http request |
|---|---|---|---|---|
| Formal environment | open.ovopark.pos.reportSales | 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.reportSales |
| _sm | String | Yes | 100 | Signature algorithm md5, sha1 | md5 |
| _requestMode | String | Yes | 100 | Request method post, get | POST |
| _version | String | Yes | 100 | Version number | v1 |
| _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 |
|---|---|---|---|---|---|
| int | √ | 11 | Business platform enterprise id | 12 | |
| string | √ | 100 | Purchases | 1 | |
| string | √ | 100 | Commodity price | 100 | |
| string | √ | 100 | Number of consumers | 1 | |
| string | √ | 100 | Statistics time (yyyy-MM-dd format) | 2019-08-21 | |
| int | × | 11 | Business platform store id (both depId and shopId must be passed, priority is depId> shopId) | 9808 | |
| string | × | 100 | Business platform store code (both depId and shopId must be passed, priority is depId> shopId) | D000001 | |
| int | × | 1 | Whether to cover 0: No, 1: Yes(by default, the data for the next day of the next store in an enterprise is not allowed to be submitted repeatedly. This field is used to cover the use of sales for the day) | 0 |
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 |
|---|---|---|
| 206001 | 开放平台用户不存在 | |
| 208001 | 销售额重复提交 | |
| 208006 | 日期格式化错误,请按照文档指定的格式上报 |
