文档中心
电子面单取消接口

电子面单取消接口

一、取消接口

通过快递公司或网点、菜鸟与淘宝提供的电子面单账号,对已经提交过的面单但没有寄发的面单号进行取消,快速回收面单。

1.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

1.2 请求地址

https://poll.kuaidi100.com/eorderapi.do

请求参数:

参数名是否必填类型说明
methodstring业务类型(默认:cancel)
keystring授权码,请申请企业版获取
signstring32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在企业管理后台查看
tstring时间戳如:1576123932000
paramparam由其他字段拼接

param数据结构:

参数名是否必填类型说明
partnerIdstring电子面单客户账户或月结账号,需贵司向当地快递公司网点申请(参考电子面单申请指南); 是否必填该属性,请查看参数字典
partnerKeystring电子面单密码,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
partnerSecretstring电子面单密钥,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
partnerNamestring电子面单客户账户名称,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
netstring收件网点名称,由快递公司当地网点分配, 若使用淘宝授权填入(taobao),使用菜鸟授权填入(cainiao), 使用京东授权填入(jdalpha),使用拼多多授权填入(pinduoduoWx)。 是否必填该属性,请查看参数字典 (若通过第三方授权方式获取单号partnerId,partnerKey参数为必填,参数值可通过第三方授权接口获取)
codestring电子面单承载编号,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
kuaidicomstring快递公司的编码,一律用小写字母,见参数字典
kuaidinumstring快递单号
orderIdstring快递公司订单号
reasonstring取消原因

1.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messageString返回报文描述

1.4 提供数据内容

取消返回示例

{
  "result": true,
  "returnCode": "200",
  "message": "取消成功"
}

1.5 返回信息代码含义

信息代码信息内容描述原因及建议处理方式
200成功取消成功
201取消失败可能调用过期或复打次数超过限制
400参数错误请根据技术文档请求,注意参数类型及是否必填。
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
503签名验证失败检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号

1.6 支持快递公司列表

快递公司名称编码
安能快递ane66
安能物流annengwuliu
百世快运baishiwuliu
百世快递huitongkuaidi
丰网速运fengwang
德邦快递debangkuaidi
京东快递jd
京广速递jinguangsudikuaijian
极兔速递jtexpress
跨越速运kuayue
全一快递quanyikuaidi
顺丰速运shunfeng
顺丰快运shunfengkuaiyun
速腾快递suteng
顺心捷达sxjdfreight
天天快递tiantian
圆通承诺达ytchengnuoda
韵达快递yunda
韵达点通达yundadiantongda
韵达快运yundakuaiyun