API开放平台

TIP

# 查询兑货券明细

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/coupondetail/v1/queryCouponDetail/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "page_number": 1,
    "page_length": 1000,
    "create_start": "2016-12-09",
    "create_end": "2016-12-09",
    "cm_dept_code": "",
    "status": "1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page_number INT 否 当前页数，不传默认为1
page_length INT 否 每页条数，不传默认为1000
create_start TIMESTAMP 否 创建时间之后。格式：yyyy-MM-dd
create_end TIMESTAMP 否 创建时间之前。格式：yyyy-MM-dd
modify_start TIMESTAMP 否 修改时间之后。格式：yyyy-MM-dd
modify_end TIMESTAMP 否 修改时间之前。格式：yyyy-MM-dd
cm_dept_code VARCHAR(32) 否 客户部门编码
status VARCHAR(1) 否 0：已删除，1：正常

响应示例：

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

数据DATA示例:

[
    {
        "id": "6692513571119135748",
        "status": "1",
        "coupon_no": "00015684", 
        "create_time": "2019-12-05 13:25",
        "modify_time": "2019-12-05 14:25:35.143",
        "effect_date": "2019-11-05~2019-12-25",
        "format_status": "执行中",
        "doorsill_value": "20.00%",
        "recycle_sign_time": "10天",
        "deal_name": "测试协议名称",
        "deal_id": "6692513571119135748",
        "cm_id": "5012103144063463929", 
        "cm_name": "南京雨花二级经销商", 
        "cm_code": "0008106267", 
        "prod_id": "6692513571119135747", 
        "prod_code": "1HBSKLSD", 
        "prod_name": "测试商品1",
        "num": "10箱",
        "price": "25.00",
        "is_used": "已使用",
        "used_time": "2019-12-15 13:25",
        "order_no": "CK0076",
        "order_id": "6692513571119135747",
        "supply_code": "00123", 
        "supply_name": "1ed", 
        "is_back": "已回收", 
        "sign_num": "1箱",
        "sign_time": "2019-12-17 13:25" 
    }
]

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 否 兑货券明细id
status VARCHAR(1) 否 0：已删除，1：正常
coupon_no VARCHAR(32) 否 兑货券编码
create_time VARCHAR(32) 否 兑货券生成时间。格式：yyyy-MM-dd HH:mm
modify_time VARCHAR(32) 否 兑货券更新时间。格式：yyyy-MM-dd HH:mm:ss.us
effect_date VARCHAR(32) 否 兑货券有效期。格式：yyyy-mm-dd ~ yyyy-mm-dd
format_status VARCHAR(32) 否 兑货券状态，参考值：“待审批”、“被打回”、“未开始”、“执行中”、“已结束”
doorsill_value VARCHAR(32) 否 兑货券使用门槛，“不限制”或具体百分比数据
recycle_sign_time VARCHAR(32) 否 兑货券通路回收时间，“不限制”或具体天数
deal_name VARCHAR(32) 否 兑货券协议名称
deal_id VARCHAR(32) 否 兑货券协议id
cm_code VARCHAR(100) 否 兑货券客户编码
cm_name VARCHAR(100) 否 兑货券客户名称
cm_id VARCHAR(32) 否 兑货券客户ID
prod_id VARCHAR(32) 否 商品ID
prod_code VARCHAR(100) 否 商品编码
prod_name VARCHAR(100) 否 商品名称
num VARCHAR(32) 否 商品数量
price VARCHAR(32) 否 商品单价
is_used VARCHAR(32) 否 兑货券使用状态，参考值：“未使用”、“已使用”、“已回收”
used_time VARCHAR(32) 否 兑货券使用时间。格式：yyyy-MM-dd HH:mm
order_no VARCHAR(32) 否 订单编码
order_id VARCHAR(32) 否 订单id
supply_code VARCHAR(32) 否 供应商编码
supply_name VARCHAR(32) 否 供应商名称
is_back VARCHAR(32) 否 兑货券回收状态，参考值：“已回收”、“未回收”
sign_num VARCHAR(32) 否 回收数量
sign_time VARCHAR(32) 否 回收时间
exts List 列表
exts.ext_key VARCHAR(32) 是 兑货券主数据自定义字段名称
exts.ext_value VARCHAR(32) 是 兑货券主数据自定义字段数值

