首页 > API文档 > 电子面单API
电子面单API
申请API
电子面单API为用户提供电子面单下单服务,快递鸟连接多家物流公司,一次接入即可对接多家物流公司电子面单下单通道,为订单信息化、标准化提供保障服务。用户接通快递鸟电子面单API,即可直接下单顺丰、EMS、宅急送、快捷、邮政包裹五家公司面单,无需申请开通其他服务。
应用场景
目前接口支持了:顺丰(SF)、EMS(EMS)、宅急送(ZJS)、圆通(YTO)、百世快递(HTKY)、中通(ZTO)、韵达(YD)、申通(STO)、德邦(DBL)、优速(UC)、京东(JD)、信丰(XFEX)、全峰(QFKD)、跨越速运(KYSY)、安能小包(ANE)、快捷快递(FAST)、国通(GTO)、天天快递(HHTT)、邮政快递包裹(YZPY)、中铁快运(ZTKY),后续更多的快递公司正在对接中。

无需申请直接打单:顺丰(SF)、EMS(EMS)(仅支持广东省内发货)、快捷快递(FAST)、宅急送(ZJS)、邮政快递包裹(YZPY)、中铁快运(ZTKY)。
月结账号直接打单:德邦(DBL)、EMS(EMS)(全国)。
线上(快递鸟后台)申请账号:优速(UC)、韵达(YD)、圆通(YTO)、远成(YCWL)。
线下(网点)申请账号:EMS(EMS)、百世快递(HTKY)、中通(ZTO)、申通(STO)、德邦(DBL)、京东(JD)、信丰(XFEX)、全峰(QFKD)、跨越速运(KYSY)、国通(GTO)、天天快递(HHTT)。
余量查询接口支持快递公司:中通(ZTO)、韵达(YD)、优速(UC)、百世快递(HTKY)。
面单取消接口支持快递公司:顺丰(SF)、韵达(YD)、优速(UC)、百世快递(HTKY)。
更多快递公司,陆续接入中。
下单+打印
a)商家操作发货时同步订单的发/收件人信息、货物信息,通过接口直接发送到快递公司获取电子面单单号、大头笔、电子面单打印模板等信息。通过浏览器或CS结构客户端打印工具进行打印电子面单。
功能说明
使用流程
系统商对接使用流程
商家使用流程
API参数
一、接口描述/说明
(1)电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口。
(2)为客户解决在线发货需求,商户通过网络选择快递公司发送请求通知快递公司有快递要发货。
(3) 客户把数据通过此接口转发到快递鸟,由快递鸟为您安排快递员上门取件的服务。
(4)订单编号(OrderCode)不可重复提交,重复提交系统会返回具体错误代码。
(5)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"
(6)接口地址: API测试地址:http://testapi.kdniao.cc:8081/api/EOrderService
API正式地址:http://api.kdniao.cc/api/EOrderService
请求系统级参数说明:
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。R
EBusinessIDString商户ID,请在我的服务页面查看。R
RequestTypeString请求指令类型:1007R
DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型:只支持JSON格式O
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
二、接口参数
请求内容字段定义:
参数名称类型说明是否必须
CallBackString用户自定义回调信息O
MemberIDString会员标识O
CustomerNameString电子面单客户账号(与快递网点申请)O
CustomerPwdString电子面单密码O
SendSiteString收件网点标识O
ShipperCodeString快递公司编码R
LogisticCodeString快递单号O
OrderCodeString订单编号R
ThrOrderCodeString第三方订单编号O
MonthCodeString月结编码C
PayTypeInt邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付R
ExpTypeString快递类型:1-标准快件R
IsNoticeInt是否通知快递员上门揽件:0-通知;1-不通知;不填则默认为0O
CostDouble寄件费(运费)O
OtherCostDouble其他费用O
ReceiverCompanyString收件人公司O
NameString收件人R
TelString电话与手机,必填一个R
MobileString
PostCodeString收件人邮编O
ProvinceNameString收件省(如广东省,不要缺少“省”)R
CityNameString收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString收件区(如福田区,不要缺少“区”或“县”)O
AddressString收件人详细地址R
SenderCompanyString发件人公司O
NameString发件人R
TelString电话与手机,必填一个R
MobileString
PostCodeString发件人邮编O
ProvinceNameString发件省(如广东省,不要缺少“省”)R
CityNameString发件市(如深圳市,不要缺少“市”)R
ExpAreaNameString发件区(如福田区,不要缺少“区”或“县”)O
AddressString发件人详细地址R
StartDateString上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同O
EndDateStringO
WeightDouble物品总重量kgO
QuantityInt件数/包裹数O
VolumeDouble物品总体积m3O
RemarkString备注O
AddServices
AddServiceNameString增值服务名称O
ValueString增值服务值O
CustomerIDString客户标识(选填)O
Commoditys
CommodityGoodsNameString商品名称R
GoodsCodeString商品编码O
GoodsquantityInt商品数量O
GoodsPriceDouble商品价格O
GoodsWeightDouble商品重量kgO
GoodsDescString商品描述O
GoodsVolDouble商品体积m3O
IsReturnPrintTemplateString返回电子面单模板:0-不需要;1-需要O
返回参数定义:
参数名称类型说明必须要求
EBusinessIDString用户IDR
OrderOrderCodeString订单编号R
ShipperCodeString快递公司编码R
LogisticCodeString快递单号R
MarkDestinationString大头笔O
OriginCodeString始发地区域编码O
OriginNameString始发地/始发网点O
DestinatioCodeString目的地区域编码O
DestinatioNameString目的地/到达网点O
SortingCodeString分拣编码O
PackageCodeString集包编码O
SuccessBool成功与否R
ResultCodeString错误编码R
ReasonString失败原因O
UniquerRequestNumberString唯一标识R
PrintTemplateString面单打印模板O
EstimatedDeliveryTimeString订单预计到货时间yyyy-mm-ddO
CallbackString用户自定义回调信息O
SubCountInt子单数量O
SubOrdersString子单号O
SubPrintTemplatesString子单模板O
三、示例
请求示例 JSON
{
                "OrderCode": "012657700387",
                "ShipperCode": "HTKY",
                "PayType": 1,
                "ExpType": 1,
                "Cost": 1.0,
                "OtherCost": 1.0,
                "Sender": {
                  "Company": "LV",
                  "Name": "Taylor",
                  "Mobile": "15018442396",
                  "ProvinceName": "上海",
                  "CityName": "上海",
                  "ExpAreaName": "青浦区",
                  "Address": "明珠路73号"
                },
                "Receiver": {
                  "Company": "GCCUI",
                  "Name": "Yann",
                  "Mobile": "15018442396",
                  "ProvinceName": "北京",
                  "CityName": "北京",
                  "ExpAreaName": "朝阳区",
                  "Address": "三里屯街道雅秀大厦"
                },
                "Commodity": [
                  {
                    "GoodsName": "鞋子",
                    "Goodsquantity": 1,
                    "GoodsWeight": 1.0
                  }
                ],
                "AddService": [
                  {
                    "Name": "COD",
                    "Value": "1020"
                  }
                ],
                "Weight": 1.0,
                "Quantity": 1,
                "Volume": 0.0,
                "Remark": "小心轻放",
                "IsReturnPrintTemplate":1
                }
返回示例 JSON
失败:
                  {
                      "EBusinessID": "1237100",
                      "ResultCode": "105",
                      "Reason": "订单号已存在,请勿重复操作",
                      "UniquerRequestNumber":"5e66486b-8fbc-4131-b875-9b13d2ad1354"
                  }
                  成功:
                  {
                    "EBusinessID": "1237100",
                    "Order": {
                      "OrderCode": "012657700387",
                      "ShipperCode": "HTKY",
                      "LogisticCode": "50002498503427",
                      "MarkDestination": "京-朝阳(京-1)",
                      "OriginCode": "200000",
                      "OriginName": "上海分拨中心",
                      "PackageCode": "北京"
                    },
                    "PrintTemplate":"此处省略打印模板HTML内容",
                    "EstimatedDeliveryTime":"2016-03-06",
                    "Callback":"调用时传入的Callback",
                    "Success": true,
                    "ResultCode": "100",
                    "Reason": "成功"
                  }
接入流程
demo下载

相关文档与更多帮助?

30万+
数十万客户的选择
5.8亿次+
日均处理物流数据次数
1450万+
日均千万订单数据处理
418家+
支持全国418家物流商
在线咨询
商务合作群:
526574204
技术对接群:
620453345
400-9633321
免费获取API