抖音开放平台Logo
开发者文档
控制台
  • 接入前准备
  • 通用能力
  • 门店管理
  • 团购核销
  • 验券准备
  • 验券
  • 撤销核销
  • 券状态查询
  • 券状态批量查询
  • 团购对账
  • 会员接入
  • 订单查询
  • 三方码
  • 商品发布
  • 代运营
  • 团购退款
  • 商品查询
  • 餐饮
  • 大交通
  • 酒旅
  • 综合
  • 历史版本文档(不推荐)
  • 撤销核销

    收藏
    我的收藏

    接口说明

    1、针对“抖音团购券码、三方券码”两种券码误核销之后的撤销操作,订单状态由“已使用”回改为“待使用”,用于验券错误需要撤回验券等场景, 有时间限制,验券超过一个小时就不可再撤销。

    2、extra.error_code、data.error_code 均为 0 代表撤销成功。

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/goodlife/v1/fulfilment/certificate/cancel/
    HTTP Method
    POST
    Scope
    life.capacity.fulfilment
    权限要求
    团购核销

    请求参数

    请求头
    access-token必填String
    示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
    content-type必填String
    固定值"application/json"
    Body展开全部子属性
    certificate_id必填String
    代表一张券码的标识(验券时返回)
    verify_id必填String

    代表券码一次核销的唯一标识(验券时返回) (次卡撤销多次时请填0)

    account_idString

    核销商户根账户ID(云连锁场景接入需传入,其余场景可不传)

    batch_cancel_infoStruct

    批量撤销某个订单下的一批验券记录(目前只支持次卡批量撤销!)

    1. 使用batch_cancel_info时,verify_id和certificate_id传"0"
    2. 使用batch_cancel_info时,order_id和verify_id_list为必传参数
    3. 批量撤销仅支持全部成功或者全部失败
    4. 仅支持团购以及次卡(单张券)使用
    展开子属性
    batch_cancel_info_listList
    批量撤销多个订单下的一批验券记录
    展开子属性
    cancel_tokenString

    撤销核销幂等操作,主要针对次卡,避免因超时等原因在短时间内重复请求导致撤销多次(幂等有效期1小时)

    注意:如果是分门店结算,此字段不要传!!!

    shop_order_idString
    所属的订单id
    times_card_cancel_countInt64

    取消核销总次数(多次卡商品可传,优先级低于verify_id)

    注意:如果是分门店结算,此字段不要传!!!

    请求示例
    curl --location --request POST '/goodlife/v1/fulfilment/certificate/cancel/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"batch_cancel_info_list":[{"order_id":"HJHTBL2a8v","verify_id_list":["KFGP6R3VMa"]}],"shop_order_id":"WlRvzXjw2e","account_id":"TRsN4MAfdI","verify_id":"S1iAJm8Oaf","certificate_id":"bd8gQaTRYL","times_card_cancel_count":4758481174868563173,"cancel_token":"d2EVpse8DS","batch_cancel_info":{"order_id":"SQDTI2TLVw","verify_id_list":["WxYOk1RFGS"]}}'

    响应参数

    Body展开全部子属性
    data必填Struct
    验券结果
    展开子属性
    extraStruct
    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20241205142752CE3AA7F180845F748F01", "now": 1733380073 }, "data": { "cancel_results": [ { "verify_id": "RWlUfE7TVc", "result_code": 431452040850118400, "result_msg": "p5I0JKtE7E", "order_id": "u3y7pYNdxL" } ], "transaction_id": 7980158481717813000, "error_code": 0, "description": "" } }

    错误码

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