查询用户可用券信息
收藏接口说明
可通过调用该接口，查询用户在对应小程序下可用券信息。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/promotion/v1/coupon/get_coupon_receive_info/ |
| HTTP Method | POST |
| Scope | promotion.coupon.admin |
| 权限要求 | 无 |
请求参数
请求头
access-token必填String
示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Body展开全部子属性
app_id必填String
示例：ttec789ac573xxxxxx01
小程序appid
open_id必填String
示例：Cv4PoJXaTPn63rNu
用户在小程序 的open_id。该字段通过 /api/apps/v2/jscode2session 接口返回的 openid 字段获取
coupon_statusEnum
示例：10
券状态：
- 10：待使用
- coupon_id 字段为空时，必填
展开子属性
请求示例
curl --location --request POST 'https://open.douyin.com/api/promotion/v1/coupon/get_coupon_receive_info' \ --header 'access-token: clt.xxx' \ --header 'Content-Type: application/json' \ --data-raw '{ "app_id":"ttcfdbb96650exxxx", "open_id":"Cv4PoJXaTPnxxxx", "coupon_status": 10 }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例："access_token无效"
错误描述
err_no必填Int32
示例：28001003
错误码
log_id必填String
示例："202405291440576E078D8757B9"
日志id
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "", "log_id": "202304201146560B814XXXDB9D0B051956", "data": { "coupon_receive_list": [ { "discount_type": 2, "receive_desc": "领取描述", "valid_end_time": 1678716000, "talent_open_id": "Cv4PoJXaxxx63rNu", "valid_begin_time": 1678705200, "consume_path": "pages/index/index", "coupon_id": "720998824905xxxx532", "coupon_status": 10, "discount_amount": 1000, "min_pay_amount": 10, "consume_desc": "使用描述", "coupon_name": "券名称", "merchant_meta_no": "merchant_demo", "talent_account": "473945xxx83", "receive_time": 1678709372 } ] } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28001005 | 系统内部错误，请重试 | 请求重试，若依然无解请向平台提交反馈 |
| 200 | 28001003 | access_token无效 | 重新请求生成access_token |
| 200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
| 200 | 28001006 | 网络调用错误，请重试 | 重试即可 |
| 200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
