抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 生活服务商家应用 OpenAPI SDK 总览
  • 接入前准备
  • API接口
  • 通用接口
  • 餐饮
  • 大交通
  • 酒旅
  • 综合
  • 到综团购解决方案
  • 到综团购预约解决方案
  • 综合到店提货解决方案
  • 商品查询
  • 商品发布
  • 提货券三方码交易能力
  • 提货券抖音码交易能力
  • 验券接口
  • 验券准备接口
  • 撤销核销接口
  • 券状态批量查询
  • 提货券门店变更通知Webhook
  • 到综预订解决方案
  • 线索管理解决方案
  • 丽人/汽车/家居家电交易上翻解决方案
  • 零售即送解决方案
  • 能力
  • 历史版本文档(不推荐)
  • 接口说明

    1. 提货券抖音券码的核销,每次都需要先调用本接口,优先查询订单的券列表,选择要验的券,再调用验券接口,核销券码,验券准备和验券接口的调用次数需要一一对应,如已经调用验券接口验券成功,则当前二维码会失效,无法继续使用验券准备接口,需要使用刷新的二维码再进行调用。
    1. 二维码扫出来是一个短链,示例:https://v.douyin.com/eHHc1ft/ ,扫码后并调用本接口可返回当前订单下可用的全部券码信息,如未返回券码信息,则说明该订单此刻无可用券码。
    2. 对短链做 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。
    3. 链接中object_id参数的值即为本接口传入的 encrypted_data 参数 I0ZwZEZpb2U1N0pjQVZxS2NJRTFSQW5WK1c4bmxvbnNWdUQ2Wk85Y1N0eHpRUFpMMmZwNTdFM2NKeWlFNDM2QT0

    请仅感知链接中的 object_id 参数。其他的参数、域名、路径等信息请不要感知。以后都有优化和调整的可能。

    1. 定期清理过期券,在清理前可以获取到已经过期的券,用此券核销会报错。
    2. 该接口只返回未使用状态的券信息。

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/goodlife/v1/compre_retail/fulfilment/certificate/prepare/
    HTTP Method
    GET
    Scope
    life.capacity.compre_retail_certificate_prepare
    权限要求
    提货券抖音码交易

    请求参数

    请求头
    access-token必填String
    示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
    content-type必填String
    固定值"application/json"
    Rpc-Transit-Life-AccountString

    来客商户根账户ID

    Query
    account_idString
    核销的商家账号
    codeString

    券码明文,常见用于手动输入券码核销的场景

    encrypted_data和code二选一必传,两个都不传会报错

    encrypted_dataString

    从二维码解析出来的标识,常见于用扫码枪识别二维码的场景

    encrypted_data和code二选一必传,两个都不传会报错

    poi_idString
    核销的抖音门店id
    请求示例
    curl --location --request GET 'https://open.douyin.com/goodlife/v1/compre_retail/fulfilment/certificate/prepare/?account_id=6KXaPZusNy&can_verify=1&encrypted_data=8zs8WdWyKq&code=pwY5jr91Hs&poi_id=1cDNYmfoy0' \ --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": "202611061112230848AD70732FB9F91454", "now": 1793934744 }, "data": { "verify_token": "a90DRMwpbF", "certificates": [ { "off_peak_discount_info": { "has_off_peak_discount": false, "off_peak_time_range": [ { "daily_time_range_list": [ { "end_time": "KTdnNTlaWH", "end_time_is_next_day": false, "start_time": "qQJIY4xdKV" } ], "week_day_list": [ 1 ], "start_time": 5528127372259517000, "end_time": 1517395864449220000 } ], "idle_time_limit_type": 1 }, "time_card": { "times_count": 7543414799518797000, "times_used": 8488333032185775000, "serial_amount_list": [ { "serial_numb": 337269033948896100, "amount": { "brand_ticket_amount": 3069565391824360000, "pay_amount": 7599292208340258000, "original_amount": 2771935772878717000, "original_currency": "wEqlTnmjam", "platform_discount_amount": 2157262912813262000, "payment_discount_amount": 2033061530000939000, "coupon_pay_amount": 2966144932175774700, "merchant_discount_detail_list": [ { "discount_amount": 1431850322880608000, "discount_id": "ldz7aDAKO9", "discount_name": "H6QZ9uv6i2" } ], "merchant_ticket_amount": 4490993040924614700, "list_market_amount": 3800893545150577700, "origin_list_market_amount": 1401039945840738600 } } ], "time_card_type": 1 }, "not_available_time_info": { "fulfil_enable": false, "can_no_use_week_day": [ 5270341933113654000 ], "can_no_use_date": [ { "end_time": 7265499120524430000, "start_time": 3321887767979590000 } ] }, "dynamic_code_info": { "code_expire_time": "KwoQpQ7heu" }, "benefit_card_info": { "left_amount": { "provider_discount_amount": 5213069196859226000, "principal_amount": 1152745376313022600, "platform_discount_amount": 6801488379433994000, "payment_discount_amount": 6277629588166578000, "merchant_discount_amount": 2601858466979713000, "total_amount": 799738866435366300, "benefit_amount": 6992342576830969000, "brand_discount_amount": 1782710622071802400, "pay_amount": 4869081898394265000 }, "total_amount": { "total_amount": 2601037505908047400, "merchant_discount_amount": 5973823082621096000, "brand_discount_amount": 8160701644792704000, "provider_discount_amount": 8794661198043367000, "principal_amount": 7256950125114058000, "platform_discount_amount": 6836574053351199000, "payment_discount_amount": 5348464500169941000, "pay_amount": 212024576947896480, "benefit_amount": 3189644752534494700 } }, "buyer_reserve_info": { "credential_type": 1044922569349867100, "name": "BqgcsSjsbv", "enc_credential_numb": "iFPVGOcAkm", "enc_name": "f1MRtDFlvS", "credential_numb": "IawlbBWDqI" }, "start_time": 7316932875669582000, "reserve_info": { "order_reserve_user_info_list": [ { "credential_type": 1, "enc_name": "qaNRUKe7zb", "enc_phone": "6SNm7bLCzC", "enc_credential_numb": "fpjl19ZHU4", "name": "6CrwGEBDzP", "phone": "BnISQnsIkJ", "credential_numb": "Lqrekq7f95" } ] }, "amount": { "merchant_discount_detail_list": [ { "discount_id": "EXm2yNgPDB", "discount_name": "DSbhqfCcTE", "discount_amount": 8525625505813124000 } ], "pay_amount": 2510574473192744400, "merchant_ticket_amount": 8471672419938734000, "list_market_amount": 5193085856127537000, "platform_discount_amount": 5815693465498820000, "origin_list_market_amount": 1685155710220671200, "brand_ticket_amount": 485190850035935040, "original_amount": 322185782995497500, "coupon_pay_amount": 3092280258641091000, "original_currency": "IqsOuMPaWo", "payment_discount_amount": 6048869127687220000 }, "deduction_info_list": [ { "source_selling_price": 1923337405613814000, "is_one_time_buy": false, "source_sku_id": 1746195370879634700, "source_platform_discount_amount": 1846936371616649000, "source_item_order_id": "fuhwwL7Q8e", "source_provider_discount_amount": 7572148698603382000, "voucher_type": 1, "source_certificate_code": "pxEGhF9kHC", "order_source": 1, "source_payment_discount_amount": 2050276691250326500, "source_brand_discount_amount": 7724945024761165000, "source_amount": 4296516770465715700, "source_order_id": "imqidvqZBf", "groupon_type": 1, "source_sku_name": "tXfh6JaPmo", "source_merchant_discount_amount": 1490562338377096200, "source_user_pay_amount": 2640848860985633300, "source_certificate_id": "eetYkuacd3" } ], "expire_time": 3192457629010949600, "certificate_id": 7669915844113506000, "additional_map": { "1": "OsTdpliJpN" }, "code": "3en7dsnwI2", "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 3321007997455634400, "time_type": 1 } ] }, "cancel_verify_records": [ { "benefit_amount": { "pay_amount": 6561572528990550000, "benefit_amount": 5970121957517253000, "payment_discount_amount": 7516006372633778000, "provider_discount_amount": 6192882347394665000, "merchant_discount_amount": 9009530401431613000, "total_amount": 2949752770965574000, "platform_discount_amount": 2059616631370030600, "brand_discount_amount": 5071967956296569000, "principal_amount": 1315604275013648600 }, "can_cancel": false, "extra": { "open_order_id": "5cXsDQZJFO" }, "verifier_unique_id": "lcwxENMiju", "poi_id": 5682159341074318000, "verify_id": "x3Z07Hs9Nu", "certificate_id": "QhKnqVx78e", "verify_type": 1, "times_card_serial_num": 8209657849827171000, "verify_time": 4480653547252679000 } ], "can_verify_status": 1, "pay_bill_info": { "bill_amount": 882584119895455600, "order_source": 1, "bill_total_amount": 3923997123990054000 }, "period_card": { "period_type": 1 }, "book_info": { "book_product_number": 5702494987811359000, "verify_amount": 5917021161587318000, "book_poi_id": "SOPyDDsGLV" }, "sku": { "account_id": "zNkIG5M7xc", "third_sku_id": "lOKchVN0Np", "suplier_product_out_id": "R615amQ0wQ", "sku_id": "Yx4jYcf274", "sold_start_time": 5141054197596912000, "sku_out_id": "yhsZuKfobT", "voucher_type": 1, "groupon_type": 1, "product_id": "CJPGiMc30q", "market_price": 1616584074729298000, "title": "ZBg9kzAeLG", "product_attr": { "9w4fW7jWqc": "sWFCpRwKqw" }, "product_out_id": "sEnqwqx7gh" }, "status": 1, "verify": { "verifier_unique_id": "7n5D6eggfq", "verify_time": 2828985126661600000, "times_card_serial_num": 5647084249872190000, "verify_type": 1, "certificate_id": "ZaJsdevk5V", "can_cancel": false, "extra": { "open_order_id": "9vis04PswF" }, "verify_id": "Tbjt8bPHaR", "benefit_amount": { "payment_discount_amount": 1035502074031656300, "merchant_discount_amount": 5307413648189456000, "provider_discount_amount": 3187950513147014700, "total_amount": 7536159363744507000, "platform_discount_amount": 3148875561910385000, "principal_amount": 4353435129596756000, "brand_discount_amount": 315665442662084200, "pay_amount": 3527583734991430700, "benefit_amount": 6726238399567659000 }, "poi_id": 161509360266780500 }, "not_available_poi_list": [ "kLjzr5SJM9" ], "verify_records": [ { "benefit_amount": { "payment_discount_amount": 5279156475682692000, "platform_discount_amount": 8316595286021882000, "benefit_amount": 7996710658472389000, "merchant_discount_amount": 4074509900092246000, "principal_amount": 4028335159570393600, "provider_discount_amount": 3704196941229728000, "pay_amount": 8829392927635768000, "brand_discount_amount": 7462663306093688000, "total_amount": 2866519904614952400 }, "verify_id": "psGm5KkmCA", "verify_time": 8986848285057032000, "extra": { "open_order_id": "7puygA0Ll8" }, "can_cancel": false, "certificate_id": "Pr9bIy74DK", "verifier_unique_id": "Ox5ORZmCj3", "times_card_serial_num": 1177880366068195800, "verify_type": 1, "poi_id": 1849886668675724300 } ], "used_status_type": 1, "use_time_info": { "use_time_type": 1, "time_period_list": [ { "end_time": "yFlSr7La0E", "end_time_is_next_day": false, "start_time": "HXgWICZZLB" } ] }, "encrypted_code": "L1MpBo80Wi" } ], "order_id": "DvfqDyKqTR", "certificates_v2": [ { "additional_map": { "1": "HhZ7ms2OIv" }, "not_available_poi_list": [ "MtRvgvFtGG" ], "dynamic_code_info": { "code_expire_time": "Hjl1I0xXHA" }, "start_time": 4155014514156798500, "not_available_time_info": { "fulfil_enable": false, "can_no_use_week_day": [ 7525977639162652000 ], "can_no_use_date": [ { "start_time": 7607904815381941000, "end_time": 7286648338137063000 } ] }, "amount": { "merchant_discount_detail_list": [ { "discount_name": "mA7oFqj7PC", "discount_amount": 8234095228305032000, "discount_id": "MM2ze4kV7b" } ], "coupon_pay_amount": 3212404827554901500, "list_market_amount": 2191066177948268800, "payment_discount_amount": 115396602791018450, "original_amount": 948874585889110800, "platform_discount_amount": 6873791968089876000, "brand_ticket_amount": 944891451703451300, "merchant_ticket_amount": 5241467846231788000, "original_currency": "a0wWpDoaX0", "pay_amount": 5893492174411299000, "origin_list_market_amount": 5440346917513454000 }, "period_card": { "period_type": 1 }, "can_verify_status": 1, "advance_purchase_struct": { "time_detail": [ { "time_type": 1, "time": 1494873840992512300 } ], "purchase_type": 1 }, "cancel_verify_records": [ { "certificate_id": "xXbM1oJnoI", "verify_type": 1, "extra": { "open_order_id": "khd3nINdrp" }, "verify_time": 6947980835476670000, "times_card_serial_num": 8423218462181228000, "verify_id": "nRdOe1NC5J", "poi_id": 5237182363703335000, "can_cancel": false, "verifier_unique_id": "HGFkNme5ai", "benefit_amount": { "benefit_amount": 3066426684659089000, "payment_discount_amount": 4255752905925931500, "total_amount": 5747076142483188000, "pay_amount": 7486158260284346000, "provider_discount_amount": 4426877034565646000, "merchant_discount_amount": 8033271184143660000, "platform_discount_amount": 8977357101352989000, "brand_discount_amount": 7131807361604318000, "principal_amount": 7766900542444191000 } } ], "book_info": { "verify_amount": 5397468444735378000, "book_poi_id": "lqy9aZQWO2", "book_product_number": 3582912451206814000 }, "deduction_info_list": [ { "source_order_id": "pkr9OYZH5W", "groupon_type": 1, "source_item_order_id": "fTQUhiybR6", "source_merchant_discount_amount": 8857394779904947000, "source_user_pay_amount": 7102288272251805000, "source_payment_discount_amount": 3094777310768614400, "source_selling_price": 7263604999110390000, "order_source": 1, "source_platform_discount_amount": 7667764088681193000, "source_brand_discount_amount": 1153884563323860700, "source_sku_name": "l1uQsXm196", "source_amount": 1546908298430443500, "source_certificate_id": "ilQMOfdugK", "voucher_type": 1, "is_one_time_buy": false, "source_provider_discount_amount": 1084695323484188000, "source_certificate_code": "U1mcT8lkHF", "source_sku_id": 3287832032660280000 } ], "buyer_reserve_info": { "name": "fcNRYLv9Om", "enc_credential_numb": "puisgHW4Ul", "enc_name": "yOghgxLRtX", "credential_numb": "NPaTxuP4Os", "credential_type": 6913449151551336000 }, "time_card": { "times_count": 7792985070121348000, "times_used": 7039233643686602000, "serial_amount_list": [ { "amount": { "pay_amount": 3992011034248263000, "original_currency": "viWB0wpJvK", "brand_ticket_amount": 6673476268292202000, "merchant_discount_detail_list": [ { "discount_id": "LdTVlmRc8d", "discount_name": "9sggW23twZ", "discount_amount": 8653777283392281000 } ], "merchant_ticket_amount": 8821380732203795000, "original_amount": 491690987377055500, "platform_discount_amount": 6229248302607459000, "payment_discount_amount": 414753266172544830, "coupon_pay_amount": 7145374856558958000, "origin_list_market_amount": 7275716276924151000, "list_market_amount": 1305255091761341000 }, "serial_numb": 7654639323382308000 } ], "time_card_type": 1 }, "verify_records": [ { "verify_type": 1, "verify_id": "5IcRGHObjX", "verify_time": 6574536392504480000, "poi_id": 8389164856285630000, "certificate_id": "zjrKitKwkW", "verifier_unique_id": "0kGwa7lIj1", "times_card_serial_num": 7803941541407567000, "extra": { "open_order_id": "FotKERiC4Q" }, "can_cancel": false, "benefit_amount": { "pay_amount": 2435202464116846000, "merchant_discount_amount": 3544142883401042400, "provider_discount_amount": 5254697238070212000, "total_amount": 6205889909447429000, "platform_discount_amount": 5515891708934272000, "benefit_amount": 130547308593762540, "principal_amount": 8772511929492886000, "brand_discount_amount": 8185783394733366000, "payment_discount_amount": 5788418471266068000 } } ], "used_status_type": 1, "certificate_id": 2808406527343194600, "code": "G1HFzTasxQ", "use_time_info": { "use_time_type": 1, "time_period_list": [ { "end_time_is_next_day": false, "start_time": "H4PlBQ8jGr", "end_time": "uvdLg0locs" } ] }, "status": 1, "pay_bill_info": { "bill_amount": 3115953899859929000, "order_source": 1, "bill_total_amount": 3463000540269589500 }, "encrypted_code": "kMdppvoUHC", "benefit_card_info": { "total_amount": { "total_amount": 6548937151189831000, "principal_amount": 1659618325372791800, "merchant_discount_amount": 5560706021804712000, "benefit_amount": 2525342894504762000, "pay_amount": 8940693413816296000, "provider_discount_amount": 6225488197162332000, "payment_discount_amount": 7248962167607801000, "brand_discount_amount": 7972075240168717000, "platform_discount_amount": 4705228379380234000 }, "left_amount": { "principal_amount": 3511463614862228500, "payment_discount_amount": 6056500164084647000, "pay_amount": 2735613740005671400, "merchant_discount_amount": 3650572922102182400, "brand_discount_amount": 8662890943487722000, "provider_discount_amount": 1651114348066175500, "total_amount": 3080698679084996000, "platform_discount_amount": 2952506260332592000, "benefit_amount": 3323141800780566500 } }, "sku": { "sku_id": "DzruAInFoT", "third_sku_id": "eqxIS2Nm92", "account_id": "1sNlu4ufOW", "sku_out_id": "pAI5xvI5n7", "voucher_type": 1, "suplier_product_out_id": "pkLPm0Y79K", "groupon_type": 1, "product_out_id": "jmpraLu32A", "sold_start_time": 8619339544412459000, "product_attr": { "wSyPwFMtOb": "VtV9LLVO59" }, "market_price": 3977528049501980700, "title": "1A6ExQXw6y", "product_id": "YZcfNGM9tk" }, "expire_time": 5463620254600715000, "reserve_info": { "order_reserve_user_info_list": [ { "enc_credential_numb": "xt0USc37fo", "name": "G20JqmeRDy", "phone": "f8igFnSWou", "credential_numb": "ULsLtUnebE", "credential_type": 1, "enc_name": "R169BIAAYO", "enc_phone": "Yd0uZm9wvO" } ] }, "off_peak_discount_info": { "has_off_peak_discount": false, "off_peak_time_range": [ { "end_time": 8302099960476956000, "daily_time_range_list": [ { "start_time": "JHyqyOjbol", "end_time": "5j3EXOgbBn", "end_time_is_next_day": false } ], "week_day_list": [ 1 ], "start_time": 461938422307374140 } ], "idle_time_limit_type": 1 }, "verify": { "poi_id": 3766667696737886700, "verify_type": 1, "can_cancel": false, "times_card_serial_num": 253100419181597150, "verifier_unique_id": "I0OSvgZ0mB", "certificate_id": "NDb6xEsEpS", "verify_time": 7823273011582760000, "extra": { "open_order_id": "BwVn8wZtc9" }, "benefit_amount": { "principal_amount": 2419225729261964300, "provider_discount_amount": 2057646335518709200, "benefit_amount": 4342410597406951400, "brand_discount_amount": 6328941409724690000, "pay_amount": 4948682465199850000, "platform_discount_amount": 3029887725442752500, "merchant_discount_amount": 5635073676683377000, "payment_discount_amount": 4810853857854341000, "total_amount": 1158989781620352300 }, "verify_id": "67GReXxHZa" } } ], "error_code": 0, "description": "" } }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    2002100001
    未知错误
    重试接口,重试3次仍报错联系抖音生活服务技术支持
    2002100004
    系统繁忙,此时请开发者稍候再试
    重试接口,重试3次仍报错联系抖音生活服务技术支持
    2002100005
    参数不合法
    更换参数
    2002119001
    参数不合法
    更换参数
    2002119002
    系统繁忙,请稍候再试
    重试
    2002119003
    请求太过频繁,请稍后再试
    重试
    2002119005
    应用未获商家授权
    联系合作商家在商家后台发起授权,并在服务商后台同意授权
    2002190002
    access_token无效
    调用接口重新生成access_token
    2002190004
    应用未获得该能力, 请去https://open.douyin.com/申请
    应用申请接口权限
    2002190008
    access_token过期,请刷新或重新授权
    规范token刷新机制,检查是否有测试环境在同步刷新token
    2003000001
    根据实际业务错误返回
    对照接口文档规范参数并重试
    2005000001
    根据实际业务错误返回
    联系抖音处理
    2003000001
    以实际错误信息为准
    2005000001
    服务器打瞌睡了,请稍后再试。