API开放平台

TIP

# 优惠券查询接口

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

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

参数说明：

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

# 优惠券新增接口

请求方式： 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 TEXT 否 客户类型id，多个id按逗号分隔[客户范围为指定客户范围时，客户类型id和客户类型名称如果同时存在，优先级依次递减]
cmTypeName TEXT 否 客户类型名称，多个名称按逗号分隔[客户范围为指定客户范围时，客户类型id和客户类型名称如果同时存在，优先级依次递减]
cmLevelId TEXT 否 客户等级id，多个id按逗号分隔[客户范围为指定客户范围时，客户等级id和客户等级名称如果同时存在，优先级依次递减]
cmLevelName TEXT 否 客户等级名称，多个名称按逗号分隔[客户范围为指定客户范围时，客户等级id和客户等级名称如果同时存在，优先级依次递减]
cmDeptId TEXT 否 客户部门id，多个id按逗号分隔[客户范围为指定客户范围时，客户部门id和客户部门名称如果同时存在，优先级依次递减]
cmDeptName TEXT 否 客户部门名称，多个名称按逗号分隔[客户范围为指定客户范围时，客户部门id和客户部门名称如果同时存在，优先级依次递减]
cmLabelId TEXT 否 客户标签id，多个id按逗号分隔[客户范围为指定客户范围时，客户标签id和客户标签名称如果同时存在，优先级依次递减]
cmLabelName TEXT 否 客户标签名称，多个名称按逗号分隔[客户范围为指定客户范围时，客户标签id和客户标签名称如果同时存在，优先级依次递减]
cmDistrictId TEXT 否 客户销售区域id，多个id按逗号分隔[客户范围为指定客户范围时，客户销售区域id和客户销售区域名称如果同时存在，优先级依次递减]
cmDistrictName TEXT 否 客户销售区域名称，多个名称按逗号分隔[客户范围为指定客户范围时，客户销售区域id和客户销售区域名称如果同时存在，优先级依次递减]
cmId TEXT 否 客户id，多个id按逗号分隔[客户范围为指定具体客户时，客户id和客户编码两者必传其一，如果同时存在，优先级依次递减]
cmCode TEXT 否 客户编码，多个编码按逗号分隔[客户范围为指定具体客户时，客户id和客户编码两者必传其一，如果同时存在，优先级依次递减]
prodMode VARCHAR(32) 是 商品范围[枚举值如下:ALL-全部商品;TYPE-商品类型;BRAND-商品品牌;PRODUCT-指定商品]
prodTypeId TEXT 否 商品类型id，多个id按逗号分隔[商品范围为商品类型时，商品类型id和商品类型名称两者必传其一，如果同时存在，优先级依次递减]
prodTypeName TEXT 否 商品类型名称，多个名称按逗号分隔[商品范围为商品类型时，商品类型id和商品类型名称两者必传其一，如果同时存在，优先级依次递减]
prodBrandId TEXT 否 商品品牌id，多个id按逗号分隔[商品范围为商品品牌时，商品品牌id和商品品牌名称两者必传其一，如果同时存在，优先级依次递减]
prodBrandName TEXT 否 商品品牌名称，多个名称按逗号分隔[商品范围为商品品牌时，商品品牌id和商品品牌名称两者必传其一，如果同时存在，优先级依次递减]
prodId TEXT 否 商品id，多个id按逗号分隔[商品范围为指定商品时，商品id和商品编码两者必传其一，如果同时存在，优先级依次递减]
prodCode TEXT 否 商品编码，多个编码按逗号分隔[商品范围为指定商品时，商品id和商品编码两者必传其一，如果同时存在，优先级依次递减]
businessFromName VARCHAR(32) 否 业务来源名称
comment VARCHAR(1000) 否 备注
autoReceive VARCHAR(32) 否 是否自动领取优惠券，Y：是，N：否
discountsType VARCHAR(32) 是 优惠方式，GDMZ：固定面值，ZKBL：折扣比例
discountsPercent VARCHAR(32) 是 折扣比例，优惠方式为ZKBL的时候必填。范围0~1,小数位最多4位
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/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>>"
}

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

请求方式： 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/queryVoucherUsedInfo/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "voucherId":708742168422351694,
    "voucherStatus":"0"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
voucherId VARCHAR(32) 是 优惠券号
voucherStatus VARCHAR(32) 否 优惠券使用状态，0未使用，1已使用，2已过期

响应示例：

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

数据DATA示例:

[
    {
        "end_date":"2022-10-31",
        "order_no":"DD20221020000017",
        "voucher_name":"10元优惠券",
        "discounts_type":"GDMZ",
        "receive_time":"2022-10-20 13:25",
        "create_type":"ZZ",
        "cm_code":"CUS010103",
        "distribute_time":"2022-10-20 13:25",
        "order_create_time":"2022-10-20 13:27:20",
        "money":"10.00",
        "business_from_name":"",
        "cm_id":"9139133117350330302",
        "cm_name":"fx0906",
        "max_discounts_amount":"",
        "order_amount":"100",
        "voucher_id":"7087421684223516948",
        "id":"4748332116608163964",
        "cm_source_code":"",
        "voucher_amount":"10.00",
        "doorsill_amount":"20.00",
        "order_id":"4748332116608163964",
        "discounts_percent":"",
        "start_date":"2022-10-20"
    }
]

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 是 优惠券详情id
cm_id VARCHAR(32) 是 客户id
cm_source_code VARCHAR(32) 是 客户sourceCode
cm_code VARCHAR(32) 是 客户编码
cm_name VARCHAR(32) 是 客户名称
voucher_id VARCHAR(32) 是 优惠券号
voucher_name VARCHAR(100) 是 优惠券名称
start_date VARCHAR(100) 是 使用开始时间。格式：yyyy-dd-mm
end_date VARCHAR(100) 是 使用结束时间。格式：yyyy-dd-mm
doorsill_amount VARCHAR(32) 是 使用门槛
money VARCHAR(32) 否 面值
discounts_type VARCHAR(32) 否 优惠方式。GDMZ：固定面值，ZKBL：折扣比例
discounts_percent VARCHAR(32) 否 折扣比例。0-100的两位数字
max_discounts_amount VARCHAR(32) 否 最大优惠金额
business_from_name VARCHAR(100) 否 业务来源
create_type VARCHAR(32) 否 创建方式。ZZ：自增加，XF：互联下发，OPENAPI:外部系统
distribute_time VARCHAR(32) 否 发放时间。格式：yyyy-mm-dd hh24:mi:ss
receive_time VARCHAR(32) 否 领用时间。格式：yyyy-mm-dd hh24:mi:ss
order_id VARCHAR(32) 否 订单id
order_no VARCHAR(100) 否 订单号
order_create_time VARCHAR(32) 否 下单时间。格式：yyyy-mm-dd hh24:mi:ss
order_amount VARCHAR(32) 否 订单金额
voucher_amount VARCHAR(32) 否 实际优惠金额
use_status VARCHAR(32) 否 优惠券使用状态：0未使用 1已使用 2已过期

← 首页广告接口 →