验券准备
接口说明
抖音团购券码的核销, 需要先调用本接口, 查询订单的券列表,选择要验的券,再调用验券接口,核销券码。
- 抖音团购券码的核销,每次都需要先调用本接口,优先查询订单的券列表,选择要验的券,拿到加密券码encrypted_code,再调用验券接口,核销券码,验券准备和验券接口的调用次数需要一一对应,如已经调用验券接口验券成功,则当前二维码会失效,无法继续使用验券准备接口,需要使用刷新的二维码再进行调用。
- 二维码扫出来是一个短链,示例:https://v.douyin.com/eHHc1ft/ (注:短链的长度不固定,不要对长度做限制或截断,结尾不一定是/),扫码后并调用本接口可返回当前订单下可用的全部券码信息,如未返回券码信息,则说明该订单此刻无可用券码。
- 对短链做 HTTP 请求。得到对应的长链接是https://www.iesdouyin.com/share/commerce/coupon/I0ZwZEZpb2U1N0pjQVZxS2NJRTFSQW5WK1c4bmxvbnNWdUQ2Wk85Y1N0eHpRUFpMMmZwNTdFM2NKeWlFNDM2QT0/?schema_type=13&object_id=I0ZwZEZpb2U1N0pjQVZxS2NJRTFSQW5WK1c4bmxvbnNWdUQ2Wk85Y1N0eHpRUFpMMmZwNTdFM2NKeWlFNDM2QT0&utm_campaign=client_scan_share&app=aweme&utm_medium=ios&tt_from=scan_share&iid=&utm_source=scan_share。
- 链接中object_id参数的值即为本接口传入的 encrypted_data 参数 I0ZwZEZpb2U1N0pjQVZxS2NJRTFSQW5WK1c4bmxvbnNWdUQ2Wk85Y1N0eHpRUFpMMmZwNTdFM2NKeWlFNDM2QT0
请仅感知链接中的 object_id 参数。其他的参数、域名、路径等信息请不要感知。以后都有优化和调整的可能。
- 定期清理过期券,在清理前可以获取到已经过期的券,用此券核销会报错。
- 该接口只返回未使用状态的券信息。
- 该接口不返回明文券码,只返回加密券码
使用限制
SLA:支持的最大QPS:200;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/fulfilment/certificate/prepare/ |
| HTTP Method | GET |
| Scope | life.capacity.fulfilment |
| 权限要求 |
|
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Query展开全部子属性
account_idString
核销商户根账户ID(云连锁/共管场景下,挂靠商户必传,其余场景可不传)
can_verifyEnum
服务商收银版本号
展开子属性
codeString
券码明文
常见于使用用户提供的券码手动输入商家后台进行验券 的场景
encrypted_data和code二选一必传,两个都不传会报错
encrypted_dataString
从二维码解析出来的标识
(传参前需要先进行URL编码,注意不要有空格)
encrypted_data和code二选一必传,两个都不传会报错
poi_idString
操作核销的抖音门店id(必传)
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/fulfilment/certificate/prepare/?code=hG8khelYgy&poi_id=pV9nbl3cxw&account_id=TWSoE6ILJL&can_verify=1&encrypted_data=bhrJb35v69' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
data必填Struct
展开子属性
extra必填Struct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20251113185541802287317106A362CD9B", "now": 1763031349 }, "data": { "verify_token": "rcobP704nw", "certificates": [ { "buyer_reserve_info": { "name": "ojxkgKIDS7", "credential_numb": "NBztoHR65E", "credential_type": 4678869364972604000 }, "expire_time": 3709311983467029500, "used_status_type": 1, "not_available_time_info": { "can_no_use_week_day": [ 5866830496801010000 ], "can_no_use_date": [ { "start_time": 1181310202767108400, "end_time": 8823659133438565000 } ], "fulfil_enable": false }, "period_card": { "period_type": 1 }, "time_card": { "times_used": 1315309622571421200, "serial_amount_list": [ { "serial_numb": 8628255553814325000, "amount": { "list_market_amount": 5282519880355836000, "original_currency": "kEiRKF04pE", "coupon_pay_amount": 921983164840969000, "platform_discount_amount": 28871962879937390, "original_amount": 8318777107110974000, "origin_list_market_amount": 7926557580562215000, "brand_ticket_amount": 8883192195249647000, "pay_amount": 7395263033942316000, "merchant_ticket_amount": 5983156833678604000, "payment_discount_amount": 5724975285195987000 } } ], "time_card_type": 1, "times_count": 3727190717024146400 }, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 2243261776642311000, "time_type": 1 } ] }, "additional_map": { "1": "w50cYUUzK6" }, "benefit_card_info": { "left_amount": { "benefit_amount": 6732038640103358000, "total_amount": 5616590538276379000, "principal_amount": 7543690430783426000 }, "total_amount": { "principal_amount": 3360915476681745000, "benefit_amount": 3900837649776529000, "total_amount": 864445711200272400 } }, "can_verify_status": 1, "sku": { "market_price": 2327969049738777600, "third_sku_id": "bXw5XCnnNy", "suplier_product_out_id": "RSrp2s4aGu", "product_out_id": "iW0652hg7f", "sku_id": "Nz4zMMQmto", "groupon_type": 1, "account_id": "5bgmcnFCeZ", "sku_out_id": "qxNQXt9xh4", "sold_start_time": 1733339029340701400, "voucher_type": 1, "product_id": "y8sj4rM5XS", "title": "Vw5kf555Mt" }, "pay_bill_info": { "bill_amount": 6556159464772491000, "bill_total_amount": 8727259872409640000 }, "use_time_info": { "use_time_type": 1, "time_period_list": [ { "start_time": "jRtqPCqy5Z", "end_time": "EoqjJOrW2e", "end_time_is_next_day": false } ] }, "status": 1, "certificate_id": 2080209111515137800, "encrypted_code": "lylqjY1vn3", "amount": { "origin_list_market_amount": 1877491840173058600, "brand_ticket_amount": 8573167487501872000, "coupon_pay_amount": 2430770686046822400, "list_market_amount": 3037573878722305500, "original_currency": "AAMwftpfMV", "original_amount": 5374781686074212000, "platform_discount_amount": 8724667654059369000, "payment_discount_amount": 7854984222871066000, "merchant_ticket_amount": 2109002303703529200, "pay_amount": 6757984664915657000 }, "start_time": 7015115562922044000, "deduction_info_list": [ { "source_sku_id": 7262262549497313000, "source_platform_discount_amount": 481272691872959100, "source_amount": 8980182869383676000, "voucher_type": 1, "source_certificate_code": "LDEURfNj1A", "source_order_id": "XqccFHcjnM", "groupon_type": 1, "source_user_pay_amount": 313526571441094600, "source_certificate_id": "FQSZNyT4r2", "source_item_order_id": "RXAXNz91yV", "source_merchant_discount_amount": 2680766407911074000 } ], "book_info": { "verify_amount": 6476007333855455000, "book_poi_id": "qtTrWPCY8Y", "book_product_number": 2376727528500388400 }, "not_available_poi_list": [ "GbBj1OnoKG" ], "code": "a3tPqIeJnl", "verify": { "poi_id": 8628155590669416000, "times_card_serial_num": 4371022965543128000, "verify_id": "O4VvrezbFo", "certificate_id": "uHtBe5mt5O", "verify_time": 3133164820282493000, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "g7knROd1vI" }, "verify_records": [ { "verify_time": 1976835584172449800, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "Hd9fJAgE6F", "poi_id": 6904091286619576000, "times_card_serial_num": 5586138546652692000, "verify_id": "GyUGUJ4S5P", "certificate_id": "gtBDqs5UCE" } ], "reserve_info": { "order_reserve_user_info_list": [ { "name": "VQqveohsvS", "phone": "6syNvSiPga", "credential_numb": "TMpYuFZNDb", "credential_type": 1 } ] }, "off_peak_discount_info": { "off_peak_time_range": [ { "week_day_list": [ 1 ], "start_time": 5949520037215905000, "end_time": 3748776330011196400, "daily_time_range_list": [ { "end_time_is_next_day": false, "start_time": "krfQejNsgt", "end_time": "k2UFMeB2li" } ] } ], "idle_time_limit_type": 1, "has_off_peak_discount": false } } ], "order_id": "Rb0zDJxCLN", "certificates_v2": [ { "deduction_info_list": [ { "voucher_type": 1, "source_user_pay_amount": 7417172523331238000, "source_sku_id": 8449529074141107000, "source_item_order_id": "MTGDMS165n", "groupon_type": 1, "source_certificate_id": "9As1lrCztl", "source_certificate_code": "gLVx8yXQME", "source_merchant_discount_amount": 289534366672907800, "source_order_id": "X2yyEuhvr6", "source_amount": 8281040201127109000, "source_platform_discount_amount": 2794723584858776000 } ], "off_peak_discount_info": { "has_off_peak_discount": false, "off_peak_time_range": [ { "start_time": 3712992813552501000, "end_time": 3813170326856280600, "daily_time_range_list": [ { "end_time": "wNXyP04kc7", "end_time_is_next_day": false, "start_time": "hfWqDtzi50" } ], "week_day_list": [ 1 ] } ], "idle_time_limit_type": 1 }, "status": 1, "advance_purchase_struct": { "time_detail": [ { "time_type": 1, "time": 4495199354099201500 } ], "purchase_type": 1 }, "buyer_reserve_info": { "credential_numb": "zWQlTOt7n0", "credential_type": 2288390817240873700, "name": "Cfy6VwFynU" }, "verify": { "times_card_serial_num": 7407073623536415000, "verify_id": "jGAz4XbdHi", "certificate_id": "BpUF6fK5i8", "verify_time": 928287970394373100, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "tstlSZ0Fan", "poi_id": 8311925755903089000 }, "reserve_info": { "order_reserve_user_info_list": [ { "name": "rIaFoWvRdn", "phone": "JeGhxMktp5", "credential_numb": "pmag7JBna1", "credential_type": 1 } ] }, "encrypted_code": "xdwWf1h8Xf", "time_card": { "time_card_type": 1, "times_count": 8404689962070603000, "times_used": 3210519943238133000, "serial_amount_list": [ { "serial_numb": 1599212954719616800, "amount": { "platform_discount_amount": 6413399749781790000, "original_amount": 8710275111646545000, "pay_amount": 8872413531063560000, "original_currency": "6nFBwTGgiu", "payment_discount_amount": 4795027232534093000, "origin_list_market_amount": 8975499044226636000, "coupon_pay_amount": 1554906749420010800, "merchant_ticket_amount": 4043517660882379300, "brand_ticket_amount": 330202643491384260, "list_market_amount": 658200954759481200 } } ] }, "use_time_info": { "use_time_type": 1, "time_period_list": [ { "start_time": "5zYrB8FOgQ", "end_time": "KA78sw6MF1", "end_time_is_next_day": false } ] }, "benefit_card_info": { "total_amount": { "total_amount": 7738532517653259000, "principal_amount": 8629270817925795000, "benefit_amount": 2822646822779171300 }, "left_amount": { "principal_amount": 969597279557451100, "benefit_amount": 3930709280391932000, "total_amount": 3438637710440551400 } }, "book_info": { "book_poi_id": "0fUL9SVNnp", "book_product_number": 6444386111384078000, "verify_amount": 8303659130629649000 }, "amount": { "merchant_ticket_amount": 5243290193438346000, "origin_list_market_amount": 7947582670994059000, "list_market_amount": 927668280423829200, "brand_ticket_amount": 3491720328719424500, "original_currency": "3Pm3PEUMP8", "payment_discount_amount": 7883089904680183000, "pay_amount": 17214708043459332, "coupon_pay_amount": 7997448684644829000, "original_amount": 4048501367158743600, "platform_discount_amount": 6280887258373830000 }, "period_card": { "period_type": 1 }, "pay_bill_info": { "bill_amount": 5718645543583777000, "bill_total_amount": 6579149285627402000 }, "expire_time": 7652484516234834000, "sku": { "third_sku_id": "tA9C6R5SjB", "account_id": "PXrrafmqgX", "sku_out_id": "9pe9SnuLFl", "groupon_type": 1, "sku_id": "nBOiAAkM4B", "title": "YPD8qY4fjw", "market_price": 7453874603731744000, "voucher_type": 1, "sold_start_time": 1879538847358232300, "suplier_product_out_id": "ucw3d2KEFY", "product_id": "bwQdTDA06r", "product_out_id": "c5RzPYkM8J" }, "verify_records": [ { "certificate_id": "bZAobKV9dN", "verify_time": 6422862123471164, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "IwA7dQBl4Y", "poi_id": 7094857707681323000, "times_card_serial_num": 7352528256553639000, "verify_id": "hxb6HLeaep" } ], "code": "ocIB5tc2Wz", "not_available_time_info": { "can_no_use_week_day": [ 5431928078382866000 ], "can_no_use_date": [ { "start_time": 6626592022526312000, "end_time": 3613481397321264000 } ], "fulfil_enable": false }, "start_time": 625573503091867300, "not_available_poi_list": [ "ZlQEE2orst" ], "additional_map": { "1": "DsD8HPnErV" }, "can_verify_status": 1, "certificate_id": 5216251808092090000, "used_status_type": 1 } ], "error_code": 0, "description": "" } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
| 200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
| 200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
| 200 | 2119001 | 参数不合法 | 更换参数 |
| 200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
| 200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
| 200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
| 200 | 3000001 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 4000001 | 根据实际业务错误返回 | 补充参数 |
| 200 | 4000002 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 5000001 | 根据实际业务错误返回 | 联系抖音处理 |
| 200 | 3000002 | 核销门店错误 | 检查核销门店重试 |
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 5000009 | 实名信息查询失败,请重试查询 | |
| 200 | 3000002 | 以实际错误信息为准 | |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 | |
| 200 | 3000001 | 以实际错误信息为准 | |
| 200 | 3000001 | 请求过于频繁,请稍后再试 | 重试解决 |
