# 优惠券查询接口

注:当tradeRange为2时,可以通过优惠券查询客户信息接口根据优惠券id(voucher_id)查询具体的客户信息

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/voucher/v1/getVoucherInfos/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "page_number":1,
    "page_length":1000,
    "start_create_date":"2021-04-20",
    "end_create_date":"2021-04-21",
    "start_modify_date":"2021-04-20",
    "end_modify_date":"2021-04-21"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
page_number INT 页码默认1,每页默认1000条
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

响应示例:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "cmLevels":
        [
            {
                "cmLevelName":"D"
            }
        ],
        "cmTypes":
        [
            {
                "cmTypeName":"陶瓷店"
            }
        ],
        "doorsillAmount":"222.00",
        "doorsillType":"Y",
        "eachCmNum":1,
        "endDate":"2021-05-28",
        "hasRequired":"N",
        "id":6856083179295188426,
        "money":"111.00",
        "name":"cesfdfs",
        "num":2,
        "payType":"UNLIMITED",
        "pdInfos":[
            {
                "isRequired":"",
                "code":"12428312",
                "requiredNum":"",
                "name":"徐福记鸡蛋味煎卷盒装喜铺专销系列@40x32g CN",
                "unitId":""
            }
        ],
        "prodBrands":[
            {
                "prodBrandName":"百事"
            }
        ],
        "prodTypes":[
            {
                "prodTypeName":"饮料"
            }
        ],
        "prodMode":"ALL",
        "remark":"",
        "requiredAllnum":"0.000",
        "sourceFrom":"ZZ",
        "startDate":"2021-04-15",
        "tradeRange":"2",
        "requiredType":"0",
        "isFinish":"N"
    }
]

参数说明:

参数 类型 必填 说明
cmLevels.cmLevelName VARCHAR(32) 客户级别,tradeRange为1时有值
cmTypes.cmTypeName VARCHAR(32) 客户类型,tradeRange为1时有值
doorsillAmount NUMERIC(20,8) 使用门槛金额
doorsillType VARCHAR(32) 使用门槛方式。N:不限制,Y:有限制
eachCmNum NUMERIC(5) 单客户限领数量
endDate VARCHAR(32) 有效截止日期。格式:yyyy-MM-dd
hasRequired VARCHAR(32) 是否必含。Y:是,N:否
id VARCHAR(32) 优惠券号
money VARCHAR(32) 面值
name VARCHAR(32) 优惠券名称
num NUMERIC(5) 总数量
payType VARCHAR(32) 限定支付方式。UNLIMITED:无限制,ONLINE:在线支付
pdInfos List 商品信息列表
pdInfos.isRequired VARCHAR(32) 是否必含。Y:是,N:否。在prodMode为PRODUCT时有值
pdInfos.code VARCHAR(32) 商品编码,在prodMode为PRODUCT时有值
pdInfos.requiredNum VARCHAR(32) 必含数量,在prodMode为PRODUCT时有值
pdInfos.name VARCHAR(32) 商品名称,在prodMode为PRODUCT时有值
pdInfos.unitId VARCHAR(32) 必含单位,在prodMode为PRODUCT时有值
prodBrand List 商品品牌列表
prodBrand.prodBrandName VARCHAR(32) 商品品牌,prodMode为BRAND时有值
prodTypes List 商品类型列表
prodTypes.prodTypeName VARCHAR(32) 商品类型,prodMode为TYPE时有值
prodMode VARCHAR(32) 商品范围。ALL:全部商品,TYPE:商品类型,BRAND:商品品牌,PRODUCT:指定商品
remark VARCHAR(32) 使用说明
requiredAllnum VARCHAR(32) 必含总数量
sourceFrom VARCHAR(32) 优惠券来源。ZZ:系统自建,XF:互联下发
startDate VARCHAR(32) 有效起始日期。格式:yyyy-MM-dd
tradeRange VARCHAR(32) 客户范围。1:指定客户范围,2:指定具体客户
requiredType VARCHAR(32) 必含方式。ANYONE:必含任一,ALL:必含全部。prod_mode为PRODUCT,且source_from为XF的时候该字段才会有值
isFinish VARCHAR(32) 是否终止。Y:是,N:否
discountsType VARCHAR(32) 优惠方式,GDMZ:固定面值,ZKBL:折扣比例
discountsPercent VARCHAR(32) 折扣比例
maxDiscountsAmount VARCHAR(32) 最大优惠金额

