接口名称
删除运单 (Delete Orders)
接口地址
/api/shipper/v1/parcel/order/delete
请求方式
POST
接口描述
该接口用于删除一个或多个运单订单。注意：*只有未预报的订单（status < 2）才能被删除*。
请求头
参数 |
类型 |
必填 |
说明 |
|---|---|---|---|
sessionId |
String |
是 |
登录会话ID |
language |
String |
是 |
语言 |
Content-Type |
String |
是 |
application/json;charset=UTF-8 |
语言取值：
值 |
说明 |
|---|---|
zh_CN |
中文 |
en_US |
英文 |
请求参数
参数 |
类型 |
必填 |
说明 |
|---|---|---|---|
uuids |
Array |
是 |
订单UUID列表 |
订单状态限制
只有满足以下条件的订单才能被删除：
条件 |
说明 |
|---|---|
status < 2 |
订单状态必须小于2（未预报状态） |
status !== undefined |
订单状态不能为undefined |
请求示例
curl 'https://tracking-qa.etowertech.com/api/shipper/v1/parcel/order/delete' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'language: zh_CN' \
-H 'sessionId: vP1l43F_OqvoTUWBcaAtyg' \
--data-raw '{
"uuids": ["uuid1", "uuid2", "uuid3"]
}'
返回示例
{
"success": true,
"code": "0",
"data": true,
"errors": []
}
返回字段说明
字段 |
类型 |
说明 |
|---|---|---|
success |
Boolean |
请求是否成功 |
code |
String |
响应状态码，"0"表示成功 |
data |
Boolean |
删除操作结果，true表示删除成功 |
errors |
Array |
错误信息列表 |
错误提示
前端校验错误：
错误提示 |
说明 |
|---|---|
订单已经预报，不能删除 |
选中行中包含 status >= 2 的订单 |
接口返回错误：
错误码 |
说明 |
|---|---|
非0 |
删除失败 |