商家取消订单接口
接口说明
1. 商家因联系不上用户、商品售完等原因需要主动退单,可调用此接口取消订单
使用限制
SLA:支持的最大QPS:10;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/after_sale/order/apply_refund/ |
| HTTP Method | POST |
| Scope | life.capacity.order_refund |
| 权限要求 | 订单退款 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Body展开全部子属性
order_id必填String
订单ID
apply_typeInt64
4: required string MerchantAccountId (api.body="account_id")
5: optional RefundTypeEnum RefundType (api.body="refund_type")// 退还类型
申请类型:1 仅退款;2 退货退款。当前商家发起退货仅支持仅退款
out_after_sale_idString
外部退款单ID
refund_productStruct
退商品信息,仅当部分商品仅退款场景下该结构体有值
展开子属性
refund_reasonStruct
商家取消订单原因
展开子属性
请求示例
curl --location --request POST 'https://open.douyin.com/goodlife/v1/after_sale/order/apply_refund/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"apply_type":3822549570950741304,"refund_product":{"refund_scope":1,"refund_combos":[{"order_item_id":"OfdjArvX2F"}]},"order_id":"Yfs7gR1mxg","out_after_sale_id":"j9NHuzmjjS","refund_reason":{"show_reason":[{"reason_code":840712118688542405,"msg":"FQAJbPGCdy"}],"user_media_list":["QbRAEOXHFS"],"reason_code":[4915522230108500558],"desc":"h0NiTyU3Ri"}}'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
extra必填Struct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202609141654320AD37E7C8465119E9FC6", "now": 1789376072 }, "data": { "AfterSaleId": "JLgWEoFI77", "isSuccess": false, "ErrorCode": 5925472015413118000, "ErrorDetail": "XLwenIGkPQ", "SimpleAfterSaleType": 1, "error_code": 0, "description": "" } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 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 | 3000001 | 以实际错误信息为准 | |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 |
