1.功能描述
用于取消"订单信息导入"和"商家寄件"导入成功的订单;不支持批量导入需逐一提交;
2.接口信息
请求地址 | b.kuaidi100.com/v7/open/api… |
通信协议 | HTTPS |
请求方式 | POST |
字符集 | UTF-8 |
请求Conent-Type | application/x-www-form-urlencoded |
3.接口规则
- 导入成功但未打印的订单可通过此接口进行取消,已打印的订单不支持取消;
- 取消成功后不会返回扣除的导入量,请确认需要打印再导入订单;
4.请求参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
app_key | String | 是 | 由快递100提供,接入应用的唯一标识 ([快递管家官网API服务],管理中的App Key) |
access_token | String | 是 | 授权注册时获取的access_token(访问令牌) |
timestamp | long | 是 | 时间戳,自1970年01月01日起到现在的秒数, 例: 1502963129 |
sign | String | 是 | 签名,签名算法参照【签名说明】 |
data | String | 是 | Json字符串 |
data参数
名称 | 类型(字符长度) | 是否必填 | 描述 |
---|---|---|---|
order_list | String(300) | 是 | 订单编号,最多一次支持 10 单,用英文逗号分隔 |
示例:
app_key=LeWFeuaGwdf&access_token=uoKbfafdfafcCce×tamp=1502963129&sign=3CF35D130E8B197553ADE1BAEA2615F0&data={
"order_list":"O23456,O34567,O12345"
}
5.返回参数
名称 | 类型(字符长度) | 是否必填 | 描述 |
---|---|---|---|
status | String(5) | 是 | 200:成功401:失败 |
message | String(30) | 是 | 成功/失败原因 |
示例:
成功:
{
"status": "200",
"message": "success"
}
失败:
{
"status": "401",
"message": "订单编号不存在,请检查"
}
6.接口异步回调信息
请求的Content-Type:application/json;charset=UTF-8
6.1.请求参数
名称 | 类型(字符长度) | 是否必填 | 描述 |
---|---|---|---|
app_key | String | 是 | 由快递100提供,接入应用的唯一标识 ([快递管家官网API服务], 管理中的App Key) |
timestamp | long | 是 | 时间戳,自1970年01月01日起到现在的 秒数, 例: 1502963129 |
type | String | 是 | 回调接口推送类型,固定为:CANCEL |
sign | String | 否 | 签名,签名算法参照【签名说明】 |
data | String | 是 | Json字符串 |
└succ_order_num_list | Array | 是 | 成功取消的订单编号列表 |
└fail_order_num_list | Array | 是 | 取消失败的订单编号列表 |
└status | String(5) | 是 | 200:成功 401:失败 |
└message | String(30) | 是 | 成功/失败原因 |
示例:
{
"app_key": "LeWFeuaGwx1v",
"data":{
"fail_order_num_list": ["O23456","O34567"],
"succ_order_num_list":["O12345"]
"status": "200",
"message": "success"
},
"type": "CANCEL",
"timestamp": 1596100607
}
6.2.返回参数
名称 | 类型(字符长度) | 是否必填 | 描述 |
---|---|---|---|
status | String(5) | 是 | 200:成功 400:失败 |
示例:
成功:
{“status”:200}
失败:
{“status”:400}