视频号
取消
中文
中文
EN
取消
  • 介绍

    • # 查询券账单

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

    接口英文名：getvoucherbilllist

    查询券账单

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/channels/ec/voucher/get_bill_list?access_token=ACCESS_TOKEN

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：164

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    product_idstring是通过本地生活api创建的商品id
    bill_datestring是账单日期，券发起核销时间
    page_sizenumber是页大小 值限制: 1 ≤ value ≤ 100
    page_ctxstring是翻页上下文，第一次请求填空，后续请求值为上次请求的返回

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    bill_listobjarray用户券账单列表
    page_ctxstring翻页上下文，如果为空，说明没有下一页

    # Res.bill_list(Array) Object Payload

    用户券账单列表

    参数名类型说明
    voucher_namestring商品名称
    product_idstring通过本地生活api创建的商品id
    codestring券code
    order_idstring购买券的订单ID
    openidstring用户在商家品牌appid下的openid
    voucher_buy_timenumber购买时间
    voucher_buy_amountnumber券售卖金额(分)。次卡时为单次金额
    voucher_pay_amountnumber用户支付金额(分) 。次卡时为单次金额
    mch_favor_amountnumber视频号小店商家优惠减价金额(分)。次卡时为单次金额
    platform_favor_amountnumber视频号小店平台优惠减价金额(分)。次卡时为单次金额
    consume_timenumber核销时间，时间戳
    consume_store_namestring核销的门店名称（商户在核销券接口传入后才会返回）
    mch_settle_amountnumber给商家的已结算金额(分)。次卡时为单次金额。
    finder_settle_amountnumber给达人的结算金额(分)。次卡时为单次金额
    out_store_idstring核销接口传入out_store_id
    time_indexnumber次序号标识2024年2月底次卡上线后返回

    # 4. 注意事项

    单商户限频200QPS

    # 5. 代码示例

    请求示例

    {
   "product_id": "123456",
   "bill_date": "2023-12-03",
   "page_size": 3,
   "page_ctx": ""
}

    返回示例

    {
   "errcode": 0,
   "errmsg": "成功",
   "bill_list":[
   {
     "voucher_name": "90抵100代金券",
     "product_id": "123456",
     "code": "123456789",
     "order_id": "027828012830384172",
     "openid": "asdjeine835k9fjeld93mf"
     "voucher_buy_time": 1702016538,
     "voucher_buy_amount": 9000,
     "voucher_pay_amount": 8500,
     "mch_favor_amount": 500,
     "platform_favor_amount": 0, 
     "consume_time": 1702189338,
     "consume_store_name": "开心小店",
     "mch_settle_amount": 8300,
     "finder_settle_amount":  0  
   },
   {
     "voucher_name": "90抵100代金券",
     "product_id": "123456",
     "code": "123456789",
     "order_id": "027828012830384172",
     "openid": "asdjeine835k9fjeld93mf"
     "voucher_buy_time": 1702016538,
     "voucher_buy_amount": 9000,
     "voucher_pay_amount": 8500,
     "mch_favor_amount": 500,
     "platform_favor_amount": 0, 
     "consume_time": 1702189338,
     "consume_store_name": "开心小店",
     "mch_settle_amount": 8300,
     "finder_settle_amount":  0  
   },
   {
     "voucher_name": "90抵100代金券",
     "product_id": "123456",
     "code": "123456789",
     "order_id": "027828012830384172",
     "openid": "asdjeine835k9fjeld93mf"
     "voucher_buy_time": 1702016538,
     "voucher_buy_amount": 9000,
     "voucher_pay_amount": 8500,
     "mch_favor_amount": 500,
     "platform_favor_amount": 0, 
     "consume_time": 1702189338,
     "consume_store_name": "开心小店",
     "mch_settle_amount": 8300,
     "finder_settle_amount":  0  
   }],
   "page_ctx": "dsfajasdlf3434"
}

    # 6. 错误码

    此接口没有特殊错误码，可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    # 7. 适用范围

    本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。