取消订单
接口说明
- 抖音订单ID(order_id)、抖音预订单 ID(pre_order_id)、第三方订单ID(out_order_id) 三者必须传入一个
- 抖音订单ID(order_id)、抖音预订单 ID(pre_order_id)、第三方订单ID(out_order_id) 如果传入大于 1 个值,则按照三方订单 > 预下单 > 订单的优先级进行处理
使用限制
SLA:支持的最大QPS:50;PCT99承诺值:1000ms;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/homed/trade/payment/order/cancel/ |
| HTTP Method | POST |
| Scope | life.capacity.homed.trade.payment.order.cancel |
| 权限要求 | 开发者需要申请权限:商家买单能力
|
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Body
account_id必填String
商家账户id
order_idString
抖音订单 ID(可作幂等键)
out_order_idString
第三方订单ID(可作幂等键)
pre_order_idString
抖音预订单 ID(可作幂等键)
reasonString
取消原因
请求示例
curl --location --request POST 'https://open.douyin.com/goodlife/v1/homed/trade/payment/order/cancel/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"reason":"0epICLd3Z1","account_id":"Ku2N0FinAR","order_id":"8u1daiYoy0","out_order_id":"4ZKJzMxoLF","pre_order_id":"RCcMVRUvxc"}'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
extra必填Struct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202503201630321825E55E98E0A82600DD", "now": 1742459432 }, "data": { "error_code": 0, "description": "" } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 2119001 | 参数不合法 | 更换参数 |
| 200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
| 200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
| 200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
| 200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
| 200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
| 200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
| 200 | 3000001 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 5000001 | 根据实际业务错误返回 | 联系抖音处理 |
| 200 | 5000001 | 系统错误,请重试 | 多次重试失败请联系抖音处理 |
| 200 | 3000003 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000001 | 以实际错误信息为准 | 详见错误描述信息 |
| 200 | 5000001 | 系统错误,请重试 | 多次重试失败请联系抖音处理 |
| 200 | 3000002 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000001 | 以实际错误信息为准 | 对照接口文档规范参数并重试 |
| 200 | 3000004 | 以实际错误信息为准 | 联系抖音 |
