title: 卡券 header: develop nav: api

sidebar: cardticket

小程序优惠券服务接口（即将下线）

开发者须知：

因卡券接口更新，预计2020年2月29日下线该服务，请已接入的开发者移步卡券（新），并及时调整卡券服务，给您带来的不便，敬请谅解!

功能介绍

卡券助手，是百度官方为小程序提供的免费优惠券接口。接入后，可以使用该功能。

1. 获取平台投放的入口；
2. 发放的优惠券统一进入用户的百度卡券包中。

接入条件

1. 使用百度官方提供的登录能力；

   相关开发文档：

   • 登录能力：登录
   • 获取用户设备标识-swanid：swanid机制说明
   • 获取手机号能力：表单组件-button -bindgetphonenumber

2. 开发者业务有优惠券功能，具备发券-核销能力。百度智能小程序仅作为平台投放、券的统一展示、集中管理。

接入方式

开发者可通过以下API接入小程序卡券包，开发者调用百度平台接口需获取access_token。

优惠券接口

优惠券展示示例

优惠券类型，1-通用优惠券，2-代金券，3-折扣券，4-兑换券，5-团购券

创建优惠券

接口描述: 创建优惠券模板 接口地址:https://openapi.baidu.com/rest/2.0/smartapp/coupon/create 请求方式：POST 请求参数：

响应示例:

{
    "data": {
        "appId": 0,
        "bgColor": "B010",
        "couponType": 2,//优惠券类型
        "createTime": 0,
        "deleted": 0,
        "description": "代金券一张", //补充说明：卡券的优惠内容说明  
        "effectTime": 0,
        "expireTime": 0,
        "id": 0,
        "introduce": "打开京东小程序，可以在“个人中心”-“我的618券”中查看，下单时请选择“使用优惠券”，并选中该券",//使用须知：卡券使用方法的介绍
        "sill": "订单满199元可用",//使用优惠券的门槛条件 
        "takeLimit": "每个用户限领1张",//领取限制
        "title": "京东618满199减100券",
        "updateTime": 0
    },
    "errno": 0,
    "msg": ""
}

选择适用色值

目前百度智能小程序提供包括以上17种色值供开发者使用。

创建优惠券广告图（选填）

接口描述:创建优惠券广告图，当前最多可配置一张 接口地址:https://openapi.baidu.com/file/2.0/smartapp/coupon/banner/create 请求方式：POST consumes:["multipart/form-data"]

请求参数：

响应示例:

{
    "data": {
        "couponTemplateId": 0,
        "createTime": 0,
        "deleted": 0,
        "destUrl": "",
        "id": 0,
        "picUrl": "",//自定义小程序跳转地址，H5当前不支持
        "title": "京东618活动专场",// 广告图片标题
        "updateTime": 0
    },
    "errno": 0,
    "msg": ""
}

删除优惠券广告图

接口描述:删除一条优惠券广告图 接口地址:https://openapi.baidu.com/rest/2.0/smartapp/coupon/banner/delete 请求方式：POST 请求参数

响应示例:

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

优惠券广告图列表

接口描述: 获取优惠券广告图列表 接口地址:https://openapi.baidu.com/rest/2.0/smartapp/coupon/banner/list 请求方式：GET 请求参数：

响应示例:

{
    "data": {
        "dataList": [
            {
                "couponTemplateId": 0,
                "createTime": 0,
                "deleted": 0,
                "destUrl": "",
                "id": 0,
                "picUrl": "",//自定义小程序跳转地址，H5当前不支持
                "title": "京东618活动专场",// 广告图片标题
                "updateTime": 0
            }
        ],
        "pageNo": 0,
        "total": 0
    },
    "errno": 0,
    "msg": ""
}

删除优惠券

接口描述: 删除一张优惠券 接口地址:https://openapi.baidu.com/rest/2.0/smartapp/coupon/delete 请求方式：POST 请求参数：

响应示例:

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

更新优惠券

接口描述: 修改一张优惠券 接口地址:https://openapi.baidu.com/rest/2.0/smartapp/coupon/update 请求方式：POST 请求参数：

响应示例:

