catalog

1 Query Code Interface

2 Get the user who has received a card interface

3 View Card Details

4 Bulk Checklist of coupons

5 Change the card information interface

6 Modify the Inventory Interface

7 Changing the Code interface

8 Remove the coupon interface

9 Set up a coupon failure interface

10 Statistical card data

10.1 Drag voucher profile data interface

10.2 Get a free coupon data interface

10.3 Drag a member card profile data interface

10.4 Drag a single member card data interface

# Query Code interface

The query code interface can query whether the current code can be written off and check the status of the code. The current status that can be located is normal, write-off, transfer, deleted, invalid and invalid code.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/code/get?access_token=TOKEN

Parameter explaination

POST data

{
   "card_id" : "card_id_123+",
   "code" : "123456789",
   "check_consume" : true
}

Parameter explaination

Returns data when check_consume is true

The voucher is in normal condition:

 {
  "errcode": 0,
  "errmsg": "ok",
  "card": {
    "card_id": "pbLatjk4T4Hx-QFQGL4zGQy27_Qg",
    "begin_time": 1457452800,
    "end_time": 1463155199
  },
  "openid": "obLatjm43RA5C6QfMO5szKYnT3dM",
  "can_consume": true,
  "outer_str": "12b",
  "user_card_status": "NORMAL"
}

The card status is unusual:

{
 "errcode": 40127,
 "errmsg": "invalid user-card status! Hint: the card was given to user, but may be deleted or set unavailable ! hint: [iHBD40040ent3]"
}

Returns data when check_consume is false

The voucher is in normal condition:

 {
  "errcode": 0,
  "errmsg": "ok",
  "card": {
    "card_id": "pbLatjk4T4Hx-QFQGL4zGQy27_Qg",
    "begin_time": 1457452800,
    "end_time": 1463155199
  },
  "openid": "obLatjm43RA5C6QfMO5szKYnT3dM",
  "can_consume": true,
  "outer_str": "12b",
  "user_card_status": "NORMAL"
}

The card status is unusual:

 {
  "errcode": 0,
  "errmsg": "ok",
  "card": {
    "card_id": "pbLatjnK8NLbWgwMgfMtnj3gaglw",
    "begin_time": 1457625600,
    "end_time": 1460217599
  },
  "openid": "obLatjm43RA5C6QfMO5szKYnT3dM",
  "can_consume": false,
  "outer_str": "12b",
  "user_card_status": "GIFTING"
 }

NOTE:

1. The fixed-time validity period is converted according to the actual time of receipt of the user. If the user collects on October 1, 2013, the fixed-term validity period will be 90 days, i.e. the validity period runs from October 1 to December 29, 2013.

2. Whether check_consume is filled in true or false, when the code is not added or the code is transferred to receive a unified error: invalid serial code

# Get the user who has received a card interface

Used to obtain the user's card package, belonging to the AppID all available card vouchers, including normal and abnormal state .

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/user/getcardlist?access_token=TOKEN

Parameter explaination

POST data

{
  "openid": "12312313",
  "card_id": "xxxxxxxxxx"
}

Parameter explaination

Return data

 {"errcode":0,"errmsg":"ok","card_list": [
      {"code": "xxx1434079154", "card_id": "xxxxxxxxxx"},
      {"code": "xxx1434079155", "card_id": "xxxxxxxxxx"}
      ]，
       "has_share_card": true
}

Parameter explaination

# View voucher details

Developers can call this interface to query the creation information, audit status, and inventory of a card_id.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/get?access_token=TOKEN

Parameter explaination

POST data

