管理卡券

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

获取卡券详情

  • 请求说明

Https请求方式: POST

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

请求JSON数据包示例:

{ 
   "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}
  • 参数说明
参数 必须 说明
access_token 调用接口凭证
card_id 卡券ID
  • 权限说明

需具备该卡券的投放权限,第三方套件管理组默认具备创建的卡券的投放权限。

  • 返回说明

返回JSON数据包示例:

{
  "errcode": 0,
  "errmsg": "ok",
   "card": {
      "card_type":  "GROUPON",
      "groupon": {
          "base_info": {
              "status": 1,
              "id": "p1Pj9jr90_SQRaVqYI239Ka1erkI",
              "logo_url": "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0",
              "appid": "wx588def6b0089dd48",
              "code_type": "CODE_TYPE_TEXT",
              "brand_name": "海底捞",
              "title": "132元双人火锅套餐",
              "date_info": {
                  "type": "DATE_TYPE_FIX_TIME_RANGE",
                  "begin_timestamp": 1397577600,
                  "end_timestamp": 1399910400
              },
              "color": "#3373bb",
              "notice": "使用时向服务员出示此券",
              "service_phone": "020-88888888",
              "description": "不可与其他优惠同享\n如需团购券发票,请在消费时向商户提出\n店内均可使用,仅限堂食\n餐前不可打包,餐后未吃完,可打包\n本团购券不限人数,建议2人使用,超过建议人数须另收酱料费5元/位\n本单谢绝自带酒水饮料",
              "use_limit": 1,
              "get_limit": 3,
              "can_share": 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": "大众点评"   
              "sku": {
                  "quantity": 0
                  "total_quantity":1000
              }
          },
          "deal_detail": "以下锅底2选1(有菌王锅、麻辣锅、大骨锅、番茄锅、清补凉锅、酸菜鱼锅可选):\n大锅1份 12元\n小锅2份 16元\n以下菜品2选1\n特级肥牛1份 30元\n洞庭鮰鱼卷1份 20元\n其他\n鲜菇猪肉滑1份 18元\n金针菇1份 16元\n黑木耳1份 9元\n娃娃菜1份 8元\n冬瓜1份 6元\n火锅面2个 6元\n欢乐畅饮2位 12元\n自助酱料2位 10元",
}
  • 参数说明
参数 说明
errcode 错误码
errmsg 错误信息
card 卡券详情

获取卡券摘要列表

  • 请求说明

Https请求方式: POST

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

请求JSON数据包示例:

{ 
"offset": 0,
"count": 10, 
"status": "CARD_STATUS_VERIFY_OK"
}
  • 参数说明
参数 必须 说明
access_token 调用接口凭证
offset 查询卡列表的起始偏移量,从0开始,即offset: 5是指从从列表里的第六个开始读取。
count 需要查询的卡片的数量(数量最大50)。
status 支持开发者拉出指定状态的卡券列表。若不填默认拉取所有状态
  • 权限说明

需具备该卡券的投放权限,第三方套件管理组默认具备创建的卡券的投放权限。

  • 返回说明

返回JSON数据包示例:

{
   "errcode":0,
   "errmsg":"ok",
   "card_digest_list":[
   {
       "card_id”: "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
       "card_type": “GENERAL_COUPON",
        "title”:  "title",
        "status”: "CARD_STATUS_VERIFY_OK",
        "quantity":10,
        "total_quantity": 100,
        "createtime": 1461213092         
   },
   ],
   "total_num":10
}
  • 返回参数说明
参数 说明
errcode 错误码
errmsg 错误信息
card_digest_list 卡券摘要列表
card_type 卡券类型。

团购券:GROUPON; 折扣券:DISCOUNT; 礼品券:GIFT; 代金券:CASH; 通用券:GENERAL_COUPON;

title 卡券标题
status 卡券状态
quantity 当前剩余卡券数量
total_quantity 卡券总量
createtime 创建时间
total_num 卡券列表总数


修改卡券库存

  • 请求说明

Https请求方式: POST

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

请求JSON数据包示例:

{ 
  "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
  "increase_stock_value": 1231231,
  "reduce_stock_value": 1231231
}
  • 参数说明
参数 必须 说明
access_token 调用接口凭证
increase_stock_value 增加多少库存,支持不填或者填0
reduce_stock_value 减少多少库存,支持不填或者填0(increase_stock_value跟reduce_stock_value必须填其中一个)
  • 权限说明

只有创建该卡券的管理组才具备修改卡券库存的权限

  • 返回说明
{
   "errcode":0,
   "errmsg":"ok",
}

删除卡券

  • 请求说明

Https请求方式: POST

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

请求JSON数据包示例:

{ 
   "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
}
  • 参数说明
参数 必须 说明
access_token 调用接口凭证
card_id 卡券id
  • 权限说明

只有创建该卡券的管理组才具备修改卡券库存的权限

  • 返回说明
{
 "errcode":0,
 "errmsg":"ok",
}