1、 API Description
| Function |
Cancel Order |
| Method |
POST |
| Type |
JSON |
| URI |
/oms/v1/Order/cancelOrderByCustomer |
2、 API Request
2.1、Request Parameters
| Name |
Description |
Required |
Type |
| userId |
userId |
true |
string |
| ileId |
ileId |
true |
string |
| ileKey |
ileKey |
true |
string |
| orderNos |
List of Final Delivery order numbers |
true |
array |
2.2、Request Message Example
{
"ileId":"your_ileId",
"sign":"your_sign",
"userId": "your_userId",
"orderNos": ["xxxxxxxxx", "xxxxxxxxx"]
}
3、 API Response
3.1、 Common Response Parameters
| Name |
Discription |
Type |
| body |
Response body |
object |
| code |
Response code |
integer |
| msg |
Message |
string |
3.1.1、Response Status
| Status Code |
Description |
| 200 |
Order cancel successful |
| 401 |
Unauthorized |
| 403 |
Forbidden |
| 404 |
Not Found |
| 500 |
System error |
3.2、Example: Single order cancellation
3.2.1、Success
{
"body": "Order cancel successful",
"code": 200,
"msg": "Order cancel successful"
}
3.2.2、Failure
{
"body": null,
"code": 51014,
"msg": "Cancellation failed! The current status of the order is [warehouse entry]"
}
3.3、Example: Multiple order cancellation
3.3.1、Success
{
"body": "10 orders cancel successful",
"code": 200,
"msg": "10 orders cancel successful"
}
3.3.2、Failure (some or all)
{
"body": {
"success": [
"3676******"
],
"error": [
"SKP1361******"
]
},
"code": 51014,
"msg": "1 orders cancel successful;\n【[SKP1361******]】cancel failed!"
}
作者:conghui 创建时间:2024-09-12 15:57
最后编辑:conghui 更新时间:2025-12-16 17:30