-
免费快递在线下单接口对接文档
1.1
在线下单接口
1.1.1
功能说明
电商管理后台的物流系统，仓管在
处理订单发货时同步订单的发
/
收件人信息、货物
信息，通过接口直接发送到快递公司
1.1.2
接口规则
(1)
、
订单编号
(OrderCode)
不可重复提交，重复提交系统
会返回具体错误代码。
(2)
、支持主流快递公司在线下单，请联系技术人员
(
联系方式请
看文档尾部
)
。
(3)
、接口只支持
Json
格式参数，接口指令
1001
。只支持
POST
请求方式，
utf-8
编
码。
(4)
、支持增值服务，保价、代收货款、货款直退、货款垫付等。
(5)
、接口提供：快递鸟
(6)
、测试地址：
:8081/api/oo
rderservice/
(7)
、正式地址：
/api/oorderservice
1.1.3
系统级输入参数
参数名称
RequestData
EBusinessID
RequestType
DataSign
DataType
类型
String
String
String
String
String
是否必须
R
R
R
R
O
描述
请求内容，
JSON
格式
,
须和
DataType
一
致
电商
ID
请求指令类型：
1001
数据内容签名
请求、返回数据类型：
2-json
；
1.1.4
应用级输入参数
参数名称
WarehouseID
类型
String
是否必须
O
描述
仓库标识
(
备用字段
)
WarehouseAddress
CallBack
MemberID
ShipperCode
LogisticCode
OrderCode
MonthCode
String
String
String
String
String
String
String
O
O
O
R
O
R
C
仓库地址
(
备用字段
)
商户标识
(
备用字段
) <
/p>
会员标识
(
备用字段
)
快递公司编码
快递单号
订单编号
月结编码
邮费支付方式
:
PayType
Int
R
1-
现付，
2-
到付，
3-
月结，
4-
第三方支付
ExpType
Cost
OtherCost
Company
Name
Tel
Mobile
PostCode
Receiver
ProvinceName
Int
Double
Double
String
String
String
R
O
O
O
R
R
快递类型：
1-
< br>标准快件
寄件费（运费）
其他费用
收件人公司
收件人
电话与手机，必填一个
收件人邮编
收件省（如广东省，不要缺
String
String
String
O
R
少“省”
）
收件市（如深圳市，不要缺
CityName
String
R
少“市”
）
收件区（如福田区，不要缺
ExpAreaName
Address
Company
Name
Sender
Tel
Mobile
String
String
String
String
String
O
少“区”或“县”
）
R
O
R
R
收件人详细地址
发件人公司
发件人
电话与手机，必填一个
String
PostCode
ProvinceName
String
String
O
O
发件人邮编
发件省（如广东省，不要缺
少“省”
）
发件市（如深圳市，不要缺
CityName
String
R
少“市”
）
发件区（如福田区，不要缺
ExpAreaName
Address
StartDate
String
String
String
O
少“区”或“县”
）
R
O
发件详细地址
上门取货时间段
:
格式
EndDate
String
O
化，本文中所有时间格式相
同
Weight
Quantity
Volume
Remark
Name
AddService
Value
CustomerID
Double
Int
Double
String
String
String
String
String
String
Int
Double
Double
String
Double
O
O
O
O
0
0
0
R
O
O
O
O
O
O
物品总重量
kg
件数
/
包裹数
物品总体积
m3
备注
增值服务名称
增值服务值
客户标识
(
选填
)
商品名称
商品编码
件数
商品价格
商品重量
kg
商品描述
商品体积
m3
GoodsName
GoodsCode
Goodsquantity
Commodity
GoodsPrice
GoodsWeight
GoodsDesc
GoodsVol
1.1.5
返回结果参数
参数名称
EBusinessID
OrderCode
Order
ShipperCode
类型
String
String
String
必须要求
R
R
R
O
R
R
O
R
电商用户
ID
订单编号
快递公司编码
快递单号
成功与否
结果编码
说明
LogisticCode
String
Success
ResultCode
Bool
String
String
String
Reason
UniquerRequestNumber
失败原因
唯一标识
1.1.6
Json
请求示例
{
上海
上海
青浦区
明珠路
},
北京
北京
朝阳区
三里屯街道
},
{
鞋子
}
],
{
}
],
小心轻放
}
1.1.7
Json
请求返回示例
{
},
}
1.2
取消订单（即将上线）
1.2.1
功能说明
物流公司还未指派业务员去取件的
物流订单可进行取消操作，撤销时需用户填写原因，
填写后快递鸟会通知物流公司取消订
单。
1.2.2
接口规则
(1)
、接口支持
< br>Json
格式。
(2)
、接口指令
1004
。
1.2.3
系统级输入参数
参数名称
RequestData
EBusinessID
RequestType
DataSign
DataType
类型
String
String
String
String
String
必须要求
R
R
R
R
O
说明
请求内容，
JSON
格式
,
须和
DataType
一致
电商
ID
请求指令类型：
1004
数据内容签名
请求、返回数据类型：
2-json
；
1.2.4
应用级输入参数
参数名称
OrderCode
ShipperCode
LogisticCode
类型
String
String
String
必须要求
R
R
R
订单编号
物流公司编码
物流单号
说明
1.2.5
返回结果参数
参数名称
EBusinessID
OrderCode
ShipperCode
LogisticCode
Success
Reason
类型
String
String
String
String
Bool
String
R
R
R
R
R
O
必须要求
说明
电商用户
ID
订单编号
快递公司编码
快递单号
成功与否：
true,false
失败原因
1.2.6
JSON
请求示例
{
}
1.2.7
JSON
返回示例
{
订单取消失败
}
1.3
电子面单
1.3.1
功能说明
电子面单接口是快递鸟提供
给独立电商、仓储管理系统、物流供应链等物流系统平台
使用的下单接口，
满足客户在线发货需求并提供打印面单的服务，
客户通过网络选择物流公
司发送请求通知贵公司有快递要发货，
贵公司把数据通过此接口转发
到快递鸟，
由快递鸟为
您通知对应的快递公司快递员上门取件。
电子面单成功下单后，快递鸟系统内将自动订阅，一旦轨迹发
生变化时，快递鸟将调
用客户方推送接收接口。
同时若客户使用
代收货款服务，
快递鸟会将代收货款的货款状态独
立推送给用户
。
1.3.2
接口规则
(1)
、
只支持
Json
格式
< br>。接口指令
1007
。
(2)
、测试地址：
:8081/api/e
orderservice/
(3)
、正式地址：
/api/EOrderService
1.3.3
系统级输入参数
参数名称
RequestData
类型
String
必须要求
R
一致
说明
请求内容，
JSON
格式
,
须和
DataType
E
BusinessID
RequestType
DataSign
DataType
String
String
String
String
R
R
R
O
电商
ID
请求指令类型：
1007
数据内容签名
请求、返回数据类型：
2-json
1.3.4
应用级输入参数
参数名称
CallBack
类型
String
是否必须
O
描述
用户自定义回调信息
会员标识
MemberID
String
O
平台方与快递鸟统
一用户标识
的商家
ID
电子面单客户账号
CustomerName
String
String
String
String
String
String
String
O
（与快递网点申请）
CustomerPwd
SendSite
O
O
R
O
R
C
电子面单密码
收件网点标识
ShipperCode
LogisticCode
OrderCode
MonthCode
快递公司编码
快递单号
订单编号
月结编码
邮费支付方式
:
PayType
Int
R
1-
现付，
2-
到付，
3-
月结，
4-
第
三方支付<
/p>
ExpType
IsNotice
Cost
OtherCost
Company
Receiver
Name
String
Int
Double
Double
String
String
R
O
快递类型：
1-
< br>标准快件
是否通知快递员上门揽件：
< br>0-
通
知；
1-
不通知；不填则默认为
0
O
O
O
R
寄件费（运费）
其他费用
收件人公司
收件人
Tel
Mobile
PostCode
ProvinceName
String
R
String
String
String
O
R
“省”
）
收
件市（如深圳市，不要缺少
收件人邮编
收件省（如广东省，不要缺少
电话与手机，必填一个
CityName
String
R
“市”
）
收件区（如福田区，不要缺少
ExpAreaName
Address
Company
Name
Tel
Mobile
PostCode
Sender
ProvinceName
String
String
String
String
String
O
“区”或“县”
）
R
O
R
R
收件人详细地址
发件人公司
发件人
电话与手机，必填一个
发件人邮编
发件省（如广东省，不要缺少
String
String
String
O
R
“省”
）
发件市（如深圳市，不要缺少
CityName
String
R
“市”
）
发件区（如福田区，不要缺少
ExpAreaName
Address
StartDate
EndDate
Weight
Quantity
Volume
Remark
String
String
String
String
Double
Int
Double
String
O
“区”或“县”
）
R
O
O
本文中所有时间格式相同
O
O
O
O
物品总重量
kg
件数
/
包裹数
物品总体积
m3
备注
发件详细地址
上门取货时间段
:
< br>HH:mm:ss
格式化，
Name
AddService
Value
CustomerID
String
String
String
String
String
Int
Double
Double
String
Double
String
0
0
0
R
O
O
O
O
O
O
O
增值服务名称
增值服务值
客户标识
(
选填
)
商品名称
商品编码
件数
商品价格
商品重量
kg
商品描述
商品体积
m3
返回电子面单模板：
GoodsName
GoodsCode
Goodsquantity
Commodity
GoodsPrice
GoodsWeight
GoodsDesc
GoodsVol
IsReturnPrintTemplate
0-
不需要；
1-
需要
1.3.5
返回结果参数
?
同步返回
参数名称
EBusinessID
OrderCode
ShipperCode
LogisticCode
MarkDestinatio
n
Order
OriginCode
OriginName
类型
必须要求
电商用户
ID
订单编号
快递公司编码
快递单号
大头笔
说明
String
R
String
R
String
R
String
R
String
O
String
O
String
O
始发地区域编码
始发地
/
始发网点
目的地区域编码
目的地
/
到达网点
分拣编码
集包编码
DestinatioCode
String
O
DestinatioName
String
O
SortingCode
PackageCode
String
O
String
O
Bool
R
Success
成功与否
ResultCode
String
R
String
O
String
R
String
O
String
O
String
O
错误编码
Reason
UniquerRequestNumber
失败原因
唯一标识
面单打印模板
订单预计到货时间
yyyy-mm-dd
用户自定义回调信息
PrintTemplate
EstimatedDeliveryTime
Callback
1.4
增值服务列表
名称
代码
说明
Value
为货款，保留
3
位小数。
CustomerID
为代收货款卡号
value
为声明价值，保留
3
位小数
备注
代收货款
COD
保价
INSURE
注：
使用快递鸟代收货
款服务，
需申请快递鸟的代收货款服务，
填写用于还款的银行卡
号等
信息。
1.5
.NET
对接
using System;
using c;
using
using
using
using
using
namespace KdGoldAPI
{
public class KdApiCreateOrderDemo
{
//
电商
ID
private string EBusinessID =
//
电商加密私钥，快递鸟提供，注意保管，不要泄漏
private string AppKey =
//
请求
url
private string ReqURL =
///
///
Json
方式
在线下单
///
///
public string orderOnlineByJson()
{
string requestData =
尽快上门收件
',
华为科技
',
张三
',
深圳市南山区桂庙路
555
号
',
广东省
',
深圳市
',
南山区
',
小米科技
',
李四
',
深圳市福田区华强北路
222
号
',
广东省
',
深圳市
',
福田区
',
手机屏幕
',
Dictionary