{
  "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}

Return data

{
  "errcode": 0,
  "errmsg": "ok",
  "card": {
    "card_type": "DISCOUNT",
    "discount": {
      "base_info": {
        "id": "pbLatjnP97_F9PudzBARQhn7xR7A",
        "logo_url": "http://mmbiz.qpic.cn/mmbiz/p98FjXy8LafmY25YclQ7vw5noBxeVH3DG5AKFR1ZsRgMgsvjll7EkUsZib00J964AEpTjkNXF2HorJHt5mtt45Q/0?wx_fmt=png",
        "code_type": "CODE_TYPE_NONE",
        "brand_name": "微信餐厅",
        "title": "9折优惠券",
        "date_info": {
          "type": "DATE_TYPE_FIX_TERM",
          "fixed_term": 30,
          "fixed_begin_term": 0
        },
        "color": "#10AD61",
        "notice": "到店使用",
        "description": "",
        "location_id_list": [
          218384742,
          402521653,
          402521608
        ],
        "get_limit": 3,
        "can_share": true,
        "can_give_friend": true,
        "status": "CARD_STATUS_VERIFY_OK",
        "sku": {
          "quantity": 100096,
          "total_quantity": 100100
        },
        "create_time": 1457525546,
        "update_time": 1457526240,
        "area_code_list": []
      },
      "discount": 10,
      "advanced_info": {
        "time_limit": [
          {
            "type": "MONDAY"
          },
          {
            "type": "TUESDAY"
          }
        ],
        "text_image_list": [],
        "business_service": [],
        "consume_share_card_list": [],
        "abstract": {
          "abstract": "点击了解更多",
          "icon_url_list": [
            "http://mmbiz.qpic.cn/mmbiz/p98FjXy8LafiawSeJeqBzk8qC40iaKIwUPm4TSCelulzEbAywKr7tWjkd5vRjbmFloUFeThfwhwMUZIXmsCtJpyQ/0?wx_fmt=jpeg"
          ]
        },
        "share_friends": false
      }
    }
  }
}

Base_info field:

Developers' Note

1. For some merchants with special permissions, querying for voucher details may return fields with special interfaces.

2. Because voucher fields are constantly updated, the actual return fields include, but are not limited to, fields in the document, and developers are advised not to handle ununderstood fields when developing to avoid errors.

# Bulk query list of coupons

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/batchget?access_token=TOKEN

Parameter explaination

POST data

{
  "offset": 0,
  "count": 10,
   "status_list": ["CARD_STATUS_VERIFY_OK", "CARD_STATUS_DISPATCH"]
}

Return data

{
  "errcode":0,
  "errmsg":"ok",
  "card_id_list":["ph_gmt7cUVrlRk8swPwx7aDyF-pg"],
  "total_num":1
}

NOTE:

1. When a filter condition is not entered, the interface returns by default all stated coupons in the name of the merchant;

2. Developers can then request that the Check Coupon Details Interface be called to determine the status of the coupons;

# Change the card information interface

Interface Dxplaination

Supports updating information for some common fields and specific fields in special coupons (member cards, plane tickets, movie tickets, conference tickets) for all voucher types.

Dxplaination of Interface Call Request

HTTP请求方式: POSTURL:https://api.weixin.qq.com/card/update?access_token=TOKEN

Parameter explaination

POST data

{
       "card_id":"ph_gmt7cUVrlRk8swPwx7aDyF-pg",
       "member_card": {
        //填写该cardid相应的卡券类型（小写）。
               "base_info": {
                   "logo_url": "http:\/\/mmbiz.qpic.cn\/uploads\/allimg\/120216\/1_120216214725_1.jpg",
                   "color": "Color010",
                   "notice": "使用时向服务员出示此券",
                   "service_phone": "020-88888888",
                   "description": "不可与其他优惠同享\n如需团购券发票，请在消费时向商户提出\n店内均可使用，
                   仅限堂食\n餐前不可打包，餐后未吃完，可打包\n本团购券不限人数，建议2人使用，
                   超过建议人数须另收酱料费5元/位\n本单谢绝自带酒水饮料"
                   "location_id_list" : [123, 12321, 345345]
               },
                  "bonus_cleared": "aaaaaaaaaaaaaa",
                  "bonus_rules": "aaaaaaaaaaaaaa",
                  "prerogative": ""
       }
}

Common field modifications:

Unique field modifications for different types of coupons:

Note in particular that the following update-enabled fields are not in the structure of the base information base_info .

Returning data instructions

{
   "errcode":0,
   "errmsg":"ok",
   "send_check":false
}

Note for developers

1. Please note the fields that need to be re-reviewed. When a developer calls the update interface, if a review field is entered, the voucher needs to be revisited.

2. The interface is updated in a blanket manner: the developer simply enters the fields that need to be changed, other fields need not be filled in, otherwise the card may be re-reviewed.

3. If a developer nullifies certain fields, you can simply pass a "" (null) at the time of the update.

• 4. Once you have changed your card information after calling this interface, be sure to call it Home Verify that the change was successful, *

5. Unlisted fields do not support modification updates.

# Modify the inventory interface

Call the Modification Inventory Interface to increase or decrease the inventory of a voucher.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/modifystock?access_token=TOKEN

Parameter explaination

POST data

{
"card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"increase_stock_value": 1231231,
"reduce_stock_value": 1231231
}

Return data

{
"errcode":0,
"errmsg":"ok"
}

# Change the Code interface

To ensure security after the transfer, WeChat allows merchants with custom codes to make changes to the code they have issued.Note: To avoid users' confusion, it is recommended that users' code be changed only after a re-gift occurs (after a regift occurs, WeChat will inform the merchant of the re-gifted card code by event push).

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/code/update?access_token=TOKEN

Parameter explaination

POST data

{
  "code": "12345678",
  "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
  "new_code": "3495739475"
}

Return data

 {"errcode":0,"errmsg":"ok",}

# Remove the coupon interface

The Remove Coupon Interface allows merchants to remove any category of coupons. After deleting the card voucher, the card voucher corresponding to the generated two-dimensional code for collection, added to the card package JSAPI will be invalid. Note: If the user has received one or more coupons before the merchant deletes the coupons, the coupons will still be valid.That is, deleting the card voucher cannot delete the card voucher that has been received by the user and saved in the WeChat guest.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/delete?access_token=TOKEN

Parameter explaination

POST data

{
   "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
}

Return data

{
"errcode":0,
"errmsg":"ok"
}

# Set up a coupon failure interface

In order to meet unusual situations such as ticket changes and refunds, the voucher failure interface can be invoked to set the user's voucher to a failed state.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/code/unavailable?access_token=TOKEN

Parameter explaination

POST data

A request for a non-custom voucher {"code": "12312313," "reason": "refund"} or a request for a custom code voucher.{ "code": "12312313," "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc"}

Return data

{
"errcode":0,
"errmsg":"ok",
}

NOTE:

1. The operation of setting a voucher to expire is irreversible, i.e. it is not possible to bring a failed voucher back to a valid state, and the merchant must use caution in calling the interface.

• 2. Merchants must inform and obtain consent with customers before invoking the failed interface, otherwise the resulting customer complaint will be in accordance with the WeChat operating penalty rules.

# Statistical card data

In order to support developers to call the API to view voucher related data, the WeChat voucher team encapsulates the data interface and is open to developers with voucher function permissions.

Developers call this interface to obtain the total data related to all coupons under this merchant, as well as data related related to specified coupons.

# Drag voucher profile data interface

Interface Dxplaination

Supports invoking this interface to pull the aggregate data of the merchant, including the total number of indicators within a time period.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/datacube/getcardbizuininfo?access_token=ACCESS_TOKEN

Dxplaination of request parameters

POST data

｛
 "begin_date":"2015-06-15",
  //请开发者按示例格式填写日期，否则会报错date format error "end_date":"2015-06-30",
 "cond_source":  0
｝

Parameter explaination:

Return data explaination:

{
    "list": [
       {
           "ref_date": "2015-06-23",
           "view_cnt": 1,
           "view_user": 1,
           "receive_cnt": 1,
           "receive_user": 1,
           "verify_cnt": 0,
           "verify_user": 0,
           "given_cnt": 0,
           "given_user": 0,
           "expire_cnt": 0,
           "expire_user": 0
       }
   ] 
}

Field Dxplaination:

Particular note:

1. The query time interval is < = 62 days, otherwise the error {errcode: 61501, errmsg: "date range error"};

2. The incoming time format should be filled in "2015-06-15" in strict accordance with the example, otherwise the error {errcode ": 61500," errmsg ":" date format error "}

3. The interface can only draw data that is not the same day. It cannot draw card data that is the same day, otherwise an error is reported.

# Get a free coupon data interface

Interface Dxplaination

Developers can use this interface to pull data about free coupons (coupons, group coupons, discount coupons, gift coupons) over a fixed time period.

Dxplaination of Interface Call Request

Http request method: POST https://api.weixin.qq.com/datacube/getcardcardinfo?access_token=ACCESS_TOKEN

Dxplaination of request parameters

POST data

｛
 "begin_date":"2015-06-15",
 "end_date":"2015-06-30",
 "cond_source": 0,
 "card_id": "po8pktyDLmakNY2fn2VyhkiEPqGE"
｝

Parameter explaination:

Return data explaination :

{
    "list": [
       {
           "ref_date": "2015-06-23",
           "card_id": "po8pktyDLmakNY2fn2VyhkiEPqGE",
           "card_type":3,
           "view_cnt": 1,
           "view_user": 1,
           "receive_cnt": 1,
           "receive_user": 1,
           "verify_cnt": 0,
           "verify_user": 0,
           "given_cnt": 0,
           "given_user": 0,
           "expire_cnt": 0,
           "expire_user": 0
       }
   ]
}

Field Dxplaination:

Particular note:

1. At present, the interface supports only card-related data for collecting free coupons (coupons, group coupons, discount coupons, gift coupons), and does not support special ticket data (movie tickets, conference tickets, scenic attractions, plane tickets).

2. The query time interval needs to be < = 62 days, otherwise the error is reported {"errcode:" 61501，errmsg: "date range error"}；

3. The incoming time format should be filled in strictly according to the example, such as "2015-06-15," otherwise the error {"errcode": "date format error"}

4. The interface can only draw data that is not the same day. It cannot draw card data that is the same day, otherwise an error is reported.

# Drag a member card profile data interface

Interface Dxplaination

Developers are able to call this interface to pull data related to membership cards created by the public platform.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/datacube/getcardmembercardinfo?access_token=ACCESS_TOKEN

Parameter explaination

POST data

｛
 "begin_date":"2015-06-15",
 "end_date":"2015-06-30",
 "cond_source": 0
｝

Parameter explaination:

Return data explaination :

{
   "list": [
       {
           "ref_date": "2015-06-23",
           "view_cnt": 0,
              "view_user": 0,
              "receive_cnt": 0,
              "receive_user": 0,
              "active_user": 0,
              "verify_cnt": 0,
              "verify_user": 0,
              "total_user": 86,
              "total_receive_user": 95
   ]
}

Field Dxplaination:

’

# Drag a single member card data interface

Interface Dxplaination

Support the developer to call the interface to pull the API created by the card data situation

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/datacube/getcardmembercarddetail?access_token=ACCESS_TOKEN

Parameter explaination

POST data

｛
 "begin_date":"2015-06-15",
 "end_date":"2015-06-30",
 "card_id":"xxxxxxxxxxxxxxxx"
｝

Parameter explaination:

Return data explaination :

{
  "list": [
    {
      "ref_date": "2016-07-06",
      "merchanttype": 2,
      "cardid": "p4WkzwieuDBzzn7Jed6SBO0-ZgaU",
      "submerchantid": 0,
      "view_cnt": 2,
      "view_user": 1,
      "receive_cnt": 1,
      "receive_user": 1,
      "verify_cnt": 0,
      "verify_user": 0,
      "active_cnt": 1,
      "active_user": 1,
      "total_user": 249,
      "new_user": 0,
      "payOriginalFee": 0,
      "fee": 0
    }
  ]
}

Field Dxplaination: