验券准备
收藏接口说明
抖音团购券码的核销, 需要先调用本接口, 查询订单的券列表，选择要验的券，再调用验券接口，核销券码。
- 抖音团购券码的核销，每次都需要先调用本接口，优先查询订单的券列表，选择要验的券，拿到加密券码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/?can_verify=1&encrypted_data=33nMZQnQBi&code=l4VdKO4kNu&poi_id=kYJ5YWnu7B&account_id=r9WZrtudc2' \ --header 'access-token: 0801121846735352506a356a6' \ --header 'content-type: application/json' \
响应参数
Body展开全部子属性
data必填Struct
展开子属性
extra必填Struct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202603261612429DE7B6985AA22E076D98", "now": 1774512764 }, "data": { "certificates_v2": [ { "expire_time": 6146957690642718000, "pay_bill_info": { "bill_total_amount": 1446249435766091500, "bill_amount": 8028804924761257000 }, "use_time_info": { "use_time_type": 1, "time_period_list": [ { "start_time": "700L9Ofb2r", "end_time": "5TewoJjUsG", "end_time_is_next_day": false } ] }, "benefit_card_info": { "left_amount": { "payment_discount_amount": 3102559194543102500, "provider_discount_amount": 5797149680071297000, "benefit_amount": 5578413881285729000, "pay_amount": 7484061354406795000, "total_amount": 107162186172948050, "merchant_discount_amount": 5818106585890847000, "platform_discount_amount": 3035340283405208000, "brand_discount_amount": 8218238857527338000, "principal_amount": 550283804770957060 }, "total_amount": { "platform_discount_amount": 8558101468508770000, "provider_discount_amount": 6235298212617212000, "benefit_amount": 820013143705160000, "pay_amount": 2570413525588285000, "total_amount": 6862545615371279000, "merchant_discount_amount": 1466618257739139300, "principal_amount": 4640395046931525000, "payment_discount_amount": 8452968266413752000, "brand_discount_amount": 7424224162153322000 } }, "encrypted_code": "PFX8Bcy5Ix", "start_time": 1064048380775235100, "period_card": { "period_type": 1 }, "code": "f9bB0p1TcA", "deduction_info_list": [ { "source_payment_discount_amount": 1113464156958384500, "source_amount": 3193343798919650000, "source_certificate_id": "BlQYOPwG4W", "source_sku_name": "lU9h1ZVu3m", "groupon_type": 1, "source_platform_discount_amount": 3154275076284984300, "source_order_id": "DpO2LllxCi", "source_brand_discount_amount": 4972882150646494000, "source_sku_id": 2335458859935820300, "source_user_pay_amount": 222811831343870500, "source_provider_discount_amount": 2071227099839739600, "source_item_order_id": "qaUVYLM6pz", "source_certificate_code": "l7j1dBX2Y8", "is_one_time_buy": false, "voucher_type": 1, "source_selling_price": 7209034762707649000, "source_merchant_discount_amount": 2691416543670976500 } ], "sku": { "account_id": "XPDa0cCDo6", "product_id": "mwCMKsoOMP", "sold_start_time": 1991701158690639000, "market_price": 5552540616211671000, "title": "gLmD5G30xk", "voucher_type": 1, "third_sku_id": "xOmHw7Hr8K", "sku_id": "ZoodLjtc4D", "product_attr": { "qSyZFZJFRF": "AnJc0mIPQF" }, "product_out_id": "ao6Qgee7Us", "sku_out_id": "52SOgVe254", "suplier_product_out_id": "D2YwKuGLC0", "groupon_type": 1 }, "additional_map": { "1": "9jspOTGlnc" }, "verify_records": [ { "poi_id": 5607672856597728000, "benefit_amount": { "merchant_discount_amount": 6534616770478700000, "brand_discount_amount": 6560751007578950000, "platform_discount_amount": 1295109319127561000, "pay_amount": 470540693830159740, "provider_discount_amount": 1462428044897669000, "payment_discount_amount": 2419403075633054000, "principal_amount": 19736297248799224, "total_amount": 937867401506077400, "benefit_amount": 8298218223436845000 }, "can_cancel": false, "verify_type": 1, "times_card_serial_num": 6194433872988535000, "certificate_id": "41We7kErZj", "extra": { "open_order_id": "amtsA048R0" }, "verify_id": "lBbmP04RWi", "verifier_unique_id": "C9OZWHJJmO", "verify_time": 2409996982320014000 } ], "not_available_time_info": { "can_no_use_date": [ { "start_time": 2742412338885633500, "end_time": 2372166456460069400 } ], "fulfil_enable": false, "can_no_use_week_day": [ 7146558656529326000 ] }, "not_available_poi_list": [ "g0e4DLSpUh" ], "time_card": { "times_count": 6566806650989370000, "times_used": 2075943550456386600, "serial_amount_list": [ { "amount": { "pay_amount": 768586301059876600, "payment_discount_amount": 8709501823837118000, "coupon_pay_amount": 1179852017998558500, "platform_discount_amount": 2774363537569494500, "original_amount": 5668815438939751000, "brand_ticket_amount": 8059388139548343000, "list_market_amount": 5469630899436715000, "origin_list_market_amount": 209981449031788670, "merchant_ticket_amount": 4410188959502629400, "original_currency": "ipS2qfL6JC" }, "serial_numb": 6240008677521782000 } ], "time_card_type": 1 }, "used_status_type": 1, "status": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 2840855905272659500, "time_type": 1 } ] }, "book_info": { "book_product_number": 8932401961180111000, "verify_amount": 8724687422169565000, "book_poi_id": "b9kAXWQOHn" }, "cancel_verify_records": [ { "verify_id": "SuZ11iQhiy", "can_cancel": false, "verifier_unique_id": "0ZZr2JcBn0", "extra": { "open_order_id": "9nfU5eUcs0" }, "times_card_serial_num": 8803098264392099000, "benefit_amount": { "platform_discount_amount": 3493346981421952000, "brand_discount_amount": 5370908680448358000, "total_amount": 3605524017797437400, "payment_discount_amount": 8568542563616173000, "principal_amount": 5148087314098683000, "provider_discount_amount": 3686343132070065000, "benefit_amount": 3186616664525501400, "pay_amount": 7592269872637843000, "merchant_discount_amount": 3607651524008412000 }, "verify_time": 8701764197647477000, "verify_type": 1, "poi_id": 7508152676551748000, "certificate_id": "BdAEO2ff4P" } ], "amount": { "brand_ticket_amount": 6884103342288333000, "merchant_ticket_amount": 3369984732185991700, "original_currency": "3iazL4jpb3", "payment_discount_amount": 4287775787155468000, "list_market_amount": 109812465895606260, "pay_amount": 8035170831996424000, "original_amount": 1968160242350240000, "platform_discount_amount": 7650932829432498000, "origin_list_market_amount": 8985416407997635000, "coupon_pay_amount": 1092633818968385400 }, "can_verify_status": 1, "reserve_info": { "order_reserve_user_info_list": [ { "phone": "y7m4tBJkSr", "credential_numb": "OjwbBuerT4", "credential_type": 1, "name": "hWw9nqV4r5" } ] }, "certificate_id": 4083398742544329000, "verify": { "verifier_unique_id": "OJ3st35d84", "certificate_id": "plHF2oNJrI", "extra": { "open_order_id": "GCOZJj4Y51" }, "can_cancel": false, "poi_id": 2596983022311161000, "verify_id": "Hr17znQXWy", "verify_time": 5218684362027862000, "times_card_serial_num": 3648170964558230500, "benefit_amount": { "benefit_amount": 2965396649745912000, "pay_amount": 2227593301775693600, "provider_discount_amount": 3746876157657586000, "principal_amount": 4973732380231823000, "merchant_discount_amount": 4511722465750054000, "platform_discount_amount": 3233611982984701000, "brand_discount_amount": 5220393841735350000, "payment_discount_amount": 6445347953707366000, "total_amount": 5616521246500006000 }, "verify_type": 1 }, "off_peak_discount_info": { "has_off_peak_discount": false, "off_peak_time_range": [ { "start_time": 7440749314621222000, "end_time": 7919991075356609000, "daily_time_range_list": [ { "end_time_is_next_day": false, "start_time": "Nobgoyp5BU", "end_time": "EU1OtmVEhX" } ], "week_day_list": [ 1 ] } ], "idle_time_limit_type": 1 }, "buyer_reserve_info": { "credential_numb": "vxIjc9oyHd", "credential_type": 9102068629019870000, "name": "8N92IwTG9I", "enc_credential_numb": "rSwW5AgE1f", "enc_name": "pADSnkiApt" }, "dynamic_code_info": { "code_expire_time": "8HdciLSSrf" } } ], "verify_token": "VNGa2LHFHM", "certificates": [ { "not_available_poi_list": [ "mAuv6W4I3B" ], "book_info": { "verify_amount": 5169280888019889000, "book_poi_id": "7xCHhMIbmt", "book_product_number": 3398057709678443000 }, "time_card": { "times_used": 1140894445332026400, "serial_amount_list": [ { "serial_numb": 4128842639174901000, "amount": { "platform_discount_amount": 826373345237807000, "origin_list_market_amount": 1440107067527329800, "merchant_ticket_amount": 316519964334657340, "coupon_pay_amount": 8135722794448968000, "list_market_amount": 7764328854961032000, "original_currency": "NdoWFBKa8g", "brand_ticket_amount": 7540590889104980000, "original_amount": 926991170614307800, "pay_amount": 1992678472967962600, "payment_discount_amount": 3422977315073137700 } } ], "time_card_type": 1, "times_count": 1001911666352272300 }, "encrypted_code": "CS7nmC5Izx", "sku": { "market_price": 6964382924350552000, "sold_start_time": 8376115743834289000, "voucher_type": 1, "groupon_type": 1, "third_sku_id": "rjJThCKcrJ", "product_out_id": "4SkixEgqfR", "sku_out_id": "s1xnooQRsE", "title": "Y8XO1iNK8Q", "product_attr": { "n5Rjkm5qDl": "nWXw9S2i2y" }, "sku_id": "1a4JzBcyMB", "suplier_product_out_id": "482rgxpGum", "account_id": "YvHXbQUHjt", "product_id": "Rgc8zoHsq7" }, "not_available_time_info": { "fulfil_enable": false, "can_no_use_week_day": [ 4530402386313654300 ], "can_no_use_date": [ { "end_time": 6888827455335660000, "start_time": 4232947986822658600 } ] }, "additional_map": { "1": "a9yPBuNLGI" }, "deduction_info_list": [ { "source_sku_id": 1172354228734681000, "source_user_pay_amount": 403379282739837400, "groupon_type": 1, "source_platform_discount_amount": 6787980564846816000, "source_sku_name": "4Vlc8CMHE1", "source_amount": 8423198150160571000, "source_order_id": "30dKVuuobw", "source_brand_discount_amount": 3121871581783291000, "source_item_order_id": "jAdeWCry9j", "source_certificate_code": "1Ds2n8ImHm", "voucher_type": 1, "source_payment_discount_amount": 2001335875411211500, "source_certificate_id": "NjIefXz9GK", "source_selling_price": 4953261705268655000, "is_one_time_buy": false, "source_provider_discount_amount": 5908186235530059000, "source_merchant_discount_amount": 8622532431816402000 } ], "start_time": 6872528879946958000, "benefit_card_info": { "total_amount": { "benefit_amount": 7413603034332184000, "payment_discount_amount": 3418165937450114000, "platform_discount_amount": 2842359072667548700, "total_amount": 2442799361241693700, "brand_discount_amount": 5050724562849026000, "merchant_discount_amount": 280963250973771170, "provider_discount_amount": 2219425156609579500, "pay_amount": 3128117718389518300, "principal_amount": 8026898370465289000 }, "left_amount": { "provider_discount_amount": 7318027228339513000, "platform_discount_amount": 8484178281652112000, "brand_discount_amount": 2359048929343088000, "benefit_amount": 3502809574675476500, "total_amount": 420334965019638700, "pay_amount": 7663158097919516000, "payment_discount_amount": 2178419608894971100, "principal_amount": 2135060100261342000, "merchant_discount_amount": 2279577610991262500 } }, "status": 1, "off_peak_discount_info": { "has_off_peak_discount": false, "off_peak_time_range": [ { "daily_time_range_list": [ { "end_time": "SsJmlSvpOa", "end_time_is_next_day": false, "start_time": "1GD3zFE2si" } ], "week_day_list": [ 1 ], "start_time": 187139300470622880, "end_time": 6504266394297392000 } ], "idle_time_limit_type": 1 }, "dynamic_code_info": { "code_expire_time": "WLJhOYNsRP" }, "expire_time": 3251318113422796000, "code": "le4NnGPML4", "verify": { "benefit_amount": { "benefit_amount": 6783063249546072000, "pay_amount": 2164539525326655000, "merchant_discount_amount": 4861925485449796000, "platform_discount_amount": 3508747310292302300, "provider_discount_amount": 61204838310204344, "payment_discount_amount": 6383091308823931000, "total_amount": 5700952812093806000, "principal_amount": 9167951291688889000, "brand_discount_amount": 984261682784329300 }, "verify_type": 1, "can_cancel": false, "verify_id": "9tT13wQ5lJ", "times_card_serial_num": 1021661201400987000, "certificate_id": "xIm4p3CJ8D", "verifier_unique_id": "4hm5YNge8m", "extra": { "open_order_id": "F9IQHUhJRu" }, "verify_time": 2907419245361427500, "poi_id": 5577420363654542000 }, "use_time_info": { "use_time_type": 1, "time_period_list": [ { "end_time": "WEp4qQVHbl", "end_time_is_next_day": false, "start_time": "dMF8QGL310" } ] }, "certificate_id": 7172911808142448000, "can_verify_status": 1, "buyer_reserve_info": { "enc_name": "W1O7rwqODY", "credential_numb": "MxeO0OW72s", "credential_type": 1118795790600639100, "name": "rjKHcqvPJL", "enc_credential_numb": "fWmNZg7WmK" }, "used_status_type": 1, "verify_records": [ { "benefit_amount": { "platform_discount_amount": 2426965942009203700, "brand_discount_amount": 5836562862346371000, "provider_discount_amount": 3972618428071783400, "total_amount": 7255131648902539000, "pay_amount": 825031240709588400, "merchant_discount_amount": 5935163703781118000, "payment_discount_amount": 8812349189815647000, "benefit_amount": 2635856489008613000, "principal_amount": 5217306280720935000 }, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "zTKaFelEdi", "certificate_id": "22pYhT2gl6", "poi_id": 1638842185871195100, "times_card_serial_num": 3909510732376452000, "verify_id": "lO0g4Akpii", "verify_time": 8737981441104022000, "extra": { "open_order_id": "vwLSECiqN9" } } ], "amount": { "list_market_amount": 3473525005014891000, "original_currency": "kq8On2y2Hz", "merchant_ticket_amount": 1549909244994984000, "brand_ticket_amount": 3055141113865334300, "pay_amount": 8087213860082626000, "platform_discount_amount": 5767443177305363000, "original_amount": 3920866037173929500, "payment_discount_amount": 3489076228271802400, "coupon_pay_amount": 1706841949942037800, "origin_list_market_amount": 8773146924162549000 }, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time_type": 1, "time": 1848082345174424800 } ] }, "period_card": { "period_type": 1 }, "pay_bill_info": { "bill_amount": 2422261623740064000, "bill_total_amount": 5966519530454921000 }, "cancel_verify_records": [ { "verify_time": 9024807666621487000, "verify_type": 1, "benefit_amount": { "platform_discount_amount": 1964065068963228400, "pay_amount": 1110707275528204300, "provider_discount_amount": 3689087887658126300, "principal_amount": 6151042205212889000, "payment_discount_amount": 7315945060803859000, "merchant_discount_amount": 5113545625743394000, "benefit_amount": 2429715576782307300, "brand_discount_amount": 1360625020663561500, "total_amount": 6146122939726165000 }, "times_card_serial_num": 2508952494187266000, "verifier_unique_id": "BOLtMfIwNY", "verify_id": "g7vKxLWpeJ", "certificate_id": "s5eUicwWEH", "can_cancel": false, "extra": { "open_order_id": "OeRPgf5LNw" }, "poi_id": 2144400229664124700 } ], "reserve_info": { "order_reserve_user_info_list": [ { "credential_type": 1, "name": "dtgqj7Yb3n", "phone": "fdIv2jMpO6", "credential_numb": "OdyWQ3m6zc" } ] } } ], "order_id": "yv5kK3EKZJ", "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 | 请求过于频繁，请稍后再试 | 重试解决 |