# 优惠券查询客户信息接口

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/voucher/v1/getCmInfos/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试

{
    "page_number":1,
    "page_length":1000,
    "voucher_id":"8144100181735612578"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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示例:

[
    {
        "id":"8833956197749704288",
        "code":"CUS010043",
        "name":"新增的终端"
    }
]

参数说明:

参数 类型 必填 说明
code VARCHAR(32) 客户编码
name VARCHAR(32) 客户名称
id VARCHAR(32) 客户id

# 优惠券新增接口

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/voucher/v1/addVoucherInfo/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试

{
    "name": "优惠券名称",
    "startDate": "2022-02-22",
    "endDate": "2022-02-22",
    "money": "10",
    "doorsillAmount": 100,
    "doorsillType": "Y",
    "payType": "UNLIMITED",
    "remark": "使用说明",
    "grantType": "ZDLQ",
    "eachCmNum": 1,
    "num": 10,
    "tradeRange": "1",
    "cmLevelId": null,
    "cmLevelName":"A",
    "cmTypeId": null,
    "cmTypeName":"腻子专柜店",
    "cmId": null,
    "cmCode": null,
    "prodMode": "PRODUCT",
    "prodTypeId": null,
    "prodTypeName": null,
    "prodBrandId": null,
    "prodBrandName": null,
    "prodId": null,
    "prodCode":"SP202108240007",
    "businessFromName":"业务来源1",
    "comment":"备注"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
name VARCHAR(32) 优惠券名称
startDate VARCHAR(32) 优惠券开始日期[格式:yyyy-MM-dd]
endDate VARCHAR(32) 优惠券截止日期[格式:yyyy-MM-dd]
money VARCHAR(32) 面值
doorsillAmount NUMERIC(20,8) 使用门槛金额
doorsillType VARCHAR(32) 使用门槛方式[枚举值如下:Y-是;N-否]
payType VARCHAR(32) 限定支付方式[枚举值如下:UNLIMITED;ONLINE-在线支付]
remark VARCHAR(1000) 使用说明
grantType VARCHAR(32) 发放方式[枚举值如下:ZDLQ-主动领取;HDFF-活动发放;THIRDPARTY-第三方领取]
eachCmNum NUMERIC(5) 单客户限领数量
num NUMERIC(5) 优惠券总数量
tradeRange VARCHAR(32) 客户范围[枚举值如下:1-指定客户范围;2-指定具体客户(发放方式为主动领取时取:1-指定客户范围)]
cmTypeId VARCHAR(4000) 客户类型id,多个id按逗号分隔[客户范围为指定客户范围时,客户类型id和客户类型名称两者必传其一]
cmTypeName VARCHAR(4000) 客户类型名称,多个名称按逗号分隔[客户范围为指定客户范围时,客户类型id和客户类型名称两者必传其一]
cmLevelId VARCHAR(4000) 客户等级id,多个id按逗号分隔[客户范围为指定客户范围时,客户等级id和客户等级名称两者必传其一]
cmLevelName VARCHAR(4000) 客户等级名称,多个名称按逗号分隔[客户范围为指定客户范围时,客户等级id和客户等级名称两者必传其一]
cmId VARCHAR(4000) 客户id,多个id按逗号分隔[客户范围为指定具体客户时,客户id和客户编码两者必传其一]
cmCode VARCHAR(4000) 客户编码,多个编码按逗号分隔[客户范围为指定具体客户时,客户id和客户编码两者必传其一]
prodMode VARCHAR(32) 商品范围[枚举值如下:ALL-全部商品;TYPE-商品类型;BRAND-商品品牌;PRODUCT-指定商品]
prodTypeId VARCHAR(4000) 商品类型id,多个id按逗号分隔[商品范围为商品类型时,商品类型id和商品类型名称两者必传其一]
prodTypeIdName VARCHAR(4000) 商品类型名称,多个名称按逗号分隔[商品范围为商品类型时,商品类型id和商品类型名称两者必传其一]
prodBrandId VARCHAR(4000) 商品品牌id,多个id按逗号分隔[商品范围为商品品牌时,商品品牌id和商品品牌名称两者必传其一]
prodBrandName VARCHAR(4000) 商品品牌名称,多个名称按逗号分隔[商品范围为商品品牌时,商品品牌id和商品品牌名称两者必传其一]
prodId VARCHAR(4000) 商品id,多个id按逗号分隔[商品范围为指定商品时,商品id和商品编码两者必传其一]
prodCode VARCHAR(4000) 商品编码,多个编码按逗号分隔[商品范围为指定商品时,商品id和商品编码两者必传其一]
businessFromName VARCHAR(32) 业务来源名称
comment VARCHAR(1000) 备注
autoReceive VARCHAR(32) 是否自动领取优惠券,Y:是,N:否
discountsType VARCHAR(32) 优惠方式,GDMZ:固定面值,ZKBL:折扣比例
discountsPercent VARCHAR(32) 折扣比例,优惠方式为ZKBL的时候必填
maxDiscountsAmount VARCHAR(32) 最大优惠金额,优惠方式为ZKBL的时候有效

响应示例:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

{
   "voucherId": "6812072753231956829"
}

参数说明:

参数 类型 必填 说明
voucherId VARCHAR(32) 优惠券id

# 优惠券终止接口

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/voucher/v1/finishVoucher/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试

{
    "voucherId": "优惠券号"
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
voucherId VARCHAR(32) 优惠券号

响应示例:

{
  "return_code": "0",
  "return_msg": null,
  "msg_id": "X000001",
  "response_data": null
}

参数说明:

参数 类型 说明
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 优惠券截止日期变更

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/voucher/v1/modifyVoucherEndDate/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试

{
    "voucherId": "优惠券号",
    "endDate": "2022-09-20" 
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
voucherId VARCHAR(32) 优惠券号

响应示例:

{
  "return_code": "0",
  "return_msg": null,
  "msg_id": "X000001",
  "response_data": null
}

参数说明:

参数 类型 说明
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

# 企业头条浏览时长查询接口

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/notice/v1/queryMendianNotice/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试

请求示例:

{
    "create_start_time": "2021-01-01 00:00:00",
    "create_end_time": "2022-01-20 00:00:00",
    "page_number":1,
    "page_size":1000
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
create_start_time VARCHAR(32) 企业头条创建开始时间
create_end_time VARCHAR(32) 企业头条创建结束时间
page_number INT 页码默认1,每页默认1000条
page_size INT 每页记录条数,默认最大是1000条,可以根据业务数据的大小自行优化调整

响应示例:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "notice_id":9074661587937863089,
        "store_id":6851186861578848677,
        "read_start_time":"2022-01-19 19:16",
        "read_total_time": "206"
    }
]

参数说明:

参数 类型 必填 说明
notice_id VARCHAR(32) 头条id
store_id VARCHAR(32) 客户id
read_start_time VARCHAR(32) 阅读时间
read_total_time VARCHAR(32) 阅读时长

# 领取优惠券接口

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/voucher/v1/receiveVoucherInfo/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试

{
    "voucherId": "优惠券号",
    "cmId": "客户id",
    "cmCode": "客户编码",
    "cmSourceCode": "客户SourceCode"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
voucherName VARCHAR(32) 优惠券名称
voucherId VARCHAR(32) 优惠券号
cmId VARCHAR(32) 客户id
cmCode VARCHAR(32) 客户编码
cmSourceCode VARCHAR(32) 客户SourceCode
receiveTime VARCHAR(32) 领取时间。格式:yyyy-MM-dd HH:mm:ss

响应示例:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}