打印类接口
-云打印API(new)
-电子面单API
物流跟踪类接口
-订阅推送API
-实时查询API
增值服务接口
-短信接口API
-智能识别API
寄件服务接口
-B端寄件API

B端寄件API

1. B端服务API产品介绍

B端服务API是专为寄件企业及快递公司运力提供的一套解决方案。通过接口可以满足企业、电商、微商、快递网点、代收点等用户的下单后,价格低廉,自动分配快递员取件的解决方案。

2. 接口说明
2.1 B端下单接口
选择快递公司进行下单。
2.1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
2.1.2 请求地址
https://poll.kuaidi100.com/order/borderapi.do
请求参数:
参数名 是否必填 类型 说明
method string 业务类型(默认:bOrder)
key string 授权码,请到快递100页面申请企业版接口获取 https://api.kuaidi100.com/register/enterprise
sign string 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在授权邮件里面有
t string 时间戳如:1576123932000
param param 由其他字段拼接
param数据结构:
参数名 是否必填 类型 说明
kuaidicom string 快递公司的编码,一律用小写字母,见快递公司编码
recManName string 收件人姓名
recManMobile string 收件人的手机号,手机号和电话号二者其一必填
recManPrintAddr string 收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园
sendManName string 寄件人姓名
sendManMobile string 寄件人的手机号,手机号和电话号二者其一必填
sendManPrintAddr string 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10
callBackUrl string callBackUrl订单信息回调
cargo string 物品名称,例:文件
payment string 支付方式,SHIPPER: 寄付(默认)
weight string 物品总重量KG,例:1.5,单位kg
remark string 备注
salt string 签名用随机字符串
dayType string 预约日期,例如:今天/明天/后天
pickupStartTime string 预约起始时间(HH:mm),例如:09:00
pickupEndTime string 预约截止时间(HH:mm),例如:10:00
2.1.3 返回结果
字段 类型 说明 备注
result boolean 提交结果 true提交成功,false失败
returnCode string 返回编码
message string 返回报文描述
data data
data数据结构
字段 类型 说明 备注
taskId string 任务ID
orderId string 订单ID

2.1.4 提供数据内容

{  
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"taskId": "****", //任务ID "orderId": "****", //订单ID }
}
说明:
  200: 提交成功
  400: 参数错误等
  500: 服务器错误(即快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误)
  501: 重复提交
  503: 验证签名失败
  600: 您不是合法的用户(即授权Key出错)
  601: KEY已过期
  700: 错误的回调地址
2.2 下单回调接口
订单有状态变更是会触发回调,回调后如果没有得到合作方正确返回,会重复回调多2次,即最多回调3次。间隔30分钟。
2.2.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8
2.2.2 请求地址
请求参数:
字段 类型 说明 备注
taskId string 任务ID
sign string 签名 MD5 (param +salt)
param param 参数主体
param数据结构:
参数名 是否必填 类型 说明
kuaidicom string 快递公司的编码,一律用小写字母,见《快递公司编码》,选填。
kuaidinum string 快递单号,单号的最大长度是32个字符。
status string 状态码
message string 状态描述
data data 订单内容
data数据结构:
参数名 是否必填 类型 说明
orderId string 平台订单ID
status string 订单状态:
'0,'下单成功',
1,'已接单',
2,'收件中',
9,'用户主动取消',
10,'已取件',
11,'揽货失败',
12,'已退回',
13,'已签收',
14,'异常签收',
99,'订单已取消'
courierName string 快递员姓名
courierMobile string 快递员电话
weight string 重量
freight string 运费
2.2.3 返回结果
字段 说明 备注
result 提交结果 true提交成功,false失败
returnCode 返回编码
message 返回报文描述
2.2.4 提供数据内容
{  
"result": true,
"returnCode": "200",
"message": "成功"
}
说明:
  200: 成功
  500: 服务器错误
  其他错误请自行定义
result:true表示回调成功,false表示失败,如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃。
其他信息快递100会忽略。
2.3 B端下单取消接口
对下完单进行取消操作
2.3.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
2.3.2 请求地址
https://poll.kuaidi100.com/order/borderapi.do
请求参数:
参数名 是否必填 类型 说明
method string 业务类型(默认:cancel)
key string 授权码,请到快递100页面申请企业版接口获取 https://api.kuaidi100.com/register/enterprise
sign string 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在授权邮件里面有
t string 时间戳如:1576123932000
param param 由其他字段拼接
param数据结构:
参数名 是否必填 类型 说明
taskId string 任务ID
orderId string 订单ID
cancelMsg string 取消原因,例:暂时不寄件了
2.3.3 返回结果
字段 类型 说明 备注
result boolean 提交结果 true提交成功,false失败
returnCode string 返回编码
message string 返回报文描述
data data 这里默认为空
2.3.4 提供数据内容
{  
"result": true,
"returnCode": "200",
"message": "取消成功", "data": {}
}
说明:
  200: 成功
  400: 参数错误等
  500: 服务器错误(即快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误)
  501: 重复提交
  503: 验证签名失败
  600: 您不是合法的用户(即授权Key出错)
  601: KEY已过期
  700: 错误的回调地址
3. 快递公司编码
快递公司 编码
德邦快递 debangkuaidi
京东物流 jd
中通快递 zhongtong
圆通快递 yuantong

关注快递100接口API