查询用户券列表
接口说明
根据用户open_id和商户account_id查询该用户在该商户下可用的抖音团购券列表。 注意:目前只会返回抖音团购券、次卡类型订单,其他商品类型不会返回。 请求头通用参数请参考:通用参数
使用限制
SLA:支持的最大QPS:400;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/trade/v2/fulfillment/query_user_certificates/ |
| HTTP Method | POST |
| Scope | industry_open.trade.certificate_query |
| 权限要求 | 核销工具类小程序才能调用此api |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Body展开全部子属性
account_id必填String
示例:xxx
商家团购账号id(抖音来客账号id)
open_id必填String
示例:ba253642-0590-40bc-9bdf-9a1334b94059
抖音用户open_id
biz_typeInt32
示例:xxx
1: 核销工具(默认); 2:混合双开
groupon_typeList
示例:xxx
商品类型 1 团购券 2 代金券 3 次卡 4 剧场券 5 惠享卡;支持指定多个
展开子属性
pageInt32
示例:xxx
分页展示用户券起始页,默认1
page_dimensionEnum
示例:xxx
分页维度 1券维度(默认),2订单维度
展开子属性
page_sizeInt32
示例:xxx
分页查询订单数量 page_size <= 50,默认50
poi_idString
示例:xxx
适用门店poi_id
time_rangeStruct
示例:xxx
时间范围
展开子属性
请求示例
curl --location --request POST 'https://open.douyin.com/api/trade/v2/fulfillment/query_user_certificates/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"open_id":"ba253642-0590-40bc-9bdf-9a1334b94059","time_range":{"start_time":5752813789583660080,"end_time":5007516166875430726},"page_size":4287663804307251054,"groupon_type":[1],"biz_type":1522018434923680440,"page_dimension":1,"poi_id":"xxx","account_id":"xxx","page":4855187370893810861}'
响应参数
Body展开全部子属性
data必填Struct
返回数据信息
展开子属性
extra必填Struct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "orders": [ { "certificates": [ { "certificate_id": "11233", "amount": { "coupon_pay_amount": 5217648512689720000, "platform_ticket_amount": 7925356013196901000, "original_amount": 162811966527886140, "pay_amount": 3362012940504101000, "merchant_ticket_amount": 922956623852646900, "payment_discount_amount": 985686570819884400 }, "code": "XX", "times_card_info": { "total_times": 4921856313638247000, "locked_times_serial_nums": [ 4484288726296887000 ], "usable_times": 8572899057986713000, "total_times_serial_nums": [ 7440425551257764000 ], "used_times_serial_nums": [ 2685175974074187300 ], "ladder_times_card_info": [ { "seq": 8265534226414916000, "status": 1, "crossed_amount": 2953855081062046000, "original_amount": 7306112717381714000, "ticket": 7273687352509960000, "merchant_ticket": 484246978903872100, "pay_amount": 5693452555829139000 } ], "times_card_type": 1, "use_amount": 7381309422924119000 }, "lock_info_extra": { "lock_scene": 7016757461734420000, "lock_status": 6698486808539502000 }, "is_transfer_asset": false, "expire_time": 8014983336713009000, "sku_info": { "voucher_info": { "voucher_type": 1, "dynamic_par_rule_struct": { "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "end_time_is_next_day": false, "use_start_time": "00:00", "use_end_time": "12:00" }, "deductible_amount": 8110908774701045000 } ], "dynamic_par_rule_desc": "1223232", "dynamic_par_min_amount": 8086162589270925000, "dynamic_par_max_amount": 8709951666914498000 } }, "spu_id": "11232", "sku_id": "11232", "groupon_type": 1, "market_price": 9051125652865306000, "account_id": "1223232", "out_id": "11232", "sold_start_time": 994541802005899600, "title": "苹果15", "third_sku_id": "xxx" }, "use_rule_info": { "available_date_info": { "available_start_date": "xx", "available_end_date": "xx", "days_of_week": [ 1 ], "available_date_type": 1, "day_duration": 466738162752908100 }, "unavailable_date_info": { "holiday_dates": { "1": "TCKQ7oa7og" }, "enable": false, "days_of_week": [ 1 ], "holidays": [ 1 ], "date_list": [ "5WVztX8aNz" ] }, "available_time_info": { "available_time_type": 1, "time_period_list": [ { "use_end_time": "12:00", "end_time_is_next_day": false, "use_start_time": "00:00" } ] } }, "start_time": 2838148629676504600, "off_peak_discount_detail": { "has_off_peak_discount": false, "off_peak_time_limit_type": 1, "off_peak_time": { "daily_time_range_list": [ { "start_time": "xx", "end_time": "xx" } ], "start_time": 7209954237722592000, "end_time": 3818969943617214000, "week_day_list": [ 1998901177367797000 ] } }, "benefit_card_info": { "total_amount": { "total_amount": 8309410602054722000, "principal_amount": 7418848539584082000, "benefit_amount": 7615832920323308000 }, "left_amount": { "principal_amount": 3822839405003694000, "benefit_amount": 4110628514939247000, "total_amount": 4408672501126695000 } } } ], "can_use": false, "order_id": "8763998" } ], "total": 7512849257799981000, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202601131940352BC56F3776D52006BB3D", "now": 1768304438 } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 2119001 | 参数不合法 | 更换参数 |
| 200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
| 200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
| 200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
| 200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
| 200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
| 200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
| 200 | 3000001 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 5000001 | 根据实际业务错误返回 | 联系抖音处理 |
| 200 | 4000001 | 根据实际业务错误返回 | 补充参数 |
| 200 | 4000002 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 28001005 | 系统内部错误,请重试 | 请求重试,若依然无解请向平台提交反馈 |
| 200 | 28001003 | access_token无效 | 重新请求生成access_token |
| 200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
| 200 | 28001016 | 当前应用已被封禁或下线 | clientKey被封禁或者下线 |
| 200 | 28001006 | 网络调用错误,请重试 | 重试即可 |
| 200 | 28001014 | 应用未授权任何能力 | 确认应用是否授权能力 |
| 200 | 28001018 | 应用未获得该能力 | 开通相关能力 |
| 200 | 28003017 | quota已用完 | 联系平台处理 |
| 200 | 28001019 | 应用该能力已被封禁 | 该能力被封禁,联系平台处理 |
| 200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
| 200 | 10000 | 参数错误 | 参数不符合规范。请根据提示检查参数。 |
| 200 | 13000 | 系统错误,请重试 | 内部错误,重试可解决 |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 | |
| 200 | 3000001 | 以实际错误信息为准 |
