撤销核销
接口说明
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"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Body展开全部子属性
certificate_id必填String
代表一张券码的标识(验券时返回)
verify_id必填String
代表券码一次核销的唯一标识(验券时返回) (次卡撤销多次时请填0)
account_idString
核销商户根账户ID(云连锁场景接入需传入,其余场景可不传)
batch_cancel_infoStruct
批量撤销某个订单下的一批验券记录(目前只支持次卡批量撤销!)
- 使用batch_cancel_info时,verify_id和certificate_id传"0",order_id和verify_id_list为必传参数
- 批量撤销仅支持全部成功或者全部失败
- 仅支持团购以及次卡(单张券)使用
展开子属性
batch_cancel_info_listList
批量撤销多个订单下的一批验券记录
如果使用该参数,需要校验result中的 result_code 和error_code均为0才是撤销成功
展开子属性
cancel_tokenString
撤销核销幂等操作,主要针对次卡,避免因超时等原因在短时间内重复请求导致撤销多次(幂等有效期1小时)
注意:如果是分门店结算,此字段不要传!!!
shop_order_idString
所属的订单id
times_card_cancel_countInt64
取消核销总次数(多次卡商品可传,优先级低于verify_id)
注意:如果是分门店结算,此字段不要传!!!
请求示例
# 团购撤销核销 curl --location --request POST 'https://open.douyin.com/goodlife/v1/fulfilment/certificate/cancel/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"cancel_token":"AuW4REq7MH","shop_order_id":"1000000000000000000","account_id":"7000000000000000003","verify_id":"7000000000000000001","certificate_id":"7000000000000000002"}' # 一单多次卡撤销核销 curl --location --request POST 'https://open.douyin.com/goodlife/v1/fulfilment/certificate/cancel/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"cancel_token":"AuW4REq7MH","batch_cancel_info":{"order_id":"1000000000000000000","verify_id_list":["7000000000000000001","7000000000000000002"]},"verify_id":"0","certificate_id":"0","account_id":"7000000000000000003"}' # 跨订单撤销核销 curl --location --request POST 'https://open.douyin.com/goodlife/v1/fulfilment/certificate/cancel/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"batch_cancel_info_list":[{"verify_id_list":["7000000000000000001","7000000000000000002"],"order_id":"1000000000000000000"},{"verify_id_list":["7000000000000000003","7000000000000000004"],"order_id":"1000000000000000001"}],"verify_id":"0","certificate_id":"0","account_id":"7000000000000000003"}'
响应参数
Body展开全部子属性
data必填Struct
验券结果
展开子属性
extra必填Struct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "cancel_results": [ { "result_code": 6022680607725430000, "result_msg": "dd6qq9Z6Ru", "order_id": "KRaEoQlcPd", "verify_id": "TLJn4RgOCw" } ], "transaction_id": 9016196827311859000, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20250208153025EB50C8613D1C9E4C13D6", "now": 1738999825 } }
错误码
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 | 撤销核销超时 | 超过可撤销时间 |
200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
200 | 2100005 | 参数不合法 | 更换参数 |
200 | 5000001 | 服务器打瞌睡了,请稍后再试。 | |
200 | 3000001 | 以实际错误信息为准 |