API开放平台

TIP

# 优惠券推送接口

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
    "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 NUMERIC(20,8) 否 使用门槛金额
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) 否 商品类型名称

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}

响应信息

参数 说明
return_code 响应编码
return_msg 响应消息内容
msg_id 消息ID

# 优惠券领取推送接口

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
			"cus_id": "8078723553496786531",
			"source_code": "8723553496078786531",
			"cus_code": "CUS000002",
			"cus_name": "老杜的直营经销商",
			"voucher_id": "7227961519455977662",
			"voucher_name": "CNY促销券",
			"start_date": "2021-01-26",
			"end_date": "2021-02-24",
			"receive_time": "2021-02-22 13:51:27",
			"doorsill_type": "Y",
			"doorsill_amount": "100.00",
			"money": "10.00",
			"business_from_name": "蒙牛"
}

参数说明：

参数 类型 必填 说明
cus_id VARCHAR(8) 是 客户ID
source_code VARCHAR(32) 否 第三方客户id
cus_code VARCHAR(32) 是 客户编码
cus_name VARCHAR(100) 是 客户名称
voucher_id VARCHAR(8) 是 优惠券号
voucher_name VARCHAR(100) 是 优惠券名称
start_date DATE 否 有效起始日期（yyyy-dd-mm）
end_date DATE 否 有效截止日期（yyyy-dd-mm）
receive_time TIMESTAMP 是 领取时间（yyyy-dd-mm hh:mm:ss)
doorsill_type VARCHAR(32) 是 使用门槛方式(N:不限制，Y：有限制)
doorsill_amount VARCHAR(20) 否 使用门槛金额(当使用门槛为Y时才有值)
money VARCHAR(32) 是 面值
business_from_name VARCHAR(100) 是 业务来源名称
source_from VARCHAR(32) 是 创建方式（ZZ：自增加，XF：互联下发，OPENAPI:外部系统）
discounts_type VARCHAR(32) 是 优惠方式，GDMZ：固定面值，ZKBL：折扣比例
discounts_percent VARCHAR(32) 是 折扣比列
max_discounts_amount VARCHAR(32) 否 最大优惠金额

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}

响应信息

参数 说明
return_code 响应编码
return_msg 响应消息内容
msg_id 消息ID

# 优惠券使用推送接口

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
			"cus_id": "8078723553496786531",
			"source_code": "8078534967867235531",
			"cus_code": "CUS000002",
			"cus_name": "老杜的直营经销商",
			"voucher_id": "7227961519455977662",
			"voucher_name": "CNY促销券",
			"start_date": "2021-01-26",
			"end_date": "2021-02-24",
			"receive_time": "2021-02-22 13:51:27",
			"doorsill_type": "Y",
			"doorsill_amount": "100.00",
			"money": "10.00",
			"business_from_name": "蒙牛",
    		"order_no":"DD20211210000014"
}

参数说明：

参数 类型 必填 说明
cus_id VARCHAR(8) 是 客户ID
source_code VARCHAR(32) 否 第三方客户id
cus_code VARCHAR(32) 是 客户编码
cus_name VARCHAR(100) 是 客户名称
voucher_id VARCHAR(8) 是 优惠券号
voucher_name VARCHAR(100) 是 优惠券名称
start_date DATE 否 有效起始日期（yyyy-dd-mm）
end_date DATE 否 有效截止日期（yyyy-dd-mm）
receive_time TIMESTAMP 是 使用时间（yyyy-dd-mm hh24:mi:ss)
doorsill_type VARCHAR(32) 是 使用门槛方式(N:不限制，Y：有限制)
doorsill_amount VARCHAR(20) 否 使用门槛金额(当使用门槛为Y时才有值)
money VARCHAR(32) 是 面值
business_from_name VARCHAR(100) 是 业务来源名称
source_from VARCHAR(32) 是 创建方式（ZZ：自增加，XF：互联下发，OPENAPI:外部系统）
order_no VARCHAR(32) 是 订单号
discounts_type VARCHAR(32) 是 优惠方式，GDMZ：固定面值，ZKBL：折扣比例
discounts_percent VARCHAR(32) 是 折扣比列
max_discounts_amount VARCHAR(32) 否 最大优惠金额
distribute_time VARCHAR(32) 否 发放时间（yyyy-mm-dd hh24:mi:ss）
order_id VARCHAR(32) 否 订单id
order_no VARCHAR(32) 否 订单号
order_create_time VARCHAR(32) 否 下单时间（yyyy-mm-dd hh24:mi:ss）
order_amount NUMERIC(20,2) 否 订单金额
voucher_amount NUMERIC(20,2) 否 实际优惠金额

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}

响应信息

参数 说明
return_code 响应编码
return_msg 响应消息内容
msg_id 消息ID