查询券模板

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

接口说明

提供券模板查询能力,可用于查询券模板信息。

使用限制

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/promotion/v2/coupon/query_coupon_meta/
HTTP Method
POST
Scope
promotion.coupon.admin
权限要求

请求头

名称字段类型是否必填示例描述
access-tokenStringclt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-typeStringapplication/json
固定值"application/json"

请求参数

Body

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

抖音开放平台券模板ID,券模板创建接口会返回该字段

请求示例

curl --location 'https://open.douyin.com/api/promotion/v2/coupon/query_coupon_meta/' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \
--data '{
    "coupon_meta_id": "702345xxxxxx"
}' 

响应参数

Body

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

err_no非0时对应的错误信息文案提示,成功时为空字符串

err_noInt320

0表示成功

log_idString202008121419360101980821035705926A

标识请求的唯一ID

响应示例

正常响应示例

{
  "coupon_meta": {
    "coupon_meta_id": "702345xxxxxx",
    "coupon_name": "三亚10日游专享券",
    "merchant_meta_no": "KnV0oAsxg6",
    "discount_type": 1,
    "discount_amount": 1000,
    "min_pay_amount": 2000,
    "receive_begin_time": 1676984342,
    "receive_end_time": 1676984442,
    "valid_type": 1,
    "valid_begin_time": 1676984342,
    "valid_end_time": 1676984542,
    "consume_path": "pages/coupons/index?spm=1111&utm=22222",
    "stock_number": 1000,
    "receive_desc": "领取须知",
    "consume_desc": "使用须知",
    "callback_url": "https://www.abcde.com/xx/xx",
    "status": 2,
    "related_type": 1,
    "origin_id": "7309123xxxxxx",
    "secret_source": 1
  },
  "err_no": 0,
  "err_msg": "",
  "log_id": "202008121419360101980821035705926A"
}

异常响应示例

{
  "coupon_meta": {},
  "err_no": 28001007,
  "err_msg": "参数不合法",
  "log_id": "202008121419360101980821035705926A"
}

错误码

http状态码错误码错误码描述排查建议
20028001005
系统内部错误,请重试
请求重试,若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001006
网络调用错误,请重试
重试即可
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常