订单-已发货包裹-取消收货
订单 - 取消收货
接口信息
- 接口地址:
{your-site-url}/api/skill/order/order-receive-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-receive-cancel' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_number": "FECE602805426537641",
"fulfillment_id": 303
}'
返回结果
code 为 200 表示调用成功；code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": [],
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码，200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Array |
返回数据（成功时为空数组） |
操作流程
- 调用 订单-已发货包裹-详细 查看所有已发货包裹
- 检查目标包裹的
can_cancel_fulfill 字段：
- 值为
true：可以调用本接口取消收货
- 值为
false：不允许取消收货，调用本接口将返回错误
- 使用包裹的
id（即 fulfillment_id）调用本接口提交
注意事项
- 此接口仅适用于多包裹场景：订单存在多个包裹，部分已收货、部分未收货时，已收货的包裹
can_cancel_fulfill 才为 true
- 调用前必须先通过 订单-已发货包裹-详细 检查
can_cancel_fulfill 是否为 true，否则执行将返回非 200 错误
fulfillment_id 对应包裹列表中的 id 字段