{
    "data": {
        "appId": 0,
        "bgColor": "#9857AE",
        "couponType": 2,//优惠券类型
        "createTime": 0,
        "deleted": 0,
        "description": "代金券一张", //补充说明：卡券的优惠内容说明  
        "effectTime": 0,
        "expireTime": 0,
        "id": 0,
        "introduce": "打开京东小程序，可以在“个人中心”-“我的618券”中查看，下单时请选择“使用优惠券”，并选中该券",//使用须知：卡券使用方法的介绍
        "sill": "订单满199元可用",//使用优惠券的门槛条件 
        "takeLimit": "每个用户限领1张",//领取限制
        "title": "京东618满199减100券",
        "updateTime": 0
    },
    "errno": 0,
    "msg": ""
}

优惠券列表

接口描述: 获取优惠券列表 接口地址:https://openapi.baidu.com/rest/2.0/smartapp/coupon/list 请求方式：GET 请求参数：

响应示例:

{
    "data": {
        "dataList": [
            {
                "appId": 0,
                 "bgColor": "#9857AE",
                "couponType": 2,//优惠券类型
                 "createTime": 0,
                "deleted": 0,
                "description": "代金券一张", //补充说明：卡券的优惠内容说明  
                  "effectTime": 0,
                "expireTime": 0,
                "id": 0,
                "introduce": "打开京东小程序，可以在“个人中心”-“我的618券”中查看，下单时请选择“使用优惠券”，并选中该券",//使用须知：卡券使用方法的介绍
                "sill": "订单满199元可用",//使用优惠券的门槛条件 
                "takeLimit": "每个用户限领1张",//领取限制
                "title": "京东618满199减100券",
                "updateTime": 0
            }
        ],
        "pageNo": 0,
        "total": 0
    },
    "errno": 0,
    "msg": ""
}

添加优惠券库存

接口描述：添加优惠券库存，添加库存时库存名称必须唯一，百度服务器以名称为唯一标识进行幂等操作，一个名称，只能做一次操作。 接口地址：https://openapi.baidu.com/rest/2.0/smartapp/coupon/addStock 请求方式：POST 请求参数：

Query参数：

POST数据：

格式：application/x-www-form-urlencoded

响应示例:

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

开发者为用户分配券

接口描述：用户在开发者小程序内领取优惠券后，开发者通过该接口将券添加至用户的卡券包内 接口地址：https://openapi.baidu.com/rest/2.0/smartapp/coupon/sync 请求方式：POST 请求参数：

Query参数：

POST数据：

格式：application/json

{
    "openid":"50zRWFu-pMbB4GK8FjH6EKbRxx",
    "coupon": {
        "record_id": "931c6e3af4a94b448becf9e0e8dc1663",
        "coupon_template_id": 123,
        "effect_time": 1558702254,
        "expire_time": 1558702255,
        "code": "ShowMeTheMoney"
    }
}

响应示例:

{
    "errno": "0",
    "errmsg": "success"
}

平台为用户分配券

接口描述：百度服务器会调用用户添加优惠券填写的callback_url 地址，进行用户发券操作，发券逻辑由开发者自行实现，开发者需要通过recordId 参数实现接口幂等性，百度服务器调用开发者接口3次没有明确的返回结果，将不会再调用并且任务本次发券失败。

接口地址：开发者自己定义回调地址 请求方式：POST 请求参数：

POST数据：

格式：application/json

响应示例:

{
    "errno": "0",
    "msg": "success"
    "data":"优惠码"
}

同步优惠券核销状态

接口描述：同步优惠券状态到百度服务器 接口地址：https://openapi.baidu.com/rest/2.0/smartapp/coupon/writeOffCoupon 请求方式：POST 请求参数：

Query参数：

POST数据：

格式：application/x-www-form-urlencoded

响应示例:

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

统计接口

接口描述:在线查询优惠券历史数据。

接口地址:https://openapi.baidu.com/rest/2.0/smartapp/coupon/couponStat

请求方式：POST

请求参数：

响应示例:

{
  "data": {
    "dataList": [
      {
        "appKey": "string", 
        "couponId": 0, 
        "getPv": 0,//领取次数
        "getRate": 0,// 领取人数
        "getUv": 0,//浏览人数
        "pdate": "2019-07-19T05:45:57.323Z",//数据更新时间
        "stock": 0,//优惠券库存
        "usePv": 0,//使用次数
        "useRate": 0,//使用人数/领取人数
        "useUv": 0,//使用人数
        "viewPv": 0,//浏览次数
        "viewUv": 0//浏览人数
      }
    ],
    "pageNo": 0,
    "total": 0
  },
  "errno": 0,
  "msg": "string"
}