- 小程序 OpenAPI SDK 总览
- OpenAPI 简介
- 用户登录态签名
- 签名算法
- 联合授权
- 接口调用凭证
- 登录
- 小程序码与小程序链接
- Web 化接入
- 私信和群聊
- 解决方案
- 线索组件
- 隐私协议
- 视频能力
- 搜索能力
- 任务能力
- 电商
- 生活服务
- 短剧行业
- 用户信息
- 分享
- 客服
- 交易工具
- 小程序券
- 交易系统
- 素材库
- 内容安全
- 泛知识
- 担保支付
- 评价
- 其它
- 订阅消息
- 小程序推广计划
- 挂载
- 分发
- 数据分析
- 服务类目
- 直播间能力
- 抖音开放能力
- 能力申请
- 页面结构自定义
- 普通二维码绑定
- 抖音号绑定
- 流量主
- 抖店绑定
查询用户券列表
更新时间 2024-07-24 02:58:49
收藏
我的收藏该接口用于查询该用户在该商户下的所有门店或指定门店下的所有可用的券列表。
使用限制
无
接口说明
- •核销工具类小程序才能调用此api
- •核销工具类小程序需要有对应商家(account_id)的授权关系才能查询
基本信息
基本信息 | |
HTTP URL | |
HTTP Method | POST |
Scope | industry_open.trade.certificate_query |
权限要求 | 不需要用户授权 |
请求头
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
open_id | string | 是 | 抖音用户open_id | ba253642-0590-40bc-xxx |
account_id | string | 是 | 商家团购账号id(抖音来客账号id)。需要先有此商家授权关系才能获取到。 | 12345 |
poi_id | string | 否 | 适用门店poi_id | 123 |
page | int32 | 否 | 分页展示用户券起始页,默认1 | 1 |
page_size | int32 | 否 | 分页查询订单数量 page_size <= 50,默认50 | 10 |
biz_type | int32 | 否 | 1: 核销工具(默认); 2:混合双开 | 1 |
请求示例
js复制curl --location --request POST 'https://open.douyin.com/api/trade/v2/fulfillment/query_user_certificates' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.xxx' \
--data-raw='{
"open_id":"ba253642-0590-40bc-xxx",
"account_id":"12345",
"poi_id":"123",
"page":1,
"page_size":10
}'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
data | object | 是 | 返回数据 | |
extra | object | 是 | 额外信息 | |
data 信息
名称 | 类型 | 是否必填 | 描述 | 示例值 |
orders | array(object) | 是 | 抖音订单列表 | |
total | int64 | 是 | 该用户待使用订单总数 | |
orders 参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
order_id | string | 是 | 抖音内部交易订单号,长度<64byte。 | 80000088 |
certificates | array(object) | 是 | 此订单的券信息 | |
can_use | bool | 是 | 是否可用 | true |
certificates 参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
certificate_id | string | 是 | 券ID | 71817 |
sku_info | object | 是 | 券相关的sku商品信息。详见下方sku_info参数字段说明 | |
amount | object | 是 | 券相关金额信息。详见下方amount参数字段说 明 | |
expire_time | int64 | 是 | 券有效时间,秒级 | 1703260799 |
start_time | int64 | 是 | 券有效开始时间,秒级 | 1672138509 |
code | string | 否 | 三方码则返回明文code,抖音码不返回。 | |
times_card_info | object | 否 | 次卡信息。详见下方times_card_info参数字段说明 | |
sku_info 参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
sku_id | string | 是 | sku商品id | 123 |
title | string | 是 | 商品名称 | 测试商品 |
groupon_type | int32 | 是 | 商品类型 1 团购券 2 代金券 3 次卡 | 1 |
market_price | int64 | 是 | 团购市场价,单位分 | 20 |
sold_start_time | int64 | 是 | 团购售卖开始时间,时间戳,单位秒 | 1672123976 |
third_sku_id | string | 否 | 商家系统(第三方)团购id | |
account_id | string | 是 | 商家团购账号id | 12345 |
spu_id | string | 否 | 商品spu_id | 12345 |
out_id | string | 否 | 外部商品id | 12345 |
amount 参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
original_amount | int32 | 是 | 券原始金额,单位分 | 20 |
pay_amount | int32 | 是 | 用户实付金额,单位分 | 20 |
merchant_ticket_amount | int32 | 否 | 商家营销金额,单位分 | 0 |
payment_discount_amount | int32 | 否 | 支付优惠金额,单位分 | 0 |
coupon_pay_amount | int32 | 否 | 券实付金额(=用户实付金额+支付优惠金额),单位分 | 20 |
platform_ticket_amount | int32 | 否 | 平台补贴金额,单位分 | 20 |
times_card_info 参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
total_times | int64 | 是 | 总次数 | 20 |
usable_times | int64 | 是 | 可用次数 | 20 |
extra 信息
名称 | 类型 | 是否必填 | 描述 | 示例值 |
error_code | int | 是 | 错误码,0为成功 | 0 |
description | string | 是 | 错误码描述 | success |
sub_error_code | int | 是 | 子错误码 | 0 |
sub_description | string | 是 | 子错误码描述 | success |
logid | string | 是 | 请求id | 2022092115392201020812109511046 |
now | int | 是 | 毫秒级时间戳 | 1663745962686 |
响应示例
正常示例
json复制{
"data": {
"orders": [
{
"can_use": true,
"certificates": [
{
"amount": {
"original_amount": 20,
"pay_amount": 20,
"merchant_ticket_amount": 0,
"payment_discount_amount": 0,
"coupon_pay_amount": 20
},
"certificate_id": "71817",
"expire_time": 1703260799,
"sku_info": {
"account_id": "12345",
"groupon_type": 1,
"market_price": 20,
"sku_id": "123",
"sold_start_time": 1672123976,
"third_sku_id": "",
"title": "测试商品"
},
"start_time": 1672138509
}
],
"order_id": "80000088"
}
],
"total": 1,
"error_code": 0,
"description": ""
},
"extra": {
"error_code": 0,
"logid": "20221228144816E59CDC04081F5001B2CE",
"now": 1672210096,
"sub_description": "success",
"sub_error_code": 0,
"description": ""
}
}
异常示例
json复制{
"data": {
"error_code": 13000,
"description": "系统错误"
},
"extra": {
"sub_error_code": 13000,
"sub_description": "系统错误",
"logid": "2022092115392201020812109511046",
"now": 1663745962686,
"error_code": 2191000,
"description": ""
}
}
错误码
HTTP 状态码 | 错误码 sub_error_code | 描述 | 排查建议 |
200 | 10000 | 参数错误 | 参数不符合规范。请根据提示检查参数。 |
200 | 13000 | 系统错误,请重试 | 内部错误,重试可解决。 |
点击纠错