# 查询互联优惠券
请求方式: POST(HTTPS)
请求地址: https://openapi.qince.com/api/stdMendianVoucher/v1/queryVoucherMl/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page_number | int | 是 | 页码默认1,每页默认1000条 |
page_length | int | 否 | 每页记录条数,默认最大是1000条,可以根据业务数据的大小自行优化调整 |
creatTime | VARCHAR(100) | 否 | 创建时间范围:yyyy-mm-dd~yyyy-mm-dd |
modifyTime | VARCHAR(100) | 否 | 更新时间范围:yyyy-mm-dd~yyyy-mm-dd |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"id": "6156894207424834980",
"cm_level": "7287736961434231483",
"cm_type": "6336719646058063235",
"dept_name": "ddms",
"doorsill_amount": "20.00",
"each_cm_num": "1",
"is_issue": "N",
"money": "10.00",
"name": "2",
"pay_type": "UNLIMITED",
"prod_mode": "PRODUCT",
"remark": "备注",
"required_allnum": "0",
"total_num": "1",
"trade_range": "1",
"use_date": "2021-04-21 00:00:00~2021-04-30 23:59:59",
"voucher_no": "6156894207424834980",
"prod_type":"6622726814584160731",
"prod_brand":"1",
"required_type":"ANYONE",
"is_finish":"N",
"jxsinfos": [
{
"jxs_cus_id": "5257998258449137162",
"jxs_cus_name": "老杜的下级经销商"
}
],
"proinfos": [
{
"brand": "三只松鼠",
"class_name": "薯片类型",
"is_required": "Y",
"pro_code": "spjg004",
"pro_id": "5257998258449137162",
"pro_name": "三只松鼠腰果坚果450g",
"required_num": "0",
"unit_name": "包"
}
],
"cmTypeinfos":[
{
"cm_type_id":"5257998258449137162",
"cm_type_name":"KA"
}
],
"cmLevelinfos":[
{
"cm_level_id":"5257998258449137162",
"cm_level_name":"KA"
}
],
"prodTypeinfos":[
{
"prod_type_id":"5257998258449137162",
"prod_brand_name":"KA"
}
],
"prodBrandinfos":[
{
"prod_brand_id":"5257998258449137162",
"prod_brand_name":"KA"
}
]
}
]
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
id | VARCHAR(32) | 是 | 互联优惠券ID |
cm_level | VARCHAR(4000) | 否 | 客户级别 |
cm_type | VARCHAR(4000) | 否 | 客户类型 |
dept_name | VARCHAR(100) | 否 | 费用所属部门名称 |
doorsill_amount | VARCHAR(100) | 否 | 使用门槛金额 |
each_cm_num | VARCHAR(100) | 否 | 单店发放张数 |
is_issue | VARCHAR(100) | 否 | 是否下发。Y:已下发,N:未下发,Z:下发中 |
money | VARCHAR(100) | 否 | 面值 |
name | VARCHAR(100) | 否 | 互联优惠券名称 |
pay_type | VARCHAR(100) | 否 | 支付方式:UNLIMITED:无限制,ONLINE:在线支付 |
prod_mode | VARCHAR(100) | 否 | 商品选择方式。ALL:全部商品,PRODUCT:指定商品,PROPERTY:商品属性 |
remark | VARCHAR(100) | 否 | 使用说明 |
required_allnum | VARCHAR(100) | 否 | 必含商品总数量 |
total_num | VARCHAR(100) | 否 | 优惠券总个数 |
trade_range | VARCHAR(100) | 否 | 客户范围。1:指定客户范围,2:指定具体客户 |
use_date | VARCHAR(100) | 否 | 使用时间范围:2021-04-21 00:00:00~2021-04-30 23:59:59 |
voucher_no | VARCHAR(100) | 否 | 优惠券号 |
prod_type | VARCHAR(4000) | 否 | 商品类型:值为-1表明选择的是全部类型 |
prod_brand | VARCHAR(4000) | 否 | 商品品牌 |
required_type | VARCHAR(32) | 否 | 必含方式。ANYONE:必含任一,ALL:必含全部 |
is_finish | VARCHAR(32) | 否 | 是否终止。Y:是,N:否 |
jxsinfos | List | 列表 | |
jxsinfos.jxs_cus_id | VARCHAR(32) | 否 | 经销商id |
jxsinfos.jxs_cus_name | VARCHAR(100) | 否 | 经销商名称 |
proinfos | List | 列表 | |
proinfos.pro_id | varchar(32) | 否 | 商品id |
proinfos.brand | varchar(100) | 否 | 品牌 |
proinfos.class_name | VARCHAR(100) | 是 | 商品类型名称 |
proinfos.is_required | varchar(32) | 否 | 是否必含。Y:是,N:否 |
proinfos.pro_code | varchar(100) | 否 | 商品编码 |
proinfos.pro_name | varchar(100) | 否 | 商品名称 |
proinfos.required_num | varchar(100) | 否 | 必含数量 |
proinfos.unit_name | varchar(100) | 否 | 单位名称 |
cmTypeinfos | List | 终端类型列表 | |
cmTypeinfos.cm_type_id | varchar(32) | 否 | 终端类型id |
cmTypeinfos.cm_type_name | varchar(100) | 否 | 终端类型名称 |
cmLevelinfos | List | 终端级别列表 | |
cmLevelinfos.cm_level_id | varchar(32) | 否 | 终端级别id |
cmLevelinfos.cm_level_name | varchar(100) | 否 | 终端级别名称 |
prodTypeinfos | List | 商品类别列表 | |
prodTypeinfos.prod_type_id | varchar(32) | 否 | 商品类别id |
prodTypeinfos.prod_type_name | varchar(100) | 否 | 商品类别名称 |
prodBrandinfos | List | 商品品牌列表 | |
prodBrandinfos.prod_brand_id | varchar(32) | 否 | 商品品牌id |
prodBrandinfos.prod_brand_name | varchar(100) | 否 | 商品品牌名称 |
creator_name | varchar(32) | 是 | 创建人名称 |
create_time | varchar(32) | 是 | 创建时间。格式:yyyy-MM-dd HH:mm:ss |
modifyier_name | varchar(32) | 否 | 修改人名称 |
modify_time | varchar(32) | 否 | 修改时间。格式:yyyy-MM-dd HH:mm:ss |
finish_time | varchar(32) | 否 | 终止时间。格式:yyyy-MM-dd HH:mm:ss |
# 查询互联优惠券客户
请求方式: POST(HTTPS)
请求地址: https://openapi.qince.com/api/stdMendianVoucherCus/v1/queryVoucherCus/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page_number | int | 是 | 页码默认1,每页默认1000条 |
page_length | int | 否 | 每页记录条数,默认最大是1000条,可以根据业务数据的大小自行优化调整 |
voucher_id | VARCHAR(32) | 是 | 优惠券id |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"cus_id": "6156894207424834980",
"cus_code": "7287736961434231483",
"cus_name": "ddms"
}
]
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
cus_id | VARCHAR(32) | 是 | 客户ID |
cus_code | VARCHAR(100) | 否 | 客户编码 |
cus_name | VARCHAR(100) | 否 | 客户名称 |
# 互联优惠券新增接口
请求方式: POST(HTTPS)
请求地址: https://openapi.qince.com/api/stdMendianVoucher/v1/saveVoucher/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
outerId | VARCHAR(32) | 否 | 优惠券码。长度不大于19的正整数 |
name | VARCHAR(200) | 是 | 优惠券名称 |
startDate | VARCHAR(32) | 是 | 优惠券开始日期,不能早于当前时间。格式:yyyy-MM-dd |
endDate | VARCHAR(32) | 是 | 优惠券截止日期,不能早于开始时间。格式:yyyy-MM-dd |
money | VARCHAR(32) | 是 | 面值。最多保留两位小数的正数 |
doorsillAmount | VARCHAR(32) | 是 | 使用门槛。最多保留两位小数的正数,使用门槛必须大于面值 |
tradeRange | VARCHAR(1) | 是 | 客户范围。1、指定客户范围 2、指定具体客户 |
num | VARCHAR(32) | 是 | 单企业优惠券数量。正整数 |
eachCmNum | VARCHAR(32) | 是 | 单终端限领数量。正整数,单终端限领数量不可大于单企业优惠券数量 |
remark | VARCHAR(200) | 否 | 使用说明 |
payType | VARCHAR(10) | 是 | 限定支付方式。UNLIMITED:无限制,ONLINE:在线支付 |
comment | VARCHAR(200) | 否 | 备注 |
prodMode | VARCHAR(10) | 是 | 商品范围。ALL:全部商品,PRODUCT:指定商品,PROPERTY:商品属性 |
requiredType | VARCHAR(10) | 否 | 必含类型。当prodMode=PRODUCT时此字段有值,ANYONE:必含任一,ALL:必含全部 |
requiredAllNum | VARCHAR(10) | 否 | 必含商品总数量。requiredType=ANYONE时此字段有值,正整数 |
businessFromId | VARCHAR(32) | 否 | 业务来源ID。 |
businessFromName | VARCHAR(100) | 否 | 业务来源名称。 |
costDeptId | VARCHAR(32) | 否 | 费用归属部门ID。costDeptId、costDeptSourceCode、costDeptCode、costDeptName,不能同时为空,如果同时存在,优先级依次降低,单选值 |
costDeptSourceCode | VARCHAR(32) | 否 | 费用归属部门第三方系统的唯一标识。costDeptId、costDeptSourceCode、costDeptCode、costDeptName,不能同时为空,如果同时存在,优先级依次降低,单选值 |
costDeptCode | VARCHAR(100) | 否 | 费用归属部门编码。costDeptId、costDeptSourceCode、costDeptCode、costDeptName,不能同时为空,如果同时存在,优先级依次降低,单选值 |
costDeptName | VARCHAR(100) | 否 | 费用归属部门名称。costDeptId、costDeptSourceCode、costDeptCode、costDeptName,如果同时存在,优先级依次降低,单选值 |
dealerId | VARCHAR(32) | 否 | 经销商ID。dealerId、dealerSourceCode、dealerCode、dealerName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
dealerSourceCode | VARCHAR(32) | 否 | 经销商第三方系统的唯一标识。dealerId、dealerSourceCode、dealerCode、dealerName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
dealerCode | VARCHAR(100) | 否 | 经销商编码。dealerId、dealerSourceCode、dealerCode、dealerName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
dealerName | VARCHAR(100) | 否 | 经销商名称。dealerId、dealerSourceCode、dealerCode、dealerName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
typeId | VARCHAR(32) | 否 | 终端类型ID。当tradeRange = 1时此字段有值,typeId、typeSourceCode、typeCode、typeName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
typeSourceCode | VARCHAR(32) | 否 | 终端类型第三方系统的唯一标识。当tradeRange = 1时此字段有值,typeId、typeSourceCode、typeCode、typeName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
typeCode | VARCHAR(100) | 否 | 终端类型编码。当tradeRange = 1时此字段有值,typeId、typeSourceCode、typeCode、typeName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
typeName | VARCHAR(100) | 否 | 终端类型名称。当tradeRange = 1时此字段有值,typeId、typeSourceCode、typeCode、typeName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
levelId | VARCHAR(32) | 否 | 终端级别ID。当tradeRange = 1时此字段有值,levelId、levelSourceCode、levelName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
levelSourceCode | VARCHAR(32) | 否 | 终端级别第三方系统的唯一标识。当tradeRange = 1时此字段有值,levelId、levelSourceCode、levelName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
levelName | VARCHAR(100) | 否 | 终端级别名称。当tradeRange = 1时此字段有值,levelId、levelSourceCode、levelName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
cmId | VARCHAR(32) | 否 | 终端ID。当tradeRange = 2时此字段有值,cmId、cmSourceCode、cmCode、cmName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
cmSourceCode | VARCHAR(32) | 否 | 终端第三方系统的唯一标识。当tradeRange = 2时此字段有值,cmId、cmSourceCode、cmCode、cmName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
cmCode | VARCHAR(100) | 否 | 终端商编码。当tradeRange = 2时此字段有值,cmId、cmSourceCode、cmCode、cmName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
cmName | VARCHAR(100) | 否 | 终端名称。当tradeRange = 2时此字段有值,cmId、cmSourceCode、cmCode、cmName,不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
pdTypeId | VARCHAR(32) | 否 | 商品类型ID。当prodMode=PROPERTY时此字段有值,pdTypeId、pdTypeSourceCode、pdTypeName,商品类型与商品品牌不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔,如果传全部类型只能通过这个字段,并且值为-1 |
pdTypeSourceCode | VARCHAR(32) | 否 | 商品类型第三方系统的唯一标识。当prodMode=PROPERTY时此字段有值,pdTypeId、pdTypeSourceCode、pdTypeName,商品类型与商品品牌不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
pdTypeName | VARCHAR(100) | 否 | 商品类型名称。当prodMode=PROPERTY时此字段有值,pdTypeId、pdTypeSourceCode、pdTypeName,商品类型与商品品牌不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
pdBrandId | VARCHAR(32) | 否 | 商品品牌ID。当prodMode=PROPERTY时此字段有值,pdBrandId、pdBrandName,商品类型与商品品牌不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
pdBrandName | VARCHAR(100) | 否 | 商品品牌第三方系统的唯一标识。当prodMode=PROPERTY时此字段有值,pdBrandId、pdBrandName,商品类型与商品品牌不能同时为空,如果同时存在,优先级依次降低,多个值用“,”分隔 |
isAutoIssued | VARCHAR(1) | 是 | 是否自动下发。1 是 0否 |
products | LIST | 否 | 商品信息。当prodMode=PRODUCT时此字段有值 |
products.id | VARCHAR(32) | 否 | 商品ID。id,sourceCode,code不能同时为空 |
products.sourceCode | VARCHAR(100) | 否 | 商品第三方系统的唯一标识。id,sourceCode,code不能同时为空 |
products.code | VARCHAR(100) | 否 | 商品编码。id,sourceCode,code不能同时为空 |
products.unitId | VARCHAR(32) | 否 | 商品单位ID。unitId,unitName不能同时为空 |
products.unitName | VARCHAR(100) | 否 | 商品单位名称。unitId,unitName不能同时为空 |
products.isRequired | VARCHAR(1) | 是 | 是否必含。Y 是 N 否 |
products.requiredNum | VARCHAR(32) | 否 | 必含数量。当isRequired=Y有值,正整数 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": ""
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |