抖音开放平台Logo
开发者文档
控制台
  • 接入前准备
  • 通用能力
  • 餐饮
  • 大交通
  • 酒旅
  • 综合
  • 到综团购解决方案
  • 综合到店提货解决方案
  • 商品发布
  • 提货券三方码交易能力
  • 发券回调接口
  • 退款审核回调接口
  • 通知外部商家创单
  • 通知外部商家支付成功
  • 通知外部商家取消订单
  • 发券
  • 商家申请退款
  • 退款结果同步外部商家
  • 撤销核销
  • 提货券抖音码交易能力
  • 商品查询
  • 线索管理解决方案
  • 历史版本文档(不推荐)
  • 接口说明

    用于撤销核销状态,误核销之后的撤销操作,有时间限制,验券超过一个小时就不可再撤销。

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

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

    基本信息

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

    请求参数

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

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

    batch_cancel_infoStruct
    批量撤销某个订单下的一批验券记录(目前只支持次卡批量撤销!)
    展开子属性
    batch_cancel_info_listList
    批量撤销多个订单下的一批验券记录
    展开子属性
    cancel_tokenString
    撤销核销幂等操作,主要针对次卡,避免重复请求导致撤销多次
    shop_order_idString
    所属的订单id
    times_card_cancel_countInt64
    撤销核销次数,只对次卡剩下,优先级低于VerifyId
    请求示例
    curl --location --request POST '/goodlife/v1/compre_retail/fulfilment/certificate/cancel/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"account_id":"voUyxJgJgD","verify_id":"NIdt4K5ARe","certificate_id":"S79zvmyk79","times_card_cancel_count":3059408620265974006,"cancel_token":"XfpCAo9OXl","batch_cancel_info":{"verify_id_list":["SxJcvX9tWP"],"order_id":"dWyc5b1RCn"},"batch_cancel_info_list":[{"verify_id_list":["W7eD7hy8Ed"],"order_id":"vRNWJsva17"}],"shop_order_id":"5cyxVzLbDk"}'

    响应参数

    Body展开全部子属性
    data必填Struct
    验券结果
    展开子属性
    extraStruct
    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20241214173325958BC2D891DBFD7E9E60", "now": 1734168806 }, "data": { "cancel_results": [ { "result_code": 5025697069640954000, "result_msg": "LQMyYjROcu", "order_id": "MqRXUfdixl", "verify_id": "ty7SEWceTs" } ], "transaction_id": 6699598957939414000, "error_code": 0, "description": "" } }

    错误码

    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
    根据实际业务错误返回
    对照接口文档规范参数并重试
    2004000001
    根据实际业务错误返回
    补充参数
    2004000002
    根据实际业务错误返回
    对照接口文档规范参数并重试
    2005000001
    根据实际业务错误返回
    联系抖音处理
    2003000020
    无核销记录可撤销
    查看是否核销过再重试
    2005000001
    服务器打瞌睡了,请稍后再试。
    2003000001
    以实际错误信息为准