订单-已发货包裹-取消发货
订单 - 取消发货
接口信息
- 接口地址:
{your-site-url}/api/skill/order/order-fulfill-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 |
是 |
订单编号 |
fulfillment_id |
int |
是 |
物流包裹 ID |
请求示例
cURL
curl --location --request POST '{your-site-url}/api/skill/order/order-fulfill-cancel' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_number": "FECE602805426537641",
"fulfillment_id": 306
}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": [],
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Array |
返回数据(成功时为空数组) |
操作流程
- 调用 订单-已发货包裹-详细 获取所有已发货包裹
- 检查目标包裹的
status 字段:
status 枚举:1 = 等待发货,2 = 已发货,3 = 已收货
- 仅
status 为 2(已发货)的包裹可以取消发货
- 使用包裹的
id(即 fulfillment_id)调用本接口取消发货
注意事项
- 只有状态为"已发货"(
status = 2)的包裹才能取消发货
- 已收货(
status = 3)的包裹不允许取消发货
- 取消发货后,该包裹中的商品将重新变为可发货状态,可再次通过 订单-包裹-发货 进行发货
fulfillment_id 对应包裹列表中的 id 字段