抖音开放平台Logo
控制台

撤销核销

更新时间 2024-10-12 09:51:16
收藏
我的收藏

接口说明

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-tokenStringclt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-typeString
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
certificate_idString
代表一张券码的标识(验券时返回)

该字段通过 /goodlife/v1/fulfilment/certificate/verify/ 接口返回的 data.verify_results[].certificate_id 字段获取

verify_idString

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

该字段通过 /goodlife/v1/fulfilment/certificate/verify/ 接口返回的 data.verify_results[].verify_id 字段获取

cancel_tokenString

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

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

shop_order_idString
所属的订单id
times_card_cancel_countInt64

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

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

请求示例

{
  "verify_id": "123456789",
  "certificate_id": "987654321"
} 

响应参数

Body

名称字段类型是否必填示例描述

响应示例

正常响应示例

{
  "data": {
    "error_code": 0,
    "description": "success"
  },
  "extra": {
    "error_code": 0,
    "description": "success",
    "sub_error_code": 0,
    "sub_description": "",
    "logid": "xxx",
    "now": 1651114087
  }
}

异常响应示例

{
  "data": {
    "error_code": 111,
    "description": "err_description"
  },
  "extra": {
    "error_code": 111,
    "description": "err_description",
    "sub_error_code": 0,
    "sub_description": "sub_err_description",
    "logid": "xxx",
    "now": 1651114087
  }
}

错误码

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
参数不合法
更换参数