券状态查询
接口说明
支持对抖音码团购、代金券、次卡、储值卡、周期卡、预约品、提货券、惠享卡等全品类券码进行状态查询;常用于核销异常排查、券状态查询等场景。
使用限制
SLA:支持的最大QPS:35;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/fulfilment/certificate/get/ |
| HTTP Method | GET |
| Scope | life.capacity.fulfilment |
| 权限要求 | 团购核销 1.需要申请权限 路径:抖音开放平台-开发者平台/服务 商平台>控制台>应用详情>解决方案 2.需要商家授权,路径:抖音来客>店铺管理>第三方应用授权 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Query
encrypted_code必填String
验券准备接口返回的加密券码
(传参前需要先进行URL编码,注意不要有空格,请求参数 encrypted_code 必须取自「验券准备」接口的实时返回值,不接受券码明文)
account_idString
核销商户根账户ID(云连锁场景接入需传入,其余场景可不传)
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/fulfilment/certificate/get/?account_id=4VhNVEsJwE&encrypted_code=GzXstO10eU' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
data必填Struct
团购券的信息
展开子属性
extra必填Struct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "certificate": { "sku": { "product_out_id": "LsLkteLsg3", "voucher_type": 1, "sku_id": "g0g0fN93U1", "suplier_product_out_id": "bpW9iKVUss", "title": "GAWDDQj0V7", "third_sku_id": "ZQGD1h9Kef", "product_id": "TKnoWmiTWQ", "groupon_type": 1, "market_price": 1261493919348368100, "product_attr": { "Y5uUbyB8VC": "VfWaPvJnn1" }, "sku_out_id": "gSNM7A9cOq", "sold_start_time": 2761466945095798300, "account_id": "2jB59uzYNE" }, "verify_records": [ { "verifier_unique_id": "DDO4s4W2Fz", "verify_time": 2964707289539249700, "poi_id": 6071995947459439000, "extra": { "open_order_id": "n0J0qnvKdZ" }, "verify_id": "yk1FyWaRHh", "certificate_id": "VDVFuQRfm6", "benefit_amount": { "principal_amount": 2229395549694598700, "platform_discount_amount": 3876398019864388000, "total_amount": 5090188120315111000, "pay_amount": 2228915983317538000, "benefit_amount": 5368732387629597000, "provider_discount_amount": 7812930023039368000, "payment_discount_amount": 629071873334150300, "brand_discount_amount": 5688595043172849000, "merchant_discount_amount": 1510759051570140000 }, "can_cancel": false, "verify_type": 1, "times_card_serial_num": 9070148156609277000 } ], "use_time_info": { "time_period_list": [ { "end_time": "MlN2jeR2Qg", "end_time_is_next_day": false, "start_time": "OqNyCygDkB" } ], "use_time_type": 1 }, "certificate_id": 7868667644452886000, "time_card": { "times_count": 6982395894036219000, "times_used": 3371862873780541000, "serial_amount_list": [ { "serial_numb": 1878816203243308000, "amount": { "brand_ticket_amount": 4125578467617934000, "original_amount": 6316373344987608000, "merchant_discount_detail_list": [ { "discount_id": "izNzvdEHmZ", "discount_name": "Vi6C5av5td", "discount_amount": 2384107535312961000 } ], "platform_discount_amount": 5435443626007398000, "origin_list_market_amount": 7146076010245195000, "original_currency": "jT4omv7hZE", "pay_amount": 7319367781026467000, "coupon_pay_amount": 3077128913788463600, "list_market_amount": 80878778987425360, "merchant_ticket_amount": 3785929635920065500, "payment_discount_amount": 8646906306726901000 } } ], "time_card_type": 1 }, "period_card": { "period_type": 1 }, "book_info": { "verify_amount": 2584823363701657000, "book_poi_id": "EA1wTcRiir", "book_product_number": 8814955661205288000 }, "pay_bill_info": { "bill_total_amount": 4579152275028691000, "bill_amount": 779448980301221400, "order_source": 1 }, "expire_time": 7978673795549493000, "benefit_card_info": { "left_amount": { "total_amount": 2306589179998620700, "platform_discount_amount": 6099412850438621000, "principal_amount": 32715420657157932, "benefit_amount": 1817030411492765000, "merchant_discount_amount": 2179478733909800400, "brand_discount_amount": 8300239341913639000, "payment_discount_amount": 8038663808033820000, "pay_amount": 8611946570130953000, "provider_discount_amount": 139428623765143900 }, "total_amount": { "principal_amount": 2178245293920063500, "payment_discount_amount": 1708469392397770200, "total_amount": 4540303925184832000, "benefit_amount": 8531501848767389000, "provider_discount_amount": 2645236371902833000, "merchant_discount_amount": 3019216751258111500, "platform_discount_amount": 5419494584435903000, "brand_discount_amount": 3742344811769835000, "pay_amount": 6411382198976611000 } }, "amount": { "merchant_ticket_amount": 6785779549630269000, "merchant_discount_detail_list": [ { "discount_name": "XpHnY6ao4o", "discount_amount": 5867551482201429000, "discount_id": "xqFqcmwpTn" } ], "brand_ticket_amount": 8070601356136590000, "origin_list_market_amount": 5544284796365017000, "original_amount": 3328335106971166000, "original_currency": "Ydpr9ATtfv", "payment_discount_amount": 6047926271780174000, "pay_amount": 535312847630402560, "list_market_amount": 2216728230527219500, "coupon_pay_amount": 1280595665955581400, "platform_discount_amount": 5573348785387151000 }, "used_status_type": 1, "can_verify_status": 1, "not_available_time_info": { "can_no_use_week_day": [ 5681583248495654000 ], "can_no_use_date": [ { "end_time": 4057277249293315600, "start_time": 6693363007313352000 } ], "fulfil_enable": false }, "not_available_poi_list": [ "Mp48teGcgP" ], "verify": { "verify_id": "l7LwyXqVgi", "verifier_unique_id": "cjyWpFoEAZ", "benefit_amount": { "platform_discount_amount": 797647609910083700, "payment_discount_amount": 8775064203313882000, "total_amount": 5760950509588884000, "pay_amount": 6606342077993644000, "provider_discount_amount": 6746119589251425000, "principal_amount": 1535808434687484700, "brand_discount_amount": 2598011510180335600, "merchant_discount_amount": 8836712373955871000, "benefit_amount": 7282001606314533000 }, "verify_time": 490087140996872700, "verify_type": 1, "certificate_id": "q9QB4KYnOh", "poi_id": 864808200883523500, "can_cancel": false, "extra": { "open_order_id": "k8aDiw2Ydp" }, "times_card_serial_num": 1631960432134428400 }, "start_time": 3524183443721750500, "deduction_info_list": [ { "voucher_type": 1, "source_order_id": "EmPFxKpAxW", "source_brand_discount_amount": 4794472118686298000, "source_sku_name": "QapGbKso8J", "source_merchant_discount_amount": 3718025900651038000, "source_provider_discount_amount": 8992383156890270000, "source_payment_discount_amount": 7003671537280211000, "source_certificate_id": "XTAsAUsjyp", "source_selling_price": 212869052825604450, "groupon_type": 1, "source_amount": 3358902073870466600, "source_user_pay_amount": 5316068291433238000, "source_sku_id": 699608252871266600, "source_platform_discount_amount": 954289111239228000, "order_source": 1, "source_certificate_code": "bl9votkoFi", "is_one_time_buy": false, "source_item_order_id": "8WHOaiO6qs" } ], "buyer_reserve_info": { "enc_name": "t1ApGFvCDt", "credential_numb": "YKBzMW3Tsv", "credential_type": 1897503556236223700, "name": "yU2swSlAnA", "enc_credential_numb": "SDEXXNkQTC" }, "additional_map": { "1": "v6HpzWjJWH" }, "code": "BfYPRQaftg", "cancel_verify_records": [ { "verify_id": "8c2X7eLhcT", "benefit_amount": { "merchant_discount_amount": 3842079599612231000, "brand_discount_amount": 3987951412823115000, "pay_amount": 1742022017839566800, "payment_discount_amount": 7836203265907375000, "provider_discount_amount": 8149435670371779000, "principal_amount": 2787856195152832500, "platform_discount_amount": 1754506706057021400, "benefit_amount": 1169220019221555700, "total_amount": 1883736744747600000 }, "can_cancel": false, "certificate_id": "j98OHTOI5P", "verifier_unique_id": "Z3b276EtkR", "poi_id": 1566147931378500600, "verify_time": 7221305720502250000, "verify_type": 1, "times_card_serial_num": 6565170822835973000, "extra": { "open_order_id": "GnxpCiGgZM" } } ], "off_peak_discount_info": { "idle_time_limit_type": 1, "has_off_peak_discount": false, "off_peak_time_range": [ { "start_time": 2485998479890727000, "end_time": 948629434892330000, "daily_time_range_list": [ { "start_time": "tJk7dA608D", "end_time": "m2ByKhZFYU", "end_time_is_next_day": false } ], "week_day_list": [ 1 ] } ] }, "dynamic_code_info": { "code_expire_time": "BIEQAYRZzn" }, "encrypted_code": "9oIaz2NFkL", "reserve_info": { "order_reserve_user_info_list": [ { "credential_numb": "YqSWtuyjJP", "credential_type": 1, "enc_name": "RHRVq84eg6", "enc_phone": "3FqGQAB2J4", "enc_credential_numb": "MLeL8ceqT2", "name": "nS0tGxAtoS", "phone": "UFFgQb8R2A" } ] }, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 4822135588650150000, "time_type": 1 } ] }, "status": 1 }, "certificate_v2": { "verify": { "extra": { "open_order_id": "qpZE2y4obT" }, "verifier_unique_id": "zkJpWBboe3", "verify_type": 1, "certificate_id": "wOAi9prLgy", "times_card_serial_num": 9077824129632598000, "verify_id": "R5c7NlYSI7", "poi_id": 7647726752448028000, "benefit_amount": { "payment_discount_amount": 7492575113834177000, "brand_discount_amount": 8432228347325459000, "provider_discount_amount": 33985313826810030, "benefit_amount": 4648416521340888000, "pay_amount": 6589880246849231000, "platform_discount_amount": 5789628664811914000, "total_amount": 7740656079633373000, "principal_amount": 7958146061457305000, "merchant_discount_amount": 7069489845100827000 }, "verify_time": 9171119284238833000, "can_cancel": false }, "verify_records": [ { "verify_id": "CQTHw2WghE", "verify_time": 5864734636746764000, "poi_id": 987630414557971600, "benefit_amount": { "payment_discount_amount": 3664738141500375000, "brand_discount_amount": 188379733744737660, "total_amount": 452330300149525000, "provider_discount_amount": 7719982377300077000, "pay_amount": 7087403967100511000, "platform_discount_amount": 7285487804469827000, "principal_amount": 4337020510633657300, "benefit_amount": 6695781447579139000, "merchant_discount_amount": 464273056088851300 }, "extra": { "open_order_id": "1AI9m1MZHm" }, "certificate_id": "DSL0uLdIIK", "verifier_unique_id": "kYj52QWvJU", "times_card_serial_num": 4308365759453692000, "can_cancel": false, "verify_type": 1 } ], "off_peak_discount_info": { "idle_time_limit_type": 1, "has_off_peak_discount": false, "off_peak_time_range": [ { "week_day_list": [ 1 ], "start_time": 6776355263904951000, "end_time": 8037565356597143000, "daily_time_range_list": [ { "start_time": "hA61HCP7os", "end_time": "VU1CI1JYVO", "end_time_is_next_day": false } ] } ] }, "amount": { "original_amount": 4637736016150329000, "pay_amount": 252068339985769470, "list_market_amount": 6201677125157937000, "merchant_ticket_amount": 6349230073011962000, "coupon_pay_amount": 3207928053474767400, "origin_list_market_amount": 2481846890732549600, "platform_discount_amount": 661209862470764400, "brand_ticket_amount": 3165391719932631600, "original_currency": "39QUyg2eO7", "payment_discount_amount": 1706980768409283000, "merchant_discount_detail_list": [ { "discount_id": "p4eWl9j3o1", "discount_name": "HqBNWf7YMI", "discount_amount": 386554321312705500 } ] }, "used_status_type": 1, "deduction_info_list": [ { "source_selling_price": 5405229459813148000, "source_brand_discount_amount": 411147136436668400, "is_one_time_buy": false, "groupon_type": 1, "source_payment_discount_amount": 5563287693270656000, "source_certificate_code": "7Z399L7PdC", "source_user_pay_amount": 8619746036083908000, "source_sku_name": "Wm5aBCT6uI", "source_item_order_id": "KeWVDPfrvx", "source_certificate_id": "QfZHVjrRnN", "order_source": 1, "source_order_id": "yDU2qV6510", "source_provider_discount_amount": 2538089230757246000, "voucher_type": 1, "source_amount": 4311077683389899300, "source_sku_id": 8924168496131680000, "source_platform_discount_amount": 8415679116516927000, "source_merchant_discount_amount": 5400726281810215000 } ], "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 1691010468308240600, "time_type": 1 } ] }, "time_card": { "time_card_type": 1, "times_count": 2892605841126949400, "times_used": 6299520240144384000, "serial_amount_list": [ { "serial_numb": 2101441031093476600, "amount": { "platform_discount_amount": 236597425831262530, "origin_list_market_amount": 526957533984905000, "coupon_pay_amount": 9006045911740522000, "original_amount": 1141839305064891600, "pay_amount": 2067559944108730400, "merchant_ticket_amount": 2928702809563760000, "brand_ticket_amount": 5494233505113002000, "payment_discount_amount": 6163904879971303000, "list_market_amount": 4628463454290137000, "merchant_discount_detail_list": [ { "discount_amount": 8423124686634538000, "discount_id": "EqQ6vUirTi", "discount_name": "FbJP5h8Bob" } ], "original_currency": "AK61vujBBu" } } ] }, "benefit_card_info": { "left_amount": { "merchant_discount_amount": 8065488819926001000, "provider_discount_amount": 8300305138069469000, "total_amount": 174251627278797120, "benefit_amount": 9162175091892147000, "pay_amount": 4570955885195155000, "payment_discount_amount": 4440117840468572000, "brand_discount_amount": 8337765651687212000, "platform_discount_amount": 6391118795885324000, "principal_amount": 581225211569692200 }, "total_amount": { "total_amount": 560472438208673200, "benefit_amount": 3976610434588983000, "pay_amount": 5246724649494045000, "payment_discount_amount": 3731083790112361000, "brand_discount_amount": 3170849153285717000, "provider_discount_amount": 7703140841463094000, "principal_amount": 8678695654364389000, "merchant_discount_amount": 2135119821295343600, "platform_discount_amount": 1950110912844369700 } }, "encrypted_code": "r5pnlfDyRl", "expire_time": 5201914912240315000, "pay_bill_info": { "bill_total_amount": 7741629256450254000, "bill_amount": 8202271838219124000, "order_source": 1 }, "period_card": { "period_type": 1 }, "use_time_info": { "use_time_type": 1, "time_period_list": [ { "end_time": "TuaKl7PRGw", "end_time_is_next_day": false, "start_time": "3PwKtUinHm" } ] }, "code": "79j4SEDfm8", "cancel_verify_records": [ { "verifier_unique_id": "fGPZUX9Cqc", "benefit_amount": { "payment_discount_amount": 7701634413715475000, "principal_amount": 8428357694159563000, "benefit_amount": 6445046820255157000, "provider_discount_amount": 650952242595595100, "pay_amount": 1069022604415753000, "merchant_discount_amount": 7559495640290675000, "platform_discount_amount": 7614323896741843000, "total_amount": 3175301816287367000, "brand_discount_amount": 2435961991236660700 }, "verify_id": "bo6uqv1GKV", "verify_type": 1, "poi_id": 1596933697679640300, "can_cancel": false, "certificate_id": "4QzKpxMubM", "times_card_serial_num": 6282013613115228000, "extra": { "open_order_id": "U2QaOfHVOJ" }, "verify_time": 1531888057488986000 } ], "sku": { "sku_out_id": "TkBkPiOswO", "voucher_type": 1, "sku_id": "W30W5U4jaK", "groupon_type": 1, "market_price": 1523804034612358400, "title": "YgJvvRLMKr", "third_sku_id": "B8xkmU2hVm", "product_attr": { "z2qSrgNjy7": "9GpYKc8KPn" }, "account_id": "FUkg5YQB7O", "product_out_id": "IzEqR1FfDn", "suplier_product_out_id": "uth3sLVTkg", "sold_start_time": 5855872825660048000, "product_id": "hzV8sXEc5f" }, "dynamic_code_info": { "code_expire_time": "8qwAWG5VV6" }, "can_verify_status": 1, "status": 1, "book_info": { "verify_amount": 960535029015167200, "book_poi_id": "PFMcwfbhYI", "book_product_number": 4815971837913760000 }, "not_available_poi_list": [ "dYl1NaRH8N" ], "buyer_reserve_info": { "enc_name": "b0S2rvXaou", "credential_numb": "5QGb8FElXR", "credential_type": 8533189099852423000, "name": "OhhwBRkiId", "enc_credential_numb": "yylybxsD89" }, "reserve_info": { "order_reserve_user_info_list": [ { "name": "jhTJhriTbP", "phone": "wQoMhj3yId", "credential_numb": "VM8iOjcKer", "credential_type": 1, "enc_name": "s3kuka4NOv", "enc_phone": "gDQzFBNcIk", "enc_credential_numb": "MqDNKpYfib" } ] }, "not_available_time_info": { "can_no_use_date": [ { "start_time": 2484809992344924700, "end_time": 4829680476210219000 } ], "fulfil_enable": false, "can_no_use_week_day": [ 7208841889134044000 ] }, "additional_map": { "1": "OgBogoWcBh" }, "start_time": 8824043076135667000, "certificate_id": 8611779872668606000 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20261104112613BE9B08654A22ED84A36A", "now": 1793762774 } }
错误码
| 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 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 3000001 | 以实际错误信息为准 | |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 |
