电子面单取消接口
一、取消接口
通过快递公司或网点、菜鸟与淘宝提供的电子面单账号,对已经提交过的面单但没有寄发的面单号进行取消,快速回收面单。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://api.kuaidi100.com/label/order
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:cancel) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
partnerId | 否 | string | 电子面单客户账户或月结账号;电子面单下单时有填写,则电子面单取消时必填 |
partnerKey | 否 | string | 电子面单密码;电子面单下单时有填写,则电子面单取消时必填 |
partnerSecret | 否 | string | 电子面单密钥;电子面单下单时有填写,则电子面单取消时必填 |
partnerName | 否 | string | 电子面单客户账户名称;电子面单下单时有填写,则电子面单取消时必填 |
net | 否 | string | 收件网点名称,由快递公司当地网点分配, 若使用淘宝授权填入(taobao),使用菜鸟授权填入(cainiao), 使用京东授权填入(jdalpha),使用拼多多授权填入(pinduoduoWx),使用抖音授权填入(douyin),使用快手授权填入(kuaishou),使用唯品会授权填入(weipinhui),使用视频号授权填入(wechatChannels),使用小红书授权填入(xiaohongshu)。 是否必填该属性,请查看参数字典 (若通过第三方授权方式获取单号partnerId,partnerKey参数为必填,参数值可通过第三方授权接口获取) |
code | 否 | string | 电子面单承载编号;电子面单下单时有填写,则电子面单取消时必填 |
kuaidicom | 是 | string | 快递公司的编码,一律用小写字母,见参数字典 |
kuaidinum | 是 | string | 快递单号 |
orderId | 否 | string | 快递公司订单号,对应下单时返回的kdComOrderNum,如果下单时有返回该字段,则取消时必填,否则可以不填 |
reason | 否 | string | 取消原因 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
success | boolean | 请求结果 | true提交成功,false失败 |
code | int | 返回编码 | 200-成功,其他为失败 |
message | String | 返回报文描述 | |
time | String | 时间 | 可忽略 |
data | Object |
1.4 提供数据内容
取消返回示例
{
"code": 200,
"message": "取消成功",
"time": 0,
"success": true
}
1.5 返回信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
-1 | 服务器错误 | 快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
200 | 提交成功 | 提交成功 |
30001 | 参数错误 | 请根据技术文档请求,注意参数类型及是否必填 |
30002 | 验证签名失败 | 检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号 |
30003 | 账号信息不正确 | 检查key是否正确 |
30005 | 取消失败 | 电子面单取消失败或者该快递公司不支持取消 |
30006 | 参数转换异常 | 按照描述可以自行检查参数的数据类型是否正确 |
二、支持的快递公司列表
快递公司名称 | 编码 |
---|---|
安能快运 | annengwuliu |
百世快运 | baishiwuliu |
汇森速运 | huisenky |
德邦快递 | debangkuaidi |
京东快递 | jd |
京广速递 | jinguangsudikuaijian |
极兔速递 | jtexpress |
跨越速运 | kuayue |
全一快递 | quanyikuaidi |
顺丰速运 | shunfeng |
顺丰快运 | shunfengkuaiyun |
速腾快递 | suteng |
顺心捷达 | sxjdfreight |
圆通承诺达 | ytchengnuoda |
韵达快递 | yunda |
韵达点通达 | yundadiantongda |
韵达快运 | yundakuaiyun |
京东快运 | jingdongkuaiyun |
邮政电商标快 | youzhengdsbk |
邮政包裹 | youzhengguonei |
中通快运 | zhongtongkuaiyun |
渡石冷链 | dushisc |
鸿华物流 | honghua |
正乾物流 | zhengqian |