创建卡券接口

开发者通过创建卡券接口，将小程序内发放的卡券按照百度卡券模板要求完成导入，以获取卡券 ID 。

开发步骤

明确卡券 ID 与 Code 码的区别

创建卡券成功后获取百度分配的卡券 ID ，一个卡券 ID 代表一类卡券，包含相应库存数量的 Code 码。

例如：
创建 100 元代金券，获取一个卡券 ID（couponId）用于投放，并需开发者上传对应业务的 Code 码，根据上传 Code 码的数量，百度设置库存 100 万。
用户 A ，领取到商户投放的 50 元代金券时，券面上会有一个唯一的标识码，即 Code 码。每个用户的 Code 码都不相同，所以卡券发放时，百度将会派发 100 万个不同的 Code 码给用户。

卡券详情页字段说明

卡券包-我的优惠券字段说明

步骤一：选取卡券背景色

目前百度提供包括以上 16 种色值供开发者使用，选择适用的背景色，将背景色名称（如 B010）填入 color 字段。

步骤二：选择卡券类型并创建卡券

百度提供以下 3 种卡券类型，1-代金券，2-折扣券，3-通用优惠券。

开发者须知：

1. 一个小程序内全部卡券的 callbackUrl 需为同一个；

2. description 字段传入文本格式支持富文本标签，如使用<br>换行；

3. 卡券管理当前不提供更新卡券接口，如有更新需求，需重新创建卡券。

HTTP 请求方式

POST/application-json https://openapi.baidu.com/rest/2.0/smartapp/v1.0/coupon/create?access_token=ACCESS_TOKEN

请求参数

POST 数据示例

{
    "couponType": "DISCOUNT",
    "discount": 30,
    "leastCost": 100,
    "reduceCost": 10,
    "baseInfo": {
        "title": "卡券标题",
        "color": "B080",
        "getLimit": 3,
        // 当codeType=2时，开发者无需上传Code，quantity要求必传非0且生效，默认使用平台分配的系统code码
        "codeType": 2,
        // 卡券库存100万
        "quantity": 1000000,
        "dateInfo": {
            "getStartTimestamp": 1574952776,
            "getEndTimestamp": 1577544776,
            "type": 1,
            "beginTimestamp": 1574952776,
            "endTimestamp": 1577544776,
            "timeUnit": 1,
            "timeValue": 22
        },
       "appRedirectPath": "/pages/index/index"
    },
    "description": "使用描述",
    "callbackUrl": "卡券事件回调地址"
}

返回示例

{
    "errno": 0,
    "msg": "success",
    "data": {
        "couponId": "xxxx"
    }
}

1- 代金券

代码示例

{
    "couponType": "CASH",
    "leastCost": 100,
    "reduceCost": 50,
    "baseInfo": {
        ················        
    },
    "description": "使用描述",
    "callbackUrl": "卡券事件回调地址"
}

2- 折扣券

代码示例

{
    "couponType": "DISCOUNT",
    "discount": 80,
    "baseInfo": {
        ················        
    },
    "description": "使用描述",
    "callbackUrl": "卡券事件回调地址"
}

3- 通用优惠券

代码示例

{
    "couponType": "GENERAL",
    "baseInfo": {
        ················        
    },
    "description": "使用描述",
    "callbackUrl": "卡券事件回调地址"
}

卡券基础信息字段（重要）

步骤三：上传 Code 码（可选）

HTTP 请求方式

POST/form https://openapi.baidu.com/rest/2.0/smartapp/v1.0/coupon/code/batchUpload?access_token=ACCESS_TOKEN

请求参数

返回示例

{
    "errno": 0,
    "msg": "success",
    "data": {
        "successNum": 5,
        // 重复导入的code会忽略
        "failNum": 2  
     }
}

步骤四：上传卡券 Banner 图（可选）

上传图片接口
为了保证开发者的卡券在用户的能快速、稳定地加载出图片素材，我们强烈建议开发者将卡券素材先调用接口导入百度服务器。
开发者需调用该接口上传商户图标至百度服务器，获取相应 picUrl（卡券 Banner 图片）。请求参数为file，上传图片后，获取返回 url。

开发者须知

1. 图片尺寸：1032 * 144px 。
2. 当前一个卡券 ID 仅支持创建一个 Banner 。

HTTP 请求方式

POST/form-data https://openapi.baidu.com/file/2.0/smartapp/v1.0/coupon/upload/image?access_token=ACCESS_TOKEN

返回示例

{
    "errno": 0,
    "msg": "success",
    "data": {
        "url": "https://b.bdstatic.com/searchbox/mappconsole/image/20191128/8d382c36-2b85-4f2c-b6d1-0d6afbc04dc8.png"
    }
}

Banner 创建

HTTP 请求方式

POST/application-json https://openapi.baidu.com/rest/2.0/smartapp/v1.0/coupon/banner/add?access_token=ACCESS_TOKEN

请求参数

POST 数据示例

{
    "couponId": "xxx",
    "picUrl": "/index/index",
    "title": "卡券标题",
    "appRedirectPath": "跳转的小程序页面路径"
}

参数说明

返回示例

{
    "errno": 0,
    "msg": "success",
    "data": {
        "bannerId": 23830865
    }
}

Banner 修改

HTTP 请求方式

POST/application-json https://openapi.baidu.com/rest/2.0/smartapp/v1.0/coupon/banner/update?access_token=ACCESS_TOKEN

请求参数

POST 数据示例

{
    "bannerId": "bannerId",
    "couponId": "xxx",
    "picUrl": "www.baidu.com",
    "title": "标题",
    "appRedirectPath": "跳转小程序页面路径"
}

参数说明

返回示例

{
    "errno": 0,
    "msg": "success",
    "data": true
}

返回参数说明

Banner 删除

HTTP 请求方式

POST/form https://openapi.baidu.com/rest/2.0/smartapp/v1.0/coupon/banner/delete?access_token=ACCESS_TOKEN

请求参数

返回示例

{
    "errno": 0,
    "msg": "success",
    "data": true
}

返回参数说明

Banner 详情查询

HTTP 请求方式

GET https://openapi.baidu.com/rest/2.0/smartapp/v1.0/coupon/banner/get?access_token=ACCESS_TOKEN

请求参数

返回示例

{
    "errno": 0,
    "msg": "success",
    "data": [
        {
            "bannerId": 23830865,
            "couponId": "23830866",
            "title": "titletest",
            "picUrl": "picUrlTest",
            "appRedirectPath": "destUrlTest",
            "createTime": 1574396789,
            "updateTime": 1574396788
        }
    ]
}

Banner 列表批量查询

HTTP 请求方式

GET https://openapi.baidu.com/rest/2.0/smartapp/v1.0/coupon/banner/batchGet?access_token=ACCESS_TOKEN

请求参数

返回示例

{
    "errno": 0,
    "msg": "success",
    "data": {
        // 页码
        "pageNo": 1,
        // 总数量
        "total": 1,
        "dataList": [
            {
                "bannerId": 23830865,
                "couponId": "23830866",
                "title": "titletest",
                "picUrl": "picUrlTest",
                "appRedirectPath": "destUrlTest",
                "createTime": 1574396789,
                "updateTime": 1574396788
            }
        ]
    }
}