method: allinpay.shopoint.couponService.couponConsumePageQuery
version: 1.0
前置接口:需要先调用3.1.6统一登录注册入口(scope=4登录商户后台)获取到token
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
token |
String |
是 |
|
调用3.1.6 统一登录(scope=4)后获得的token。 |
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
consumeStartTime |
String |
否 |
|
核销开始时间 |
格式:yyyy-MM-dd HH:mm:ss |
consumeEndTime |
String |
否 |
|
核销结束时间 |
格式:yyyy-MM-dd HH:mm:ss 建议在同一条件分页查询时,始终指定一个结束时间,避免新增数据干扰查询结果 |
couponName |
String |
否 |
|
券名称 |
|
promotionId |
Integer |
否 |
|
活动Id |
|
couponType |
Integer |
否 |
|
券类型 |
0,金额券 2,计次券 3,满减券 |
consumeType |
Integer |
否 |
|
交易方式 |
30,大众码牌订单核券 31,POS订单 32,商城订单 33,码牌订单 34,POS直接核券 35,导购直接核券 42,接口核券 311,订单取消 312,API接口撤销交易 |
customerName |
String |
否 |
|
会员姓名 |
|
customerMobile |
String |
否 |
|
会员手机号 |
|
operatorName |
String |
否 |
|
操作员 |
|
sendShopName |
String |
否 |
|
发券店铺名称 |
|
consumeShopName |
String |
否 |
|
消费门店名称 |
|
couponNo |
String |
否 |
|
券号 |
|
tranNo |
String |
否 |
|
流水号 |
|
orderCode |
String |
否 |
|
订单号 |
|
outOrderId |
String |
否 |
|
外部订单号 |
|
sendOrgId |
Integer |
否 |
|
发券机构Id |
token身份为集团机构可用,且与consumeOrgId必传一个 |
consumeOrgId |
Integer |
否 |
|
核券机构Id |
token身份为集团机构可用,且与consumeOrgId必传一个 |
dimension |
Integer |
否 |
|
查看维度 |
token身份为集团机构可用 1,按发券归属查看 2,按核券归属查看
|
remark |
String |
否 |
|
备注 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
是 |
|
错误信息 |
|
||
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
pageNo |
Integer |
是 |
|
分页页码 |
|
||
pageSize |
Integer |
是 |
|
分页大小 |
|
||
resultList |
List |
否 |
|
流水分页 |
|
||
|
changeId |
Integer |
是 |
|
交易Id |
|
|
sendOrgId |
Integer |
是 |
|
发券机构Id |
|
||
sendOrgName |
String |
是 |
|
发券机构名称 |
|
||
consumeOrgId |
String |
是 |
|
核券机构Id |
|
||
consumeOrgName |
Integer |
是 |
|
核券机构名称 |
|
||
promotionId |
Integer |
是 |
|
券活动ID |
|
||
couponNo |
Integer |
是 |
|
券号 |
|
||
orderCode |
Integer |
是 |
|
订单号 |
|
||
outOrderId |
Integer |
是 |
|
外部订单号 |
|
||
tranNo |
String |
是 |
|
流水号 |
|
||
cardNo |
String |
否 |
|
实体卡号 |
|
||
couponName |
Integer |
否 |
|
券名称 |
|
||
couponType |
String |
否 |
|
券类型 |
0-金额券,2-计次券,3-满减券 |
||
balanceChanged |
BigDecimal |
是 |
|
交易数量(元/张) |
|
||
newBalance |
BigDecimal |
是 |
|
余额(元/张) |
|
||
createSourceDesc |
String |
|
|
发券门店 |
|
||
createTime |
String |
|
|
交易时间 |
yyyy-MM-dd HH:mm:ss |
||
orderRemark |
String |
|
|
交易备注 |
|
||
createUserName |
String |
|
|
发卡备注 |
|
||
changeSource |
Integer |
|
|
来源编号 |
|
||
changeSourceDesc |
String |
|
|
来源描述 |
|
||
name |
String |
|
|
会员姓名 |
|
||
mobile |
String |
|
|
会员手机号 |
|
||
nickName |
String |
|
|
会员昵称 |
|
||
orgOpenId |
String |
|
|
openid |
|
||
shopId |
Integer |
|
|
消费门店编号 |
|
||
shopName |
String |
|
|
消费门店名称 |
|
||
shopCode |
String |
|
|
店铺号 |
|
||
|
|
consumeUserName |
String |
|
|
操作员 |
|
|
|
referee |
String |
|
|
推荐人(券来源) |
|
请求示例
{
"pageNo": "1",
"pageSize": "10",
"consumeTimeStart": "2022-08-26 14:00:00",
"consumeTimeEnd": "2022-08-26 17:00:00"
}
响应示例
{
"total": 2,
"pageNo": 1,
"pageSize": 10,
"resultList": [
{
"changeSource": 311,
"couponName": "lq121401",
"createTime": "2022-08-26 14:41:02",
"couponType": 0,
"newBalance": 400,
"couponNo": "83000100000000055331",
"changeId": 272525,
"shopId": 147,
"templateId": 6244620,
"balanceChanged": 400,
"createUserLoginName": "hl导购"
},
{
"changeSource": 31,
"couponName": "lq121401",
"createUserId": 358,
"createTime": "2022-08-26 14:39:16",
"couponType": 0,
"newBalance": 0,
"couponNo": "83000100000000055331",
"changeId": 272522,
"shopId": 147,
"templateId": 6244620,
"balanceChanged": -400,
"createUserLoginName": "hl导购"
}
]
}