创建卡券

来自企业号开发者接口文档
跳转至: 导航搜索

接口调用说明

企业号创建的卡券目前无需审核。企业号目前支持优惠券、团购券、代金券、折扣券、礼品券五种类型。

创建卡券接口调用顺序:

1.调用上传LOGO接口将商户图标上传微信服务器并获取logo_url,用于创建卡券。

2.调用创建卡券接口,设置卡券相应信息,获取卡券ID,并标注可领取的库存。

  • 请求说明

Https请求方式: POST

https://qyapi.weixin.qq.com/cgi-bin/media/uploadimg?access_token=ACCESS_TOKEN&type=card_logo

1.上传的图片限制文件大小限制1MB,建议像素为300*300,仅支持JPG、PNG格式。

2.调用接口获取的logo_url仅支持在微信相关业务下使用。

3.频率限制:跟上传图文消息图片共用频率,每个企业每天不超过100次

  • 参数说明
参数 必须 说明
access_token 调用接口凭证
type 上传卡券logo,此处type固定为card_logo
media form-data中媒体文件标识,有filename、filelength、content-type等信息
  • 权限说明

卡券管理员,即有创建卡券权限的管理组以及有授权套件的第三方套件管理组。

  • 返回说明

返回JSON数据包示例:

{
   "errcode": 0,
   "errmsg": "ok",
   "url": "http://mmbiz.qpic.cn/mmbiz/fdasfajhasdfkjfhiuyfasg/0"
}
  • 返回参数说明
参数 说明
errcode 错误码
errmsg 错误信息
url 商户logo_url,用于创建卡券接口中填入。特别注意:该链接仅用于微信相关业务,不支持引用。

创建卡券

  • 请求说明

Https请求方式: POST

https://qyapi.weixin.qq.com/cgi-bin/card/create?access_token=ACCESS_TOKEN

该接口创建的卡券可以可以通过文档提供的投放接口将卡券下发给用户,每次成功领取,库存数量相应扣除。

请求json包结构体为:

优惠券

