TIP
# 新增费用池增加流水
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/v1/addExportAmountFlow/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
bas_cm_customer | int8 | 是 | 客户id,客户id和客户编码必须传一个 |
bas_cm_code | varchar(4000) | 是 | 客户编码,客户id和客户编码必须传一个 |
rebate_account | int8 | 是 | 账户id,账户id和账户编码必须传一个 |
rebate_account_code | varchar(4000) | 是 | 账户编码,账户id和账户编码必须传一个 |
rebate_amount_in | NUMERIC(20,2) | 是 | 增加金额 |
remark | varchar(4000) | 是 | 备注 |
rebate_period | date | 是 | 使用有效期截止。格式:yyyy-mm-dd |
type | varchar(4000) | 否 | 增加类型 |
date | TIMESTAMP | 否 | 业务时间。格式:yyyy-MM-dd HH:mm:ss |
source_code | varchar(32) | 否 | 增加流水sourcecode |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 费用池增加流水查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/v1/queryCmFlowOrderUpByMap/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page_numbe | INT | 否 | 当前页数,不传默认为1 |
page_length | INT | 否 | 每页记录条数,默认最大是1000条,可以根据业务数据的大小自行优化调整 |
start_create_date | TIMESTAMP | 否 | 创建时间开始。格式:yyyy-MM-dd |
end_create_date | TIMESTAMP | 否 | 创建时间结束。格式:yyyy-MM-dd |
start_modify_date | TIMESTAMP | 否 | 修改时间开始。格式:yyyy-MM-dd |
end_modify_date | TIMESTAMP | 否 | 修改时间结束。格式:yyyy-MM-dd |
start_period_date | TIMESTAMP | 否 | 有效期至时间开始。格式:yyyy-MM-dd |
end_period_date | TIMESTAMP | 否 | 有效期至时间结束。格式:yyyy-MM-dd |
cm_code | varchar(100) | 否 | 客户编码 |
account_code | varchar(100) | 否 | 账户编码 |
sourcecode | varchar(100) | 否 | sourcecode |
remark | varchar(300) | 否 | 备注 |
bill_no | varchar(100) | 否 | 关联单据 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"flow_no":"SR20200918000009",
"cm_id":5950706195173244407,
"rebate_account_id":7097038094955291930,
"rebate_amount_in":0.30,
"rebate_type":999,
"rebate_type_name":"外部接口写入",
"remark":"",
"sourcecode":"",
"rebate_period":"2020-10-16 00:00:00",
"create_time":"2020-09-18 13:34:18",
"creator_id":998
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
id | VARCHAR(32) | 增加流水id |
flow_no | VARCHAR(32) | 增加流水号 |
cm_id | VARCHAR(32) | 客户id |
cm_code | VARCHER(32) | 客户编码 |
rebate_account_id | VARCHAR(32) | 账户id |
rebate_account_code | VARCHAR(32) | 账户编码 |
rebate_amount_in | NUMERIC(20,2) | 增加金额 |
rebate_type | VARCHAR(32) | 增加类型id |
rebate_type_name | VARCHAR(100) | 增加类型名称 |
remark | VARCHAR(32) | 备注 |
rebate_period | VARCHAR(32) | 使用有效期截止 |
create_time | VARCHAR(32) | 创建时间 |
creator_id | VARCHAR(32) | 创建人 |
rebate_leave_amount | NUMERIC(20,2) | 剩余金额 |
bill_id | VARCHAR(32) | 关联单据 |
sourcecode | VARCHAR(32) | sourcecode |
# 费用池减少流水查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/v1/queryCmFlowOrderReduceByMap/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page_numbe | INT | 否 | 当前页数,不传默认为1 |
start_create_date | TIMESTAMP | 否 | 创建时间开始。格式:yyyy-MM-dd |
end_create_date | TIMESTAMP | 否 | 创建时间结束。格式:yyyy-MM-dd |
start_modify_date | TIMESTAMP | 否 | 修改时间开始。格式:yyyy-MM-dd |
end_modify_date | TIMESTAMP | 否 | 修改时间结束。格式:yyyy-MM-dd |
start_period_date | TIMESTAMP | 否 | 有效期至时间开始。格式:yyyy-MM-dd |
end_period_date | TIMESTAMP | 否 | 有效期至时间结束。格式:yyyy-MM-dd |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"oflow_no":"SR20200918000009",
"cm_id":5950706195173244407,
"rebate_account_id":7097038094955291930,
"rebate_amount_in":0.30,
"rebate_type":999,
"rebate_type_name":"外部接口写入",
"remark":"",
"iflow_no":"SR20200918000019",
"create_time":"2020-09-18 13:34:18",
"creator_id":998
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
oflow_no | VARCHAR(32) | 减少流水号 |
cm_id | VARCHAR(32) | 客户id |
cm_code | VARCHER(32) | 客户编码 |
rebate_account_id | VARCHAR(32) | 账户id |
rebate_account_code | VARCHAR(32) | 账户编码 |
rebate_amount_in | NUMERIC(20,2) | 扣减金额 |
rebate_type | VARCHAR(32) | 扣减类型id |
rebate_type_name | VARCHAR(100) | 扣减类型名称 |
remark | VARCHAR(32) | 备注 |
iflow_no | VARCHAR(32) | 对应增加流水号 |
create_time | VARCHAR(32) | 创建时间 |
creator_id | VARCHAR(32) | 创建人 |
bill_id | VARCHAR(32) | 关联单据 |
# 扣减费用池(按增加流水)
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/v1/reduceAmountByFlow/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | INT8 | 是 | 增加流水ID |
rebate_amount_in | NUMERIC(20,2) | 是 | 扣减金额 |
remark | VARCHAR(4000) | 是 | 备注 |
响应示例:
{
"return_code":0,
"return_msg":"",
"msg_id":"X0000000001",
"response_data":null
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
response_data | VARCHAR | 响应数据 |
# 代金券扣减流水查询接口
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/giftCard/v1/reducequery/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | int8 | 否 id | |
card_no | varchar | 否 | 代金券号 |
cm_id | int8 | 否 | 客户ID |
start_create_date | TIMESTAMP | 否 | 创建时间开始。格式:yyyy-MM-dd |
end_create_date | TIMESTAMP | 否 | 创建时间结束。格式:yyyy-MM-dd |
start_modify_date | TIMESTAMP | 否 | 修改时间开始。格式:yyyy-MM-dd |
end_modify_date | TIMESTAMP | 否 | 修改时间结束。格式:yyyy-MM-dd |
page_numbe | INT | 否 | 当前页数,不传默认为1 |
page_length | INT | 否 | 每页记录条数,默认最大是1000条,可以根据业务数据的大小自行优化调整 |
响应示例:
{
"return_code": "0",
"return_msg": null,
"msg_id": null,
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"id":"",
"card_no":"",
"reduce_amount":"",
"reduce_type":"",
"remark":"",
"bill_date":"2020-09-18 13:34:18",
"bill_no":""
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
id | VARCHAR(32) | 明细id |
card_no | VARCHAR(32) | 卡号 |
reduce_amount | VARCHAR(32) | 扣减金额 |
reduce_type | NUMERIC(20,2) | 扣减类型。1:手工扣减,2:下单扣减,3:接口扣减,4:过期扣减 |
remark | VARCHAR(32) | 备注 |
bill_date | VARCHAR(32) | 扣减时间。格式:yyyy-MM-dd hh:mm:ss |
bill_no | VARCHAR(32) | 关联单号(对应发货单号) |
# 代金券新增接口
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/giftCard/v1/add/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
card_no | varchar(20) | 是 | 代金券号,长度不超过20位 |
amount | NUMERIC(20,2) | 是 | 面额,要大于0 |
cm_id | int8 | 否 | 客户id,此字段非必填,第三方可能没有此字段 |
cm_code | varchar(100) | 是 | 客户编码 |
pd_ids | varchar(1000) | 否 | 商品id,多个逗号分隔,此字段非必填,第三方可能没有此字段 |
pd_codes | varchar(1000) | 否 | 商品编码,多个逗号分隔,当商品范围是0时,此字段可为空 |
period_start | date | 否 | 使用开始日期,为空时会取系统日期 |
period_date | date | 是 | 使用截止日期。格式:yyyy-mm-dd,不能小于今天 |
remark | varchar(300) | 否 | 备注 |
pd_range | varchar(2) | 是 | 商品范围。0:全部商品,1:指定商品 |
card_type | varchar(50) | 否 | 代金券类型 |
exts | List | 代金券主数据自定义字段集合 | |
exts.ext_key | VARCHAR(32) | 代金券主数据自定义字段名称 | |
exts.ext_value | VARCHAR(32) | 代金券主数据自定义字段数值 |
响应示例:
{
"return_code": "0",
"return_msg": null,
"msg_id": null,
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"card_no": "20201027092845000048",
"id": "5676765698890926253"
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
id | VARCHAR(32) | 明细id |
card_no | VARCHAR(32) | 代金券号,长度不超过20位 |
# 代金券发放接口
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/giftCard/v1/release/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
card_no | varchar(32) | 是 | 代金券号,多个值用“,”分隔 |
modifyier_id | int8 | 是 | 发放人id |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
# 赠品池查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/addpdpool/v1/query/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page_numbe | INT | 否 | 当前页数,不传默认为1 |
page_length | INT | 否 | 每页记录条数,默认最大是1000条,可以根据业务数据的大小自行优化调整 |
pool_type | VARCHAR(32) | 否 | 赠品类型id |
start_create_date | TIMESTAMP | 否 | 创建时间开始。格式:yyyy-MM-dd |
end_create_date | TIMESTAMP | 否 | 创建时间结束。格式:yyyy-MM-dd |
start_modify_date | TIMESTAMP | 否 | 修改时间开始。格式:yyyy-MM-dd |
end_modify_date | TIMESTAMP | 否 | 修改时间结束。格式:yyyy-MM-dd |
start_period_date | TIMESTAMP | 否 | 有效期至时间开始。格式:yyyy-MM-dd |
end_period_date | TIMESTAMP | 否 | 有效期至时间结束。格式:yyyy-MM-dd |
customer_id | INT8 | 否 | 勤策客户id |
customer_code | VARCHAR(100) | 否 | 客户编码 |
sourcecode | VARCHAR(100) | 否 | sourcecode |
remark | VARCHAR(300) | 否 | 备注 |
bill_no | VARCHAR(100) | 否 | 关联单据 |
响应示例:
{
"return_code": "0",
"return_msg": null,
"msg_id": null,
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"flow_no": "RG20201125000005",
"cm_id": 5950706195173244407,
"pd_id": 7097038094955291930,
"unit_id": 7097038094955291930,
"total_num": 999,
"leave_num": 999,
"price": 0.30,
"remark": "",
"period_start": "2020-11-25",
"period_date": "2020-11-25",
"pool_type": "7781114128642380050",
"sourcecode": "",
"bill_no": "",
"create_time": "2020-09-18 13:34:18",
"modify_time": "2020-09-18 13:34:18"
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
flow_no | VARCHAR(32) | 流水号 |
cm_id | VARCHAR(32) | 客户id |
cm_code | varchar(100) | 客户编码 |
cm_name | varchar(100) | 客户名称 |
pd_id | VARCHAR(32) | 赠品id |
pd_code | varchar(100) | 赠品编码 |
pd_name | varchar(100) | 赠品名称 |
unit_id | VARCHAR(32) | 赠品单位id |
unit_name | varchar(100) | 赠品单位名称 |
total_num | NUMERIC(20,2) | 赠品总量 |
leave_num | NUMERIC(20,2) | 可用数量 |
price | NUMERIC(20,2) | 赠品单价 |
remark | VARCHAR(32) | 备注 |
period_start | VARCHAR(32) | 使用开始日期。格式:yyyy-MM-dd |
period_date | VARCHAR(32) | 使用截止日期。格式:yyyy-MM-dd |
pool_type | VARCHAR(32) | 赠品类型id |
sourcecode | VARCHAR(32) | 促销案号+客户编码+赠品编码 |
modify_time | VARCHAR(32) | 更新时间。格式:yyyy-MM-dd HH:mm:ss |
create_time | VARCHAR(32) | 创建时间。格式:yyyy-MM-dd HH:mm:ss |
# 赠品池新增
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/addpdpool/v1/add/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
flow_no | VARCHAR(32) | 否 | 流水号 |
cm_id | VARCHAR(32) | 否 | 客户id(客户id和客户编码不能同时为空) |
cm_code | VARCHAR(32) | 否 | 客户编码(客户id和客户编码不能同时为空) |
pd_id | VARCHAR(32) | 否 | 赠品id(赠品id和赠品编码不能同时为空) |
pd_code | VARCHAR(32) | 否 | 赠品编码(赠品id和赠品编码不能同时为空) |
unit_id | VARCHAR(32) | 否 | 赠品单位id,必须为商品对应单位(单位id和单位名称不能同时为空) |
unit_name | VARCHAR(32) | 否 | 赠品单位名称,必须为商品对应单位(单位id和单位名称不能同时为空) |
total_num | NUMERIC(20,2) | 是 | 赠品总量,≥0 |
leave_num | NUMERIC(20,2) | 是 | 可用数量,≥0 |
price | NUMERIC(20,2) | 否 | 赠品单价,不传则为0 |
remark | VARCHAR(32) | 否 | 备注, |
period_start | VARCHAR(32) | 否 | 使用开始日期。格式:yyyy-MM-dd,为空则填写系统日期 |
period_date | VARCHAR(32) | 否 | 使用截止日期。格式:yyyy-MM-dd,为空时存“9999-12-31” |
pool_type | VARCHAR(32) | 否 | 赠品类型code,不传则取默认类型 |
sourcecode | VARCHAR(32) | 否 | 促销案号+客户编码+赠品编码 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 赠品池扣减
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/addpdpool/v1/reduce/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
flow_no | VARCHAR(32) | 是 | 赠品池流水号 |
pd_id | VARCHAR(32) | 否 | 赠品id(赠品id和赠品编码不能同时为空) |
pd_code | VARCHAR(32) | 否 | 赠品编码(赠品id和赠品编码不能同时为空) |
unit_id | VARCHAR(32) | 否 | 赠品单位id,必须为商品对应单位(单位id和单位名称不能同时为空) |
unit_name | VARCHAR(32) | 否 | 赠品单位名称,必须为商品对应单位(单位id和单位名称不能同时为空) |
minus_num | NUMERIC(20,2) | 是 | 扣减数量,≥0 |
minus_remark | VARCHAR(100) | 否 | 扣减备注 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 赠品池更新
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/addpdpool/v1/update/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
flow_no | VARCHAR(32) | 是 | 赠品池流水号 |
pd_id | VARCHAR(32) | 是 | 赠品id |
unit_id | VARCHAR(32) | 是 | 赠品单位id,必须为商品对应单位 |
leave_num | NUMERIC(20,2) | 是 | 可用数量,≥0 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
# 赠品池扣减流水查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/addpdpool/v1/queryReduceDetailList/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page_numbe | INT | 否 | 当前页数,不传默认为1 |
page_length | INT | 否 | 每页记录条数,默认最大是1000条,可以根据业务数据的大小自行优化调整 |
pool_id | TIMESTAMP | 是 | 赠品池id |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"optName": "",
"createTime": "",
"billType": "",
"billId": "",
"reducType": "",
"reduceNum": "",
"remark": "",
"id": "",
"billNo":""
}
]
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
optName | string | 否 | 操作人 |
createTime | string | 否 | 创建时间 (YYYY-MM-DD HH24:MI) |
billType | string | 否 | 单据类型 (1.商贸版销售销售订单 2.商贸版销售退货单 3.商贸版车销单 4.分销版直营订单,5.分销版分销订单,6.分销版车铺单 7.收款单,8、返利申请单,9、促销费用核销单,10、手动核减返利,11、过期失效,12、分销发货单,13、直营发货单,14、分销车销单,15、kpi明细,16、分销返利申请单,17、累计促销申请单,18、累计促销返赠品申请单) |
billId | string | 否 | 关联单据id |
reducType | string | 否 | 扣减类型 (1、手工扣减,2、下单扣减,3、接口扣减,4、过期扣减) |
reduceNum | string | 否 | 扣减数量 |
remark | string | 否 | 备注 |
id | string | 否 | 明细id |
billNo | string | 否 | 关联单据 |
# 客户代金券查询接口
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/giftCard/v1/giftCardList/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page_numbe | INT | 否 | 当前页数,不传默认为1 |
page_length | INT | 否 | 每页记录条数,默认最大是1000条,可以根据业务数据的大小自行优化调整 |
start_create_date | TIMESTAMP | 否 | 创建时间开始。格式:yyyy-MM-dd |
end_create_date | TIMESTAMP | 否 | 创建时间结束。格式:yyyy-MM-dd |
start_modify_date | TIMESTAMP | 否 | 修改时间开始。格式:yyyy-MM-dd |
end_modify_date | TIMESTAMP | 否 | 修改时间结束。格式:yyyy-MM-dd |
start_period_date | TIMESTAMP | 否 | 有效期至时间开始。格式:yyyy-MM-dd |
end_period_date | TIMESTAMP | 否 | 有效期至时间结束。格式:yyyy-MM-dd |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"amount": 22.0,
"creator": "杜洪鑫",
"create_time": "2020-12-01 16:51",
"modify_time": "2020-12-01 16:52",
"remark": "",
"leave_amount": 0.0,
"card_id": "5004185925240396944",
"card_type_name": "默认类型",
"add_type": "手工录入",
"period_date_start": "2020-12-01",
"cm_code": "CUS000003",
"card_status": "已用完",
"pd_range": "全部商品",
"card_no": "20201201165148000029",
"cm_id": "5257998258449137162",
"cm_name": "老杜的下级经销商",
"used_amount": 22.0,
"can_applied": "Y",
"period_date_end": "2020-12-01"
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
amount | NUMERIC(20,2) | 发放金额 |
used_amount | NUMERIC(20,2) | 已用金额 |
leave_amount | NUMERIC(20,2) | 剩余金额 |
creator | VARCHAR(32) | 创建人 |
create_time | VARCHAR(32) | 创建时间。格式:yyyy-MM-dd HH:mm |
modify_time | VARCHAR(32) | 更新时间。格式:yyyy-MM-dd HH:mm |
card_id | VARCHAR(32) | 代金券id |
card_no | VARCHAR(32) | 代金券号 |
card_type_name | VARCHAR(32) | 代金券类型 |
period_date_start | VARCHAR(32) | 使用开始日期。格式:yyyy-MM-dd |
period_date_end | VARCHAR(32) | 使用截止日期。格式:yyyy-MM-dd |
cm_code | VARCHAR(32) | 客户编码 |
cm_id | VARCHAR(32) | 客户id |
cm_name | VARCHAR(32) | 客户名称 |
can_applied | VARCHAR(32) | 是否允许核销。Y:可以,N:不可以 |
card_status | VARCHAR(32) | 状态:待发放/已发放/使用中/已完成 |
pd_range | VARCHAR(32) | 商品范围:全部商品/指定商品 |
add_type | VARCHAR(32) | 增加类型:手工录入/接口写入 |
remark | VARCHAR(32) | 备注 |
exts | List | 代金券主数据自定义字段集合 |
exts.ext_key | VARCHAR(32) | 代金券主数据自定义字段名称 |
exts.ext_value | VARCHAR(32) | 代金券主数据自定义字段数值 |
# 费用池余额查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/v1/queryCusAccAmountByMap/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
customer_id | INT8 | 否 | 客户id |
customer_code | VARCHER(100) | 否 | 客户编码 |
rebate_account_id | INT8 | 否 | 账户id |
rebate_account_code | VARCHER(4000) | 否 | 账户编码 |
page_number | INT | 否 | 页码默认1,每页最大1000条 |
page_length | INT | 否 | 每页条数默认1000,最大1000 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"customer_id": "6610148781668472690",
"customer_code": "CUS000075",
"rebate_account_id":"6780901665009209419",
"rebate_account_code":"Z0002",
"rebate_amount": 2200.00
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
customer_id | VARCHER(32) | 客户id |
customer_code | VARCHER(32) | 客户编码 |
rebate_account_id | VARCHER(32) | 账户id |
rebate_account_code | VARCHER(32) | 账户编码 |
rebate_amount | NUMERIC(20,2) | 账户余额 |
# 扣减费用池(按客户+账户)
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/rebate/v1/reduceAmountByCusAccount/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
cm_id | INT8 | 是 | 客户id。客户id和客户编码必须传一个 |
cm_code | VARCHAR(32) | 是 | 客户编码。客户id和客户编码必须传一个 |
rebate_account_id | INT8 | 是 | 账户id。账户id和账户编码必须传一个 |
rebate_account_code | VARCHAR(32) | 是 | 账户编码。账户id和账户编码必须传一个 |
rebate_amount_in | NUMERIC(20,2) | 是 | 扣减金额 |
reduce_type | VARCHAR(32) | 否 | 扣减类型“手工扣减” |
remark | VARCHAR(4000) | 是 | 备注 |
响应示例:
{
"return_code": 0,
"return_msg": ""
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | String | 响应说明 |