撤销核销
用于撤销核销状态
使用限制
无
接口说明
- 针对三方码误核销之后的撤销操作,订单状态由“已使用”回改为“待使用”,用于验券错误需要撤回验券等场景, 已分账的不可再撤销。
基本信息
基本信息 | |
---|---|
HTTP URL | https://open.douyin.com/api/trade/v2/fulfillment/verify_cancel |
HTTP Method | POST |
Scope | industry_open.trade.certificate_delivery |
权限要求 | 不需要用户授权 |
请求头
参考通用参数
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
verify_id | string | 是 | 代表券码一次核销的唯一标识 | 12345 |
certificate_id | string | 是 | 代表一张券码的标识 | 123 |
order_id | string | 是 | 需要撤销的certificate_id所属的订单id | 8000088 |
请求示例
curl --location --request POST 'https://open.douyin.com/api/trade/v2/fulfillment/verify_cancel' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.xxx' \ --data-raw='{ "verify_id":"12345", "certificate_id":"123", "order_id":"8000088" }'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
data | object | 是 | 返回数据 | |
extra | object | 是 | 额外信息 |
data 信息
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
error_code | int32 | 是 | 错误码,0为成功 | |
description | string | 是 | 错误信息 |
extra 信息
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
error_code | int | 是 | 错误码,0为成功 | 0 |
description | string | 是 | 错误码描述 | success |
sub_error_code | int | 是 | 子错误码 | 0 |
sub_description | string | 是 | 子错误码描述 | success |
logid | string | 是 | 请求id | 2022092115392201020812109511046 |
now | int | 是 | 毫秒级时间戳 | 1663745962686 |
响应示例
正常示例
{ "data": { "error_code": 0, "description": "success" }, "extra": { "sub_error_code": 0, "sub_description": "success", "logid": "2022092115392201020812109511046", "now": 1663745962686, "error_code": 0, "description": "success" } }
异常示例
{ "data": { "error_code": 13000, "description": "系统错误" }, "extra": { "sub_error_code": 13000, "sub_description": "系统错误", "logid": "2022092115392201020812109511046", "now": 1663745962686, "error_code": 2191000, "description": "" } }
错误码
HTTP 状态码 | 错误码 sub_error_code | 描述 | 排查建议 |
---|---|---|---|
200 | 10000 | 参数错误 | 参数不符合规范。请根据提示检查参数。 |
200 | 13000 | 系统错误,请重试 | 内部错误,重试可解决。 |
该文档是否有帮助?