抖音开放平台Logo
控制台

券状态批量查询

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

用于批量查询抖音券码和三方券码的状态

1、支持查询抖音团购券码和三方券码的状态。

2、核销开放过程中，如存在断网情况下，商家系统没办法及时收到核销状态，增加券状态查询接口，方便商家系统查询券码状态。

3、通过验券准备接口返回的加密 code 查询抖音团购券码状态。

基本信息

名称描述
HTTP URL
https://open.douyin.com/goodlife/v1/fulfilment/certificate/query/
HTTP Method
GET
Scope
life.capacity.fulfilment
权限要求

团购核销

  • 需要申请权限 ，路径：抖音开放平台-开发者平台/服务商平台>控制台>应用详情>解决方案
  • 需要商家授权，路径：抖音来客>店铺管理>第三方应用授权

请求头

名称字段类型是否必填示例描述
access-tokenString是clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
调用https://open.douyin.com/oauth/client_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Query

名称字段类型是否必填示例描述
encrypted_codeString否
验券准备接口返回的加密券码
order_idString否
订单id

请求示例

curl --location --request GET '/goodlife/v1/fulfilment/certificate/query/?order_id=Ymy3lOxneR&encrypted_code=1AdRxk5TSI' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \
--data ''

响应参数

Body

名称字段类型是否必填示例描述

响应示例

正常响应示例

{
  "extra": {
    "now": 8880006325576828000,
    "error_code": 6554830593502960000,
    "description": "jgFrKivDws",
    "sub_error_code": 800392413820025200,
    "sub_description": "3c95awd9zZ",
    "logid": "202008121419360101980821035705926A"
  },
  "data": {
    "error_code": 0,
    "description": "",
    "certificates": [
      {
        "code": "VuenMW7J8a",
        "start_time": 3762404832054754000,
        "verify_records": [
          {
            "verify_time": 5718875718367519000,
            "can_cancel": false,
            "verify_type": 1,
            "verifier_unique_id": "RtgCb7j9na",
            "poi_id": 7498257378170681000,
            "times_card_serial_num": 2111114192552362500,
            "verify_id": "uzxAErvIpx",
            "certificate_id": "Ex3LjOQ7z9"
          }
        ],
        "sku": {
          "account_id": "4Tgn9wq3rS",
          "sku_id": "X8V1ChPShS",
          "title": "TwjtC0RjjP",
          "groupon_type": 1,
          "market_price": 979956114753360800,
          "sold_start_time": 694295865226695200,
          "third_sku_id": "ZHeFhcopxH"
        },
        "time_card": {
          "times_count": 7675332396378915000,
          "times_used": 4991786087051752000,
          "serial_amount_list": [
            {
              "amount": {
                "list_market_amount": 2782383580795566600,
                "platform_discount_amount": 1872317748751914800,
                "original_amount": 5721275334127639000,
                "pay_amount": 1183729661355583500,
                "merchant_ticket_amount": 818981246964937700,
                "payment_discount_amount": 1144589226146152600,
                "coupon_pay_amount": 1388424108496739800
              },
              "serial_numb": 4821612254847258000
            }
          ]
        },
        "used_status_type": 1,
        "not_available_time_info": {
          "fulfil_enable": false,
          "can_no_use_week_day": [
            3701051760467985000
          ],
          "can_no_use_date": [
            {
              "start_time": 5755149140880593000,
              "end_time": 1261351256471605500
            }
          ]
        },
        "verify": {
          "poi_id": 1636286722979404800,
          "times_card_serial_num": 4451003280077107000,
          "verify_id": "oGQknXVwHn",
          "certificate_id": "Bk7rGqZxvQ",
          "verify_time": 5887692059264287000,
          "can_cancel": false,
          "verify_type": 1,
          "verifier_unique_id": "oUezRRFx9d"
        },
        "status": 1,
        "certificate_id": 213019526250494180,
        "encrypted_code": "7JFsVS5hkO",
        "amount": {
          "pay_amount": 1456136257426563300,
          "merchant_ticket_amount": 8214555261426737000,
          "payment_discount_amount": 2362080791450427400,
          "coupon_pay_amount": 808496404828777500,
          "list_market_amount": 7296247325380319000,
          "platform_discount_amount": 8533024206535567000,
          "original_amount": 5769562558822997000
        },
        "expire_time": 535218170896993340
      }
    ]
  }
}

异常响应示例

{
  "data": {
    "error_code": 2190008,
    "description": "access_token过期,请刷新或重新授权"
  },
  "extra": {
    "error_code": 2190008,
    "description": "access_token过期,请刷新或重新授权",
    "sub_error_code": 0,
    "sub_description": "access_token过期,请刷新或重新授权",
    "logid": "202406131959494F28C28C0002DD440D4B",
    "now": 1718279990081
  }
}

错误码

http状态码错误码错误码描述排查建议
2002190002
access_token无效
调用接口重新生成access_token
2002190004
应用未获得该能力, 请去https://open.douyin.com/申请
应用申请接口权限
2002190008
access_token过期,请刷新或重新授权
规范token刷新机制，检查是否有测试环境在同步刷新token
2002119001
参数不合法
更换参数
2002119002
系统繁忙，请稍候再试
重试
2002119003
请求太过频繁，请稍后再试
重试
2002119005
应用未获商家授权
联系合作商家在商家后台发起授权，并在服务商后台同意授权
2003000001
根据实际业务错误返回
对照接口文档规范参数并重试
2004000001
根据实际业务错误返回
补充参数
2004000002
根据实际业务错误返回
对照接口文档规范参数并重试
2005000001
根据实际业务错误返回
联系抖音处理