接口介绍
根据商户或者收银员id来查询订单订单列表。
参数简介
| 参数名 |
参数类型 |
参数介绍 |
是否必填 |
是否参与签名 |
| command |
String(32) |
接口名，用于标识调用哪个接口，订单拉取：open.pay.orderlist |
是 |
否 |
| operator_id |
String(32) |
收银员的id，用于标识收款账户， |
选择性必填,与client_id二选一 |
是 |
| client_id |
String(32) |
商户的id，用于标识收款账户 |
选择性必填，与client_id二选一 |
是 |
| app |
String(32) |
接入商标识 |
是 |
是 |
| sign |
String(32) |
签名，详见请求签名规则 |
是 |
否 |
| page |
int |
当前页码 |
是 |
是 |
| start_date |
String(16) |
开始时间，格式:yyyyMMddHHmmss |
是 |
是 |
| end_date |
String(16) |
开始时间，格式:yyyyMMddHHmmss |
是 |
是 |
返回值说明
| 参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
| success |
result |
boolean |
标识这次请求是否成功 |
请不要用这个值来判断收银是否成功。 |
| errorCode |
result |
String |
错误码 |
|
| errorMsg |
result |
String |
错误码的详细说明 |
|
| cPage |
data |
int |
当前页码 |
参与签名 |
| pageSize |
data |
int |
每页条数 |
参与签名 |
| totalPage |
data |
int |
总页数 |
参与签名 |
| totalCount |
data |
int |
总条数 |
参与签名 |
| sign |
data |
String |
签名值 |
具体参照：接口返回值的安全校验规则 |
| timestamp |
data |
long |
时间戳 |
参与签名 |
| localOrderNo |
data.orders |
String |
本地订单号 |
|
| cbOrderNo |
data.orders |
String(64) |
采宝的订单号，最长64位 |
|
| outOrderNo |
data.orders |
String(64) |
支付宝、微信等的订单号id，最长64位 |
|
| orderStatus |
data.orders |
int |
订单状态 |
该状态用于判断收银是否成功，具体取值请参照：名词解释 |
| totalAmount |
data.orders |
long |
订单金额（分为单位） |
|
| receiveAmount |
data.orders |
long |
收款金额（分为单位） |
|
| refundAmount |
data.orders |
Long |
退款金额（分为单位） |
|
| refundTime |
data.orders |
Long |
最后一次退款时间，时间戳 |
|
| tradeType |
data.orders |
int |
交易类型 1: 收款 2：退款 |
|
| paymentChannel |
data.orders |
int |
支付渠道 |
具体取值请参照：名词解释 |
| subject |
data.orders |
String |
订单主题 |
|
| discountAmount |
data.orders |
long |
优惠金额(分为单位） |
|
| paymentWay |
data.orders |
String |
付款方式 |
具体取值参照：名词解释 |
| payTime |
data.orders |
long |
支付时间，格式为时间戳 |
|
| merchantCode |
data.orders |
String |
商户号 |
|
| storeId |
data.orders |
String |
门店Id |
|
| operatorId |
data.orders |
String |
收银员ID |
|
| refundOperatorId |
data.orders |
String |
退款收银员ID |
只在退款交易中有值 |
返回值举例
{
"result": {
"success": false,
"errorCode":"10",
"errorMsg": "command参数为空"
}
"data":{
"cPage":"1",
"pageSize":"10",
"totalPage":"10",
"totalCount":"99",
"sign":"xxxxxx",
"timestamp":"12346469745646",
"orders":[
{
"localOrderNo":"",##本地订单号
"cbOrderNo":"",##采宝的订单号
"outOrderNo":"",##微信、支付宝、百度钱包、翼支付等服务商的订单号
"orderStatus":"", ## 订单状态
"subject":"", ## 订单描述
"tradeType":"1", ## 交易类型 1:收款 2:退款
"paymentChannel":"", ##支付渠道
"paymentWay":"", ##支付方式
"payTime":"",## 支付方式
"totalAmount":"",## 总额(分为单位)
"receiveAmount":"", ## 收到的金额（分为单位）
"refundAmount":"",##退款金额
"refundTime":"",##退款时间
"merchantCode":"A00300100000035",## 商户号
"storeId":"1234",## 门店ID
"operatorId":"xxxxxxx",## 收银员ID
"refundOperatorId":"xxxxxxx",## 退款收银员ID
##===========以下字段只有version大于等于1.1时才会返回========
,"discountAmount":""##优惠金额
}
]
}
}