{
  "card": {
          "card_type": "GENERAL_COUPON",
           "general_coupon": {
           "base_info": {
                "logo_url":"biz_get(url)",
                "brand_name":"海底捞",
                "code_type":"CODE_TYPE_TEXT",
                "title": "双人火锅套餐",             
                "color": "Color010",
                "notice": "使用时向服务员出示此券",
                "service_phone": "020-88888888",
                "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食",
                "date_info": {
                     "type": "DATE_TYPE_FIX_TIME_RANGE",
                     "begin_timestamp": 1462923523 ,
                     "end_timestamp": 1472933523
                 },
              "sku": {
                     "quantity": 500000
             
              },
              "get_limit": 3,
              "bind_openid": false,
              "can_share": true,
               "can_give_friend": true,    
               "custom_url_name": "自定义入口名称",
               "custom_url": "http://www.qq.com",
               "custom_url_sub_title": "6个汉字tips",
               "promotion_url_name": "更多优惠",
                "promotion_url": "http://www.qq.com",
                "source": "大众点评"   
                },
            "default_detail":"音乐木盒"
         }
}
  • 参数说明
参数 必须 说明
card_type 优惠类型:GENERAL_COUPON,若不填默认为优惠券类型
base_info 卡券基础信息字段,见下表,所有卡券类型通用。
default_detail 优惠券专用,填写优惠详情。

团购券

{ 
  "card": {
          "card_type": "GROUPON",
          "groupon": {
          "base_info": {
             "logo_url":"http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLu/0",
             "brand_name":"海底捞",
             "code_type":"CODE_TYPE_TEXT",
             "title": "双人火锅套餐",
             "color": "Color010",
             "notice": "使用时向服务员出示此券",
             "service_phone": "020-88888888",
             "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食",
             "date_info": {
                "type": "DATE_TYPE_FIX_TIME_RANGE",
                "begin_timestamp": 1397577600 ,
                "end_timestamp": 1472933523
              },
             "sku": {
                "quantity": 500000
              },
             "get_limit": 3,
             "bind_openid": false,
             "can_share": true,
             "can_give_friend": true,
             "custom_url_name": "自定义入口名称",
             "custom_url": "http://www.qq.com",
             "custom_url_sub_title": "6个汉字tips",
             "promotion_url_name": "更多优惠",
             "promotion_url": "http://www.qq.com",
             "source": "大众点评"   
          },
          "deal_detail": "以下锅底2选1(有菌王锅、麻辣锅、大骨锅、番茄锅、清补凉锅、酸菜鱼锅可选):\n大锅1份 12元\n小锅2份 16元 "}
      }
 }


  • 参数说明
参数 必须 说明
card_type 团购券类型:GROUPON
base_info 卡券基础信息字段,见下表,所有卡券类型通用。
deal_detail 团购券专用,团购详情。

代金券

{
   "card": {
           "card_type": "CASH",
            "cash": {
               "base_info": {
                 "logo_url":"biz_get(url)",
                 "brand_name":"海底捞",
                 "code_type":"CODE_TYPE_TEXT",
                 "title": "双人火锅套餐",
                 "color": "Color010",
                 "notice": "使用时向服务员出示此券",
                 "service_phone": "020-88888888",
                 "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食",
                 "date_info": {
                     "type": "DATE_TYPE_FIX_TIME_RANGE",
                     "begin_timestamp": 1462923523 ,
                     "end_timestamp": 1472933523
                 },
                 "sku": {
                     "quantity": 500000
                 },
                 "get_limit": 3,
                 "bind_openid": false,
                 "can_share": true,
                 "can_give_friend": true,
                 "custom_url_name": "自定义入口名称",
                 "custom_url": "http://www.qq.com",
                 "custom_url_sub_title": "6个汉字tips",
                 "promotion_url_name": "更多优惠",
                 "promotion_url": "http://www.qq.com",
                 "source": "大众点评"   
                 },
             "least_cost": 10000,
             "reduce_cost": 100
             }
     }
}
  • 参数说明
参数 必须 说明
card_type 代金券类型:CASH
base_info 卡券基础信息字段,见下表,所有卡券类型通用。
least_cost 代金券专用,表示起用金额(单位为分),如果无起用门槛则填0。
reduce_cost 代金券专用,表示减免金额。(单位为分)

折扣券

{
 "card": {
           "card_type": "DISCOUNT",
           "discount": {
           "base_info": {
               "logo_url":"biz_get(url)",
                "brand_name":"海底捞",
                "code_type":"CODE_TYPE_TEXT",
                "title": "双人火锅套餐",
                "color": "Color010",
                "notice": "使用时向服务员出示此券",
                "service_phone": "020-88888888",
                "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食",
                "date_info": {
                     "type": "DATE_TYPE_FIX_TIME_RANGE",
                     "begin_timestamp": 1462923523 ,
                     "end_timestamp": 1472933523
                 },
                 "sku": {
                     "quantity": 500000
                 },
                "get_limit": 3,
                "bind_openid": false,
                "can_share": true,
                "can_give_friend": true,   
                "custom_url_name": "自定义入口名称",
                "custom_url": "http://www.qq.com",
                "custom_url_sub_title": "6个汉字tips",
                "promotion_url_name": "更多优惠",
                "promotion_url": "http://www.qq.com",
                "source": "大众点评"   
               },
            "discount":30
             }
}
  • 参数说明
参数 必须 说明
card_type 折扣券类型:DISCOUNT
base_info 卡券基础信息字段,见下表,所有卡券类型通用。
discount 折扣券专用,表示打折额度(百分比)。填30就是七折。

礼品券

{
  "card": {
           "card_type": "GIFT",
           "gift": {
              "base_info": {
                 "logo_url":"biz_get(url)",
                 "brand_name":"海底捞",
                 "code_type":"CODE_TYPE_TEXT",
                 "title": "双人火锅套餐",
                 "sub_title": "周末狂欢必备",
                 "color": "Color010",
                 "notice": "使用时向服务员出示此券",
                 "service_phone": "020-88888888",
                 "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食",
                 "date_info": {
                     "type": "DATE_TYPE_FIX_TIME_RANGE",
                     "begin_timestamp": 1462923523 ,
                     "end_timestamp": 1472933523
                 },
                 "sku": {
                     "quantity": 500000
                 },
                 "get_limit": 3,
                 "bind_openid": false,
                 "can_share": true,
                 "can_give_friend": true,
            
                 "custom_url_name": "自定义入口名称",
                 "custom_url": "http://www.qq.com",
                 "custom_url_sub_title": "6个汉字tips",
                 "promotion_url_name": "更多优惠",
                 "promotion_url": "http://www.qq.com",
                 "source": "大众点评"   
                 },
            "gift":"可兑换音乐木盒一个"
             }
}
  • 参数说明
参数 必须 说明
card_type 礼品券类型:GIFT
base_info 卡券基础信息字段,见下表,所有卡券类型通用。
gift 礼品券专用,填写礼品的名称。


卡券基础信息字段(base_info字段) 必填字段

  • 参数说明
参数 必须 说明
logo_url 卡券的商户logo
code_type Code展示类型,"CODE_TYPE_TEXT",文本;"CODE_TYPE_BARCODE",一维码 ;"CODE_TYPE_QRCODE",二维码;"CODE_TYPE_ONLY_QRCODE",二维码无code显示;"CODE_TYPE_ONLY_BARCODE",一维码无code显示;默认为CODE_TYPE_TEXT类型
brand_name 商户名字,字数上限为12个汉字。
title 卡券名,字数上限为9个汉字。(建议涵盖卡券属性、服务及金额)。
color 券颜色。按色彩规范标注填写Color010-Color102。详情见卡券颜色列表
notice 卡券使用提醒,字数上限为16个汉字。
description 卡券使用说明,字数上限为1024个汉字。
sku 商品信息。
quantity 卡券库存的数量,上限为100000000。
date_info 使用日期,有效期的信息。
type 使用时间的类型,DATE_TYPE_FIX_TIME_RANGE 表示固定日期区间,DATE_TYPE_FIX_TERM表示固定时长(自领取后按天算。)
begin_timestamp type为DATE_TYPE_FIX_TIME_RANGE时专用,表示起用时间。从1970年1月1日00:00:00至起用时间的秒数,最终需转换为字符串形态传入。(东八区时间,单位为秒)
end_timestamp type为DATE_TYPE_FIX_TIME_RANGE时专用,表示结束时间,建议设置为截止日期的23:59:59过期。(东八区时间,单位为秒)截止日期必须大于当前时间
fixed_term type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天内有效,不支持填写0。
fixed_begin_term type为DATE_TYPE_FIX_TERM时专用,表示自领取后多少天开始生效,领取后当天生效填写0。(单位为天)

非必填字段

  • 参数说明
参数 必须 说明
bind_openid 是否指定用户领取,填写true或false。默认为false。通常指定特殊用户群体投放卡券或防止刷券时选择指定用户领取。
service_phone 客服电话。
location_id_list 门店位置poiid。企业号暂不支持该参数
source 第三方来源名,例如同程旅游、大众点评。
custom_url_name 自定义跳转外链的入口名字。
custom_url 自定义跳转的URL。
custom_url_sub_title 显示在入口右侧的提示语。
promotion_url_name 营销场景的自定义入口名称。
promotion_url 入口跳转外链的地址链接。
promotion_url_sub_title 显示在营销入口右侧的提示语。
get_limit 每人可领券的数量限制,不填写默认为50。
can_share 卡券领取页面是否可分享。
can_give_friend 卡券是否可转赠。
  • 返回说明

返回json数据包示例:

{
  "errcode": 0,   
  "errmsg":"ok",
 “card_id”: “p1Pj9jr90_SQRaVqYI239Ka1erkI”
 }
  • 参数说明
参数 说明
errcode 错误码
errmsg 错误信息
card_id 卡券ID

卡券颜色列表

目前微信企业号提供包括以上十种色值的共计十四种色值供开发者使用。

背景颜色名称 色值
Color010 #63b359
Color020 #2c9f67
Color030 #509fc9
Color040 #5885cf
Color050 #9062c0
Color060 #d09a45
Color070 #e4b138
Color080 #ee903c
Color081 #f08500
Color082 #a9d92d
Color090 #dd6549
Color100 #cc463d
Color101 #cf3e36
Color102 #5E6671