验券准备
接口说明
抖音团购券码的核销, 需要先调用本接口, 查询订单的券列表,选择要验的券,再调用验券接口,核销券码。
- 抖音团购券码的核销,每次都需要先调用本接口,优先查询订单的券列表,选择要验的券,拿到加密券码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=fIINO3NurF&code=4K9NF3qZZY&poi_id=K77fU7ZinU&account_id=rPKwMmwLuQ' \ --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": "202511261635492CE1C62307BB45BACFF1", "now": 1764146151 }, "data": { "certificates_v2": [ { "status": 1, "expire_time": 4189624728166322000, "deduction_info_list": [ { "source_certificate_code": "SxgQ1WYWoQ", "source_platform_discount_amount": 5603397886223939000, "source_sku_id": 3934260994503104000, "groupon_type": 1, "source_user_pay_amount": 6989606550406799000, "source_certificate_id": "Juq03LCEaR", "source_item_order_id": "sTEKSSbzsN", "source_merchant_discount_amount": 7263470952936311000, "source_provider_discount_amount": 8584730530880489000, "source_selling_price": 2186503859920824300, "source_brand_discount_amount": 3446190105315080000, "voucher_type": 1, "source_payment_discount_amount": 2004031864300591600, "source_order_id": "QLYe0k0lxM", "source_amount": 8447390547346440000 } ], "period_card": { "period_type": 1 }, "pay_bill_info": { "bill_total_amount": 1860088006796932400, "bill_amount": 2953337597273925600 }, "benefit_card_info": { "left_amount": { "pay_amount": 6686026963531087000, "platform_discount_amount": 5975503412046742000, "brand_discount_amount": 9001779196673584000, "payment_discount_amount": 5892733084743331000, "provider_discount_amount": 1972874942669402600, "total_amount": 4131903458168307700, "benefit_amount": 7827438514416126000, "principal_amount": 3581537646849783000, "merchant_discount_amount": 7129761315723744000 }, "total_amount": { "benefit_amount": 8194256744894818000, "merchant_discount_amount": 3978798703326101500, "provider_discount_amount": 7715082796225012000, "payment_discount_amount": 2538832386465134000, "platform_discount_amount": 2983539106421635600, "brand_discount_amount": 2089889651604800300, "total_amount": 2776165254625610000, "principal_amount": 2010781799392726500, "pay_amount": 435553785706589400 } }, "time_card": { "times_count": 9143444721134068000, "times_used": 5811238885940674000, "serial_amount_list": [ { "serial_numb": 2144167374933994800, "amount": { "list_market_amount": 1571754510727207700, "pay_amount": 4354406771321457700, "platform_discount_amount": 6732332598566094000, "original_amount": 1144728713078307700, "merchant_ticket_amount": 5522176372421433000, "payment_discount_amount": 8040827675817388000, "origin_list_market_amount": 1221069714551503000, "brand_ticket_amount": 6683277949654649000, "original_currency": "Ph0f9LzWCc", "coupon_pay_amount": 7533946694827523000 } } ], "time_card_type": 1 }, "can_verify_status": 1, "certificate_id": 6081500828542786000, "code": "9hAqFAeRfb", "encrypted_code": "4VUxL3SHOX", "use_time_info": { "use_time_type": 1, "time_period_list": [ { "start_time": "ujkgsmMUK7", "end_time": "pr3LFjd1xH", "end_time_is_next_day": false } ] }, "verify": { "times_card_serial_num": 3109903694335130600, "verify_id": "l5gNxiAUmV", "certificate_id": "nEnjaSAyDc", "verify_time": 6621360957565749000, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "K6MFOOsPVG", "poi_id": 7273255591969037000 }, "sku": { "sold_start_time": 548789777887364600, "title": "IVWNVWbvzD", "sku_id": "a1napfSZSP", "suplier_product_out_id": "4wTYiAqypC", "market_price": 4266949775350928400, "product_out_id": "BCpuFIKrSw", "groupon_type": 1, "sku_out_id": "6FkN102UGC", "voucher_type": 1, "product_id": "1miaCOUCxP", "third_sku_id": "AnaW43VtV2", "account_id": "J9hsUY33HQ" }, "used_status_type": 1, "not_available_time_info": { "can_no_use_week_day": [ 4349890759743435000 ], "can_no_use_date": [ { "end_time": 630608860447660700, "start_time": 1458639026422972200 } ], "fulfil_enable": false }, "not_available_poi_list": [ "5iDge009h7" ], "reserve_info": { "order_reserve_user_info_list": [ { "name": "NkVCUeVAmX", "phone": "QKdyaH8e8Y", "credential_numb": "rhaYymmb76", "credential_type": 1 } ] }, "amount": { "list_market_amount": 1788337529901170000, "original_amount": 6287310374991531000, "pay_amount": 5094122789087703000, "original_currency": "eJDrchfjQ5", "coupon_pay_amount": 5638585652348054000, "platform_discount_amount": 7176364026683009000, "origin_list_market_amount": 6100206407116804000, "brand_ticket_amount": 6720308395795899000, "merchant_ticket_amount": 6312472549620120000, "payment_discount_amount": 1051968820878907500 }, "additional_map": { "1": "kEygLgRH4h" }, "buyer_reserve_info": { "credential_numb": "dNw264HfQE", "credential_type": 6052331575797295000, "name": "yMsUi28YgQ" }, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time_type": 1, "time": 2966514684182386700 } ] }, "start_time": 3756094349368321000, "book_info": { "book_poi_id": "4A2RX8cJ1o", "book_product_number": 1493522050047400400, "verify_amount": 8296767644155363000 }, "verify_records": [ { "certificate_id": "nEQDZfctUx", "verify_time": 7025369034287332000, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "pcLYsDacYS", "poi_id": 6725627566744686000, "times_card_serial_num": 8705835505259841000, "verify_id": "wmPJUFZYxP" } ], "off_peak_discount_info": { "idle_time_limit_type": 1, "has_off_peak_discount": false, "off_peak_time_range": [ { "start_time": 5772790939594430000, "end_time": 4664769402313362000, "daily_time_range_list": [ { "end_time_is_next_day": false, "start_time": "47D9EHaoxv", "end_time": "1TiLyQ99Tq" } ], "week_day_list": [ 1 ] } ] } } ], "verify_token": "ueCLhns9HN", "certificates": [ { "off_peak_discount_info": { "idle_time_limit_type": 1, "has_off_peak_discount": false, "off_peak_time_range": [ { "daily_time_range_list": [ { "start_time": "2X6vs3a0sw", "end_time": "h2Oj2nUb0M", "end_time_is_next_day": false } ], "week_day_list": [ 1 ], "start_time": 6066006694094220000, "end_time": 8474324423517966000 } ] }, "buyer_reserve_info": { "credential_type": 7681403205937011000, "name": "Kt59dM09kc", "credential_numb": "if1Pelg0rU" }, "encrypted_code": "wjAScIrOfv", "book_info": { "book_poi_id": "C52fllGxN3", "book_product_number": 4854549943542064000, "verify_amount": 4379955867661217000 }, "reserve_info": { "order_reserve_user_info_list": [ { "name": "i2Bb1TlZ4H", "phone": "HlsQPr3WqT", "credential_numb": "msA4JasWJ5", "credential_type": 1 } ] }, "sku": { "third_sku_id": "9hpi2DUh7y", "account_id": "Ihshg7KYg7", "market_price": 8759962015514217000, "product_id": "eYtljjJIBX", "sold_start_time": 9067089788134674000, "title": "FJdVCMKVgv", "groupon_type": 1, "sku_out_id": "lv120VHN5S", "suplier_product_out_id": "N4p5mGqCod", "sku_id": "9ocIiSVyG8", "product_out_id": "gBPlG3vIVt", "voucher_type": 1 }, "certificate_id": 4493522732966944300, "code": "bnQY0ONBHW", "use_time_info": { "use_time_type": 1, "time_period_list": [ { "start_time": "v0JZXXEFUn", "end_time": "YRwlyrJxj7", "end_time_is_next_day": false } ] }, "verify": { "verify_id": "pZWSTmid7f", "certificate_id": "HpWDVGR2Vy", "verify_time": 847430786691000700, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "xZeDKPNiK8", "poi_id": 5816254030466656000, "times_card_serial_num": 8252450662359120000 }, "start_time": 8897323378315062000, "not_available_time_info": { "can_no_use_date": [ { "end_time": 3754449572043433000, "start_time": 2051301221175319600 } ], "fulfil_enable": false, "can_no_use_week_day": [ 5956124138550313000 ] }, "additional_map": { "1": "Kp2mE3BvjM" }, "not_available_poi_list": [ "ew1LGfKATB" ], "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 391795217954452400, "time_type": 1 } ] }, "can_verify_status": 1, "pay_bill_info": { "bill_total_amount": 6735753010215159000, "bill_amount": 8199917873832151000 }, "amount": { "platform_discount_amount": 2900873860326896600, "origin_list_market_amount": 6019109169894569000, "payment_discount_amount": 3063017755479573000, "original_currency": "TfozHlQUiV", "pay_amount": 6483287204540399000, "original_amount": 1366413928624629200, "coupon_pay_amount": 545423320304978900, "list_market_amount": 1074911841374646800, "merchant_ticket_amount": 606386052338101100, "brand_ticket_amount": 8297074349270703000 }, "expire_time": 6528435422333984000, "status": 1, "deduction_info_list": [ { "source_payment_discount_amount": 2241609086686289000, "source_order_id": "I85gehXN69", "source_merchant_discount_amount": 6314969755454652000, "source_platform_discount_amount": 4160295574796484000, "source_certificate_id": "hjU3A1Rcdl", "source_amount": 4263374826471001000, "source_provider_discount_amount": 3015565077995031600, "source_sku_id": 2590985674892519000, "source_item_order_id": "HeI6Bac6jy", "groupon_type": 1, "source_selling_price": 4984625775983505000, "source_brand_discount_amount": 4102529598456806000, "source_user_pay_amount": 8103797143804649000, "voucher_type": 1, "source_certificate_code": "kmIlXLye3Z" } ], "verify_records": [ { "certificate_id": "o2BMgHe93T", "verify_time": 3398710366250303000, "can_cancel": false, "verify_type": 1, "verifier_unique_id": "cb8P3bscqZ", "poi_id": 2341684093764522500, "times_card_serial_num": 5962661276577507000, "verify_id": "BHfYSoxQlR" } ], "benefit_card_info": { "total_amount": { "principal_amount": 3097077228169314300, "pay_amount": 8754059731595813000, "total_amount": 2035452717242877400, "benefit_amount": 3428639251450370600, "platform_discount_amount": 565948058818209300, "merchant_discount_amount": 5204928235293079000, "brand_discount_amount": 8508189448148752000, "provider_discount_amount": 1308062920407126500, "payment_discount_amount": 4727729189862556000 }, "left_amount": { "total_amount": 4032476745432265700, "payment_discount_amount": 5944167222482082000, "pay_amount": 2647722092726825500, "principal_amount": 9145297323244104000, "platform_discount_amount": 3486515529444336000, "benefit_amount": 5274288584677181000, "provider_discount_amount": 7187967193524738000, "merchant_discount_amount": 5991251191666095000, "brand_discount_amount": 3273412751387339300 } }, "used_status_type": 1, "period_card": { "period_type": 1 }, "time_card": { "times_used": 7440076653052417000, "serial_amount_list": [ { "serial_numb": 4939999718751586000, "amount": { "brand_ticket_amount": 4199024742328889300, "pay_amount": 8067447500928372000, "coupon_pay_amount": 8217759008480255000, "merchant_ticket_amount": 4748601780387851000, "list_market_amount": 6292479631806147000, "payment_discount_amount": 4425299391456151000, "original_currency": "E98tFv04JH", "platform_discount_amount": 4951959470021088000, "origin_list_market_amount": 8411215294728604000, "original_amount": 3989797440071258000 } } ], "time_card_type": 1, "times_count": 3024544860379604000 } } ], "order_id": "EIOGCjwPSA", "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 | 3000001 | 请求过于频繁,请稍后再试 | 重试解决 |
| 200 | 3000001 | 以实际错误信息为准 | |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 | |
| 200 | 3000002 | 以实际错误信息为准 | |
| 200 | 5000009 | 实名信息查询失败,请重试查询 |
