# 优惠券查询接口

注:当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"
    }
]

参数说明:

参数 类型 必填 说明
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的时候该字段才会有值

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

请求方式: 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