抖音开放平台Logo
开发者文档
控制台
  • 接入前准备
  • 通用能力
  • 餐饮
  • 大交通
  • 酒旅
  • 综合
  • 到综团购解决方案
  • 到综团购预约解决方案
  • 综合到店提货解决方案
  • 商品发布
  • 提货券三方码交易能力
  • 提货券抖音码交易能力
  • 验券准备接口
  • 验券接口
  • 撤销核销接口
  • 券状态批量查询
  • 商品查询
  • 线索管理解决方案
  • 历史版本文档(不推荐)
  • 接口说明

    1. 提货券抖音券码的核销需要先调用验券准备接口,再调用本接口。
    2. 可支持多个批量验券,需为同一个订单,不可跨订单验券。
    3. error_code、result 均为 0 代表验券成功。error_code非0时则表示调用验券接口失败,建议服务商侧主动发起重试,建议间隔5s发起。第一次调用error_code非0,第二次调用error_code=0且result=1208或2,也可以代表验券成功
    4. 接口报错返回”服务器错误,请稍后重试“、“您的访问过于频繁,请稍后重试”等建议重试的文案后,建议以如下重试策略进行重试,接口成功返回后即可停止重试:
    5. 前5次重试以5s间隔进行
    6. 之后以40s间隔进行
    7. 最高重试14次,如果接口依然报错,请进线反馈

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/goodlife/v1/compre_retail/fulfilment/certificate/verify/
    HTTP Method
    POST
    Scope
    life.capacity.compre_retail_certificate_verify
    权限要求
    综合到店提货解决方案-提货券抖音码交易,提货券三方码交易能力

    请求参数

    请求头
    access-token必填String
    示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
    content-type必填String
    固定值"application/json"
    Body展开全部子属性
    poi_id必填String

    核销的抖音门店id

    如何获得抖音门店id,可以参考:门店关联及匹配能力

    抖音码交易:使用验券准备返回的预约门店

    verify_token必填String

    一次验券的标识

    抖音码交易:验券准备接口返回的验券标识

    三方码交易:针对三方码订单,每次请求都需要保证幂等!(请求维度,非券码/订单维度)

    code_with_time_listList
    核销前验证核销时间
    展开子属性
    codesList

    三方券码:券码值列表 codes

    展开子属性
    encrypted_codesList

    针对抖音券码:验券准备接口返回的加密抖音券码

    展开子属性
    order_idString
    抖音侧的订单号
    verify_extraStruct
    核销额外信息
    展开子属性
    verify_sign_listList
    三方核销验签
    展开子属性
    voucherStruct

    景区核销,字段废弃,请勿使用

    展开子属性
    vouchersList

    团购景区核销,字段废弃,请勿使用

    展开子属性
    请求示例
    curl --location --request POST '/goodlife/v1/compre_retail/fulfilment/certificate/verify/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{\"verify_sign_list\":[\"6SUf2XaHpz\"],\"voucher\":{\"certificate_no_list\":[\"clK1Cfpkut\"],\"verify_time\":8137463211066282894,\"project_id\":\"kESZcB2T05\",\"id_card_list\":[\"4dMp5GSvYL\"],\"qrcode_list\":[\"QR3NGdWq2n\"]},\"verify_token\":\"YoxQvY3Pny\",\"encrypted_codes\":[\"cn5Pg6W2Gn\"],\"code_with_time_list\":[{\"code\":\"YqOGUY9WHr\",\"verify_time\":5564437768132509691,\"serial_num\":6268968840070122790,\"outer_numb\":{\"coupon_number\":\"fABYuuwJSH\",\"order_number\":\"8GGgXoEMGh\"}}],\"poi_id\":\"URwbJpXFgT\",\"codes\":[\"jOBiBHzGme\"],\"order_id\":\"wL5V33L4Wo\",\"verify_extra\":{\"offline_add_price_info\":{\"is_offline_add_price\":false},\"out_good_ids\":[\"5fb5YeUGha\"],\"dynamic_coupon_info\":{\"actual_deduction_amount\":8804737293837041533,\"biz_time\":6973599003116597979},\"total_verify\":false},\"vouchers\":[{\"verify_time\":7855357160990365059,\"project_id\":\"KDi1rXlWOx\",\"id_card_list\":[\"vcbQcpB3jC\"],\"qrcode_list\":[\"806somfWxq\"],\"certificate_no_list\":[\"8aRYLOEbe1\"]}]}'

    响应参数

    Body展开全部子属性
    data必填Struct
    展开子属性
    extraStruct
    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "data": { "error_code": 0, "description": "", "verify_results": [ { "result": 0, "msg": "验券成功", "code": "CgwIARDhJxjLLyABKAESLgosTYTOIJFLZx8IaWKdO9ISKSWf4XYaqzt8TU1fhbTpYhIAuA5i5fRYfApwNRMaAA==", "verify_id": "7091478021421631519", "certificate_id": "7091180835810052103", "origin_code": "102539929601", "account_id": "123456", "order_id": "1111111" } ] }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20241214172704C82D1E39FC12FF908D98", "now": 1734168424 } }
    切换单列布局

    错误码

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