首页 > 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
请求系统级参数说明:
参数名称 类型 说明 必须要求
RequestData String 请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。 R
EBusinessID String 商户ID,请在我的服务页面查看。 R
RequestType String 请求指令类型:1007 R
DataSign String 数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。 R
DataType String 请求、返回数据类型:只支持JSON格式 O
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
二、接口参数
请求内容字段定义:
参数名称 类型 说明 是否必须
CallBack String 用户自定义回调信息 O
MemberID String 会员标识 O
CustomerName String 电子面单客户账号(与快递网点申请) O
CustomerPwd String 电子面单密码 O
SendSite String 收件网点标识 O
ShipperCode String 快递公司编码 R
LogisticCode String 快递单号 O
OrderCode String 订单编号 R
ThrOrderCode String 第三方订单编号 O
MonthCode String 月结编码 C
PayType Int 邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付 R
ExpType String 快递类型:1-标准快件 R
IsNotice Int 是否通知快递员上门揽件:0-通知;1-不通知;不填则默认为0 O
Cost Double 寄件费(运费) O
OtherCost Double 其他费用 O
Receiver Company String 收件人公司 O
Name String 收件人 R
Tel String 电话与手机,必填一个 R
Mobile String
PostCode String 收件人邮编 O
ProvinceName String 收件省(如广东省,不要缺少“省”) R
CityName String 收件市(如深圳市,不要缺少“市”) R
ExpAreaName String 收件区(如福田区,不要缺少“区”或“县”) O
Address String 收件人详细地址 R
Sender Company String 发件人公司 O
Name String 发件人 R
Tel String 电话与手机,必填一个 R
Mobile String
PostCode String 发件人邮编 O
ProvinceName String 发件省(如广东省,不要缺少“省”) R
CityName String 发件市(如深圳市,不要缺少“市”) R
ExpAreaName String 发件区(如福田区,不要缺少“区”或“县”) O
Address String 发件人详细地址 R
StartDate String 上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同 O
EndDate String O
Weight Double 物品总重量kg O
Quantity Int 件数/包裹数 O
Volume Double 物品总体积m3 O
Remark String 备注 O
AddServices
AddService Name String 增值服务名称 O
Value String 增值服务值 O
CustomerID String 客户标识(选填) O
Commoditys
Commodity GoodsName String 商品名称 R
GoodsCode String 商品编码 O
Goodsquantity Int 商品数量 O
GoodsPrice Double 商品价格 O
GoodsWeight Double 商品重量kg O
GoodsDesc String 商品描述 O
GoodsVol Double 商品体积m3 O
IsReturnPrintTemplate String 返回电子面单模板:0-不需要;1-需要 O
返回参数定义:
参数名称 类型 说明 必须要求
EBusinessID String 用户ID R
Order OrderCode String 订单编号 R
ShipperCode String 快递公司编码 R
LogisticCode String 快递单号 R
MarkDestination String 大头笔 O
OriginCode String 始发地区域编码 O
OriginName String 始发地/始发网点 O
DestinatioCode String 目的地区域编码 O
DestinatioName String 目的地/到达网点 O
SortingCode String 分拣编码 O
PackageCode String 集包编码 O
Success Bool 成功与否 R
ResultCode String 错误编码 R
Reason String 失败原因 O
UniquerRequestNumber String 唯一标识 R
PrintTemplate String 面单打印模板 O
EstimatedDeliveryTime String 订单预计到货时间yyyy-mm-dd O
Callback String 用户自定义回调信息 O
SubCount Int 子单数量 O
SubOrders String 子单号 O
SubPrintTemplates String 子单模板 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