# 新增兑货券

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/coupondetail/v1/addCoupon/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "coupon_no": "DH20200507000001",
    "deal_name": "2020-05-07-001",
    "cm_id": "6389893435290873348",
    "cm_code": "CM0001",
    "start_date": "2020-01-01",
    "end_date": "2020-12-01",
    "promotion_name": "",
    "recycle_date": "2020-12-01",
    "doorsill_percent": "80",
    "prods": [
        {
            "product_id": "7755038711664976249",
            "product_code": "PD001",
            "unit_name": "箱",
            "num": "10.00000000"
        }
    ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
coupon_no VARCHAR(100) 否 兑货券编码。如果传兑货券编码，则按传入的编码；如果不传，则按照365的兑货券生成规则自动生成
deal_name VARCHAR(100) 是 兑货券协议名称
cm_id VARCHAR(32) 是 兑货券客户id，客户id和客户编码必须传一个
cm_code VARCHAR(100) 是 兑货券客户编码，客户id和客户编码必须传一个
start_date VARCHAR(32) 是 兑货券有效期开始时间。格式：yyyy-mm-dd
end_date VARCHAR(32) 是 兑货券有效期结束时间。格式：yyyy-mm-dd
promotion_name VARCHAR(100) 否 关联促销方案
recycle_date VARCHAR(32) 否 通路回收时间（兑换后天数）
doorsill_percent VARCHAR(32) 否 兑货券使用门槛。百分比值，如80%，则传80；如果为空，则为不限制
exts List 列表
exts.ext_key VARCHAR(32) 是 兑货券主数据自定义字段名称
exts.ext_value VARCHAR(32) 是 兑货券主数据自定义字段数值
prods List 列表
prods.product_id VARCHAR(32) 是 商品id。商品id和商品编码不能同时为空
prods.product_code VARCHAR(100) 是 商品编码，商品id和商品编码不能同时为空
prods.unit_name VARCHAR(32) 是 商品单位
prods.num NUMERIC(18,8) 是 兑换数量

响应示例：

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

数据DATA示例:

[
    {
        "id": "8183666817447601554",
        "code": "DH20200507000001"
    }
]

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 是 兑货券id
code VARCHAR(100) 否 兑货券编码

# 兑货券自定义字段更新

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/coupondetail/v1/updateCouponExt/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
coupon_no VARCHAR(100) 是 兑货券码
exts List 列表
exts.ext_key VARCHAR(32) 是 兑货券主数据自定义字段名称
exts.ext_value VARCHAR(32) 是 兑货券主数据自定义字段数值

响应示例：

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

参数说明：

参数 类型 必填 说明
msg_id VARCHAR(32) 是 消息ID
return_code VARCHAR(32) 是 响应编码。0：成功，1：失败
return_msg VARCHAR(100) 否 响应说明

# 审批兑货券

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/coupondetail/v1/approvalCoupon/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "coupon_no": "DH20200507000001",
    "coupon_status": "1",
    "confirm_emp": "张三"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
coupon_no VARCHAR(100) 是 兑货券编码
coupon_status VARCHAR(32) 是 审批意见。1：通过，2：打回
confirm_emp VARCHAR(100) 是 审批人

响应示例：

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

参数说明：

参数 类型 必填 说明
msg_id VARCHAR(32) 是 消息ID
return_code VARCHAR(32) 是 响应编码。0：成功，1：失败
return_msg VARCHAR(100) 否 响应说明

← 兑货券推送 →