订单-归档
订单 - 归档订单
接口信息
- 接口地址:
{your-site-url}/api/skill/order/order-archive - 基础 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_numbers |
Array[string] | 是 | 订单编号数组,支持批量归档 |
请求示例
cURL
curl --location --request POST '{your-site-url}/api/skill/order/order-archive' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_numbers": ["FECE602864961317958"]
}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"order_archive_count": 1
},
"message": "success"
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
code |
Number | 状态码,200 表示成功 |
message |
String | 执行结果的文字描述 |
data.order_archive_count |
int | 成功归档的订单数量 |
操作流程
- 调用 订单-详细 查看订单的
can_archived字段 - 如果
can_archived为true,则可以调用本接口归档订单 - 如果
can_archived为false,则不允许归档,调用本接口将返回错误
注意事项
- 归档前必须先检查
can_archived是否为true - 归档条件:订单所有包裹已完成售后,订单为已收货状态
order_numbers为数组,支持传入多个订单编号批量归档- 归档后可通过 订单-取消归档 回退