撤销核销__抖音开放平台

接口说明

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	调用https://open.douyin.com/oauth/client_token/生成的token
content-type	String	是	application/json	固定值"application/json"

请求参数

Body

名称	字段类型	是否必填	描述
certificate_id	String	是	代表一张券码的标识(验券时返回) 该字段通过 /goodlife/v1/fulfilment/certificate/verify/ 接口返回的 data.verify_results[].certificate_id 字段获取
verify_id	String	是	代表券码一次核销的唯一标识(验券时返回) (次卡撤销多次时请填0) 该字段通过 /goodlife/v1/fulfilment/certificate/verify/ 接口返回的 data.verify_results[].verify_id 字段获取
batch_cancel_info	Struct	否	批量撤销某个订单下的一批验券记录（目前只支持次卡批量撤销!）使用batch_cancel_info时，verify_id和certificate_id传"0" 使用batch_cancel_info时，order_id和verify_id_list为必传参数批量撤销仅支持全部成功或者全部失败仅支持团购以及次卡（单张券）使用
batch_cancel_info_list	List	否	批量撤销多个订单下的一批验券记录
cancel_token	String	否	撤销核销幂等操作，主要针对次卡，避免因超时等原因在短时间内重复请求导致撤销多次（幂等有效期1小时）注意：如果是分门店结算，此字段不要传！！！
shop_order_id	String	否	所属的订单id
times_card_cancel_count	Int64	否	取消核销总次数（多次卡商品可传，优先级低于verify_id）注意：如果是分门店结算，此字段不要传！！！

请求示例

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

响应参数

Body

名称	字段类型	是否必填	示例	描述
data	Struct	是		验券结果
extra	Struct	否

响应示例

正常响应示例

{
  "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状态码	错误码	错误码描述	排查建议
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理
200	3000003	撤销核销超时	超过可撤销时间

撤销核销在线调试

接口说明

基本信息

请求头

请求参数

Body

请求示例

响应参数

Body

响应示例

正常响应示例

异常响应示例

错误码

撤销核销