待处理订单-取消订单
待处理订单,进行订单取消操作。待处理订单,指的是顾客已经提交订单,譬如:在线支付类型订单支付完成,cod货到付款类型订单以及提交,线下支付类型订单已经打款并客服审核通过订单, 这些订单都将进入订单发货流程,成为待处理订单
接口信息
- 接口地址:
{your-site-url}/api/skill/order/order-cancel - 基础 URL:
{your-site-url}需替换为你自己的独立站 URL 地址,如https://your-domain.com/apimanager666 - 请求方式:
POST - 说明: 此接口用于取消指定待处理订单。取消前需确认订单的召回状态,是否为已召回,而且是否允许取消。
认证
请求头中需要携带 skill-access-token:
| Header | 值 |
|---|---|
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
Content-Type |
application/json |
请求参数 (JSON Body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
order_number |
string | 是 | 订单编号 |
请求示例
cURL
curl --location --request POST '{your-site-url}/api/skill/order/order-cancel' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_number": "FECE602835181805625"
}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": [],
"message": "success"
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
code |
Number | 状态码,200 表示成功 |
message |
String | 执行结果的文字描述 |
data |
Array | 返回数据(成功时为空数组) |
操作流程
- 调用 订单-详细 查看订单是否为
待处理订单, 如果recall_status值为3,则代表为待处理订单,如果不是待处理订单则不允许调用该api。然后查看订单的can_cancel字段 - 如果
can_cancel为true,则可以调用本接口取消订单 - 如果
can_cancel为false,则不允许取消,调用本接口将返回错误
注意事项
- 必须是
待处理订单,才可以调用本api进行订单取消操作 - 取消订单前必须先检查
can_cancel是否为true - 取消后订单
order_status变为4(已取消)