快递鸟一次性对接600+物流接口

API服务
首页>API服务>电子面单API

API组件列表
下单类接口
电子面单APIAlternate Text
上门取件API
预约取件API
代收货款API
查询类接口
即时查询API
物流跟踪API
在途监控API
快递查询API
增值类接口
物流短信API
单号识别API
物流评价API
实名寄递API
外部调用
轨迹查询结果页嵌入
轨迹查询框嵌入
寄快递页面嵌入
首页 > API文档 > 电子面单API
电子面单API
申请API
电子面单API为用户提供电子面单下单服务，快递鸟连接多家物流公司，一次接入即可对接多家物流公司电子面单下单通道，为订单信息化、标准化提供保障服务。用户接通快递鸟电子面单API，即可直接下单顺丰、EMS、宅急送、邮政快递包裹等七家公司面单，无需申请开通其他服务。
应用场景功能说明使用流程API参数接入流程demo下载
应用场景
快递公司支持情况
顺丰速运、EMS、宅急送、圆通速递、百世快递、中通快递、韵达速递、申通快递、德邦快递、优速快递、京东快递、信丰物流、安能快递、国通快递、天天快递、跨越速运、邮政快递包裹、中铁快运、邮政国内标快、远成快运、全一快递、速尔快递、品骏快递。
快运公司支持情况
德邦快运、安能快运、京东快运、龙邦快运。
账号类型支持快递公司
无需申请直接打单顺丰（SF）、EMS（EMS）（仅支持广东省内发货）、宅急送（ZJS）、邮政快递包裹（YZPY）、中铁快运（ZTKY）、邮政国内标快（YZBK），全一快递（UAPEX）
月结账号直接打单德邦（DBL）、EMS（EMS）
快递鸟后台申请账号优速（UC）、韵达（YD）、圆通（YTO）、远成（YCWL）、安能（ANE）、百世快递（HTKY）
线下（网点）申请账号EMS（EMS）、中通（ZTO）、申通（STO）、德邦（DBL）、京东（JD）、信丰（XFEX）、国通（GTO）、天天快递（HHTT）、速尔快递（SURE）、品骏快递（PJ）
快运电子面单京东快运（JDKY）,安能快运（ANEKY）,德邦快运（DBLKY），龙邦快运（LB）。

更多快递公司，陆续接入中。
下单+打印
a)商家操作发货时同步订单的发/收件人信息、货物信息，通过接口直接发送到快递公司获取电子面单单号、大头笔、电子面单打印模板等信息。通过浏览器或CS结构客户端打印工具进行打印电子面单。
功能说明
使用流程
系统商对接使用流程下载打印组件
商家使用流程
API参数
一、接口描述/说明
1.电子面单接口
（1）电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口。
（2）为客户解决在线发货需求，商户通过网络选择快递公司发送请求通知快递公司有快递要发货。
（3） 客户把数据通过此接口转发到快递鸟，由快递鸟为您安排快递员上门取件的服务。
（4）订单编号（OrderCode）不可重复提交，重复提交系统会返回具体错误代码。
（5）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（6）接口地址： API测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/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）
2.订单取消接口
（1）只支持有成功下单记录的订单进行取消。
（2）只支持对未揽件的订单进行取消。
（3）订单取消后，订单号仍不可重复使用。
（4）订单取消后快递单号的回收规则以快递公司为准。
（5）接口地址： API测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/EOrderService
请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。R
EBusinessIDString商户ID，请在我的服务页面查看。R
RequestTypeString请求指令类型：1147R
DataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型：只支持JSON格式O
备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）
3.单号余量查询接口
请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。R
EBusinessIDString商户ID，请在我的服务页面查看。R
RequestTypeString请求指令类型：1127R
DataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型：只支持JSON格式O
备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）
4.客户号申请接口
请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。R
EBusinessIDString商户ID，请在我的服务页面查看。R
RequestTypeString请求指令类型：1127R
DataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型：只支持JSON格式O
备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）
5.客户号推送接口
（1）推送时会推送RequestType、RequestData和DataSign三个参数 (格式：RequestData={数据}&EBusinessID=1237100 &PushTime=2017-04-18 23:34:29&RequestType=1117) 。
请求系统级参数说明：
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。R
EBusinessIDString商户ID，请在我的服务页面查看。R
RequestTypeString请求指令类型：1117R
DataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。R
DataTypeString请求、返回数据类型：只支持JSON格式O
备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）
二、接口参数
1.电子面单接口
请求内容字段定义：
参数名称类型说明是否必须
MemberIDString（50）ERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识，用于区分其用户O
CustomerNameString(50)电子面单客户号，需要下载《快递鸟电子面单客户号参数对照表.xlsx》，参考对应字段传值O
CustomerPwdString(30)O
SendSiteString(30)O
SendStaffString(30)C
MonthCodeStringC
CustomAreaString(500)商家自定义区域C
WareHouseIDString(30)发货仓编码O
TransTypeInt(1)运输方式 1- 陆运 2- 空运 不填默认为1O
ShipperCodeString(10)快递公司编码 详细编码参考《快递鸟接口支持快递公司编码.xlsx》R
LogisticCodeString(30)快递单号(仅宅急送可用)O
ThrOrderCodeString(50)第三方订单号 (ShipperCode为JD且ExpType为1时必填)C
OrderCodeString(30)订单编号(自定义，不可重复)R
PayTypeInt(1)邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付(仅SF支持)R
ExpTypeString(2)快递类型：1-标准快件 ,详细快递类型参考《快递公司快递业务类型.xlsx》R
IsReturnSignBillInt(1)是否要求签回单 1- 要求 0-不要求O
OperateRequireString(20)签回单操作要求(如：签名、盖章、身份证复印件等)O
CostCost Double(5)快递运费O
OtherCostDouble(5)其他费用O
ReceiverCompanyString(30)收件人公司O
NameString(30)收件人R
TelString(20)电话与手机，必填一个R
MobileString(20)
PostCodeString(10)收件人邮编c
ProvinceNameString(20)收件省 (如广东省，不要缺少“省”；如是直辖市，请直接传北京、上海等； 如是自治区，请直接传广西壮族自治区等)R
CityNameString（20）收件市(如深圳市，不要缺少“市”； 如果是市辖区，请直接传北京市、上海市等)R
ExpAreaNameString（20）收件区/县(如福田区，不要缺少“区”或“县”)R
AddressString(100)收件人详细地址R
SenderCompanyString(30)发件人公司O
NameString(30)发件人R
TelString(20)电话与手机，必填一个R
MobileString(20)
PostCodeString(10)发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)C
ProvinceNameString(20)发件省 (如广东省，不要缺少“省”； 如是直辖市，请直接传北京、上海等； 如是自治区，请直接传广西壮族自治区等)R
CityNameString(20)发件市(如深圳市，不要缺少“市； 如是市辖区，请直接传北京市、上海市等”)R
ExpAreaNameString(20)发件区/县(如福田区，不要缺少“区”或“县”)R
AddressString(100)发件人详细地址R
IsNoticeInt(1)是否通知快递员上门揽件 0- 通知 1- 不通知 不填则默认为1O
StartDateDate上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有时间格式相同O
EndDateDateO
WeightDouble(10,3)包裹总重量kg 当为快运的订单时必填，不填时快递鸟将根据各个快运公司要求传对应的默认值C
QuantityInt(2)包裹数(最多支持30件) 一个包裹对应一个运单号，如果是大于1个包裹，返回则按照子母件的方式返回母运单号和子运单号R
VolumeDouble(20,3)包裹总体积m3 当为快运的订单时必填，不填时快递鸟将根据各个快运公司要求传对应的默认值C
RemarkString(60)备注O
AddServices
AddServiceNameString(20)增值服务名称
(数组形式，可以有多个增值服务)		C
ValueString(30)增值服务值C
CustomerIDString(30)客户标识（选填）O
Commoditys
CommodityGoodsNameString(100)商品名称R
GoodsCodeString(100)商品编码O
GoodsquantityInt(5)商品数量O
GoodsPriceDouble(10)商品价格O
GoodsWeightDouble(10,3)商品重量kgO
GoodsDescString(50)商品描述O
GoodsVolDouble(15,3)商品体积m3O
IsReturnPrintTemplateString(1)返回电子面单模板：0-不需要；1-需要O
IsSendMessageInt(1)是否订阅短信：0-不需要；1-需要O
TemplateSizeString(10)模板规格(默认的模板无需传值，非默认模板传对应模板尺寸)O
PackingTypeInt(2)包装类型(快运字段)默认为0； 0- 纸 1- 纤 2- 木 3- 托膜 4- 木托 99-其他C
DeliveryMethodInt(1)送货方式(快运字段)默认为0； 0- 自提 1- 送货上门（不含上楼） 2- 送货上楼C
返回参数定义：
参数名称类型说明必须要求
EBusinessIDString(10)用户IDR
OrderOrderCodeString(30)订单编号R
ShipperCodeString(10)快递公司编码R
LogisticCodeString(400)快递单号R
MarkDestinationString(20)大头笔O
OriginCodeString(20)始发地区域编码O
OriginNameString(20)始发地/始发网点O
DestinatioCodeString(20)目的地区域编码O
DestinatioNameString(20)目的地/到达网点O
SortingCodeString(20)分拣编码O
PackageCodeString(20)集包编码O
PackageNameString(50)集包地O
DestinationAllocationCentreString(50)目的地分类O
SuccessBool(10)成功与否(true/false)R
SignWaybillCodeString(15)签回单单号O
ResultCodeString(5)返回编码R
ReasonString(50)失败原因O
UniquerRequestNumberString(50)唯一标识R
PrintTemplateString面单打印模板内容(html格式)O
EstimatedDeliveryTimeDate订单预计到货时间yyyy-mm-ddO
SubCountInt(5)子单数量O
SubOrdersString(400)子单单号O
SubPrintTemplatesString(2000)子单模板内容(html格式)O
SignBillPrintTemplateString(2000)签回单模板内容(html格式)O
ReceiverSafePhoneString(20)收件人安全电话O
SenderSafePhoneString(20)收件人安全电话O
DialPageString(50)拨号页面网址(转换成二维码可扫描拨号)O
示例
请求示例 JSON
{
                          "OrderCode": "012657018199",
                          "ShipperCode": "SF",
                          "PayType": 1,
                          "MonthCode": "1234567890",
                          "ExpType": 1,
                          "Cost": 1.0,
                          "OtherCost": 1.0,
                          "Sender": {
                            "Company": "LV",
                            "Name": "Taylor",
                            "Mobile": "15018442396",
                            "ProvinceName": "上海",
                            "CityName": "上海市",
                            "ExpAreaName": "青浦区",
                            "Address": "明珠路"
                          },
                          "Receiver": {
                            "Company": "GCCUI",
                            "Name": "Yann",
                            "Mobile": "15018442396",
                            "ProvinceName": "北京",
                            "CityName": "北京市",
                            "ExpAreaName": "朝阳区",
                            "Address": "三里屯街道"
                          },
                          "Commodity": [
                            {
                              "GoodsName": "鞋子",
                              "GoodsQuantity": 1,
                              "GoodsWeight": 1.0
                        },
                        {
                           "GoodsName": "衣服",
                           "GoodsQuantity": 1,
                           "GoodsWeight": 1.0
                        },
                          ],
                          "AddService": [
                            {
                              "Name": " INSURE ",
                              "Value": "1000"
                        },
                            {
                              "Name": "COD",
                              "Value": "1020"
                        " CustomerID ": "1234567890"
                            }
                          ],
                          "Weight": 1.0,
                          "Quantity": 1,
                          "Volume": 0.0,
                          "Remark": "小心轻放"
                        }
返回示例 JSON
失败：
                           {
                              "EBusinessID": "1237100",
                              "ResultCode": "106",
                              "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",
                            "Success": true,
                            "ResultCode": "100",
                            "Reason": "成功"
                          }
2.订单取消接口
请求内容字段定义：
参数名称类型说明是否必须
ShipperCodeString快递公司编码R
OrderCodeString订单编号R
ExpNoString快递单号R
CustomerNameString电子面单客户号O
CustomerPwdString电子面单密码O
返回参数定义：
参数名称类型说明必须要求
EBusinessIDString用户IDR
SuccessBool成功与否(true/false)R
ResultCodeString返回编码R
ReasonString失败原因O
示例
请求示例 JSON
{
                        "ShipperCode": "UC",
                    "OrderCode": "TEST201209211045",
                    "ExpNo": "900008664480",
                        "CustomerName": "80238728",
                        "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b"
                    }
返回示例 JSON
{
                          "EBusinessID": "1237100",
                          "Success": true,
                          "ResultCode": "100"
                        }
3.单号余量查询接口
请求内容字段定义：
参数名称类型说明是否必须
ShipperCodeString快递公司编码R
CustomerNameString电子面单客户号O
CustomerPwdString电子面单密码O
StationCodeString网点编码R
StationNameString网点名称R
返回参数定义：
参数名称类型说明必须要求
EBusinessIDString用户IDR
SuccessBool成功与否(true/false)R
ReasonString失败原因O
ResultCodeString返回编码R
TotalNumInt(10)累计充值数量，电子面单总量(包含已使用/未使用)O
AvailableNumSInt(10)剩余可用量O
示例
请求示例 JSON
{
                    "ShipperCode": "UC",
                    "CustomerName": "80238728",
                    "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a81",
                    "StationCode": "3001",
                    "StationName": "福田网点"
                }
返回示例 JSON
{
                  "EBusinessID": "1237100",
                  "Success": true,
                  "Reason": "",
                  "ResultCode": "100",
                  "EorderBalance": {
                    "AvailableNum": 0,
                                        "TotalNum": 0
                  }
                }
4.客户号申请接口
请求内容字段定义：
参数名称类型说明是否必须
ShipperCodeString快递公司编码R
StationCodeString网点编码R
StationNameString网点名称R
ApplyIDString申请ID(用户记录在快递公司的标识)O
CompanyString公司名称O
NameString联系人O
TelString电话C
MobileString手机C
ProvinceNameString省份R
ProivnceCodeString省份编码O
CityNameString城市R
CityCodeString城市编码O
ExpAreaNameString区县R
ExpAreaCodeString区县编码O
AddressString详细地址R
返回参数定义：
参数名称类型说明必须要求
EBusinessIDString用户IDR
ApplyCodeString客户编号R
SuccessBool成功与否(true/false)R
ReasonString失败原因O
ResultCodeString返回编码O
示例
请求示例 JSON
{
    "ShipperCode": "UC",
    "Company": "快递鸟",
    "ApplyID": "1237100",
    "Name": "hoo123",
    "Tel": "07558812345",
    "Mobile": "15612344567",
    "ProvinceName": "广东省",
    "ProivnceCode": "440000",
    "CityName": "深圳市",
    "CityCode": "440300",
    "ExpAreaName": "宝安区",
    "ExpAreaCode": "440306",
    "Address": "西乡1路",
    "StationCode": "西乡网点",
    "StationName": "西乡网点"
}
返回示例 JSON
{
  "EBusinessID": "1237100",
  " ApplyCode ": "test123456",
  "Success": true,
  "Reason": "提交申请成功",
  "ResultCode": "100"
}
5.客户号推送接口
请求内容字段定义：
参数名称类型说明是否必须
ApplyCodeString客户编号R
CustomerNameString电子面单客户号R
CustomerPwdString电子面单密码R
StationCodeString网点编码R
StationNameString网点名称R
返回参数定义：
参数名称类型说明必须要求
EBusinessIDString用户IDR
RequestTypeString接口指令R
SuccessBool成功与否(true/false)R
MessageString返回消息O
示例
请求示例 JSON
{
                  " ApplyCode ": "test123456",
                  "CustomerName": "80237910",
                  "CustomerPwd": "c0bfe0ba86b66bae5426303c53db0a8b",
                  "StationCode": "闵行八部",
                  "StationName": "闵行八部"
                }
返回示例 JSON
{
                    "EBusinessID": "1237100",
                    "Message": "成功",
                    "RequestType": "1117",
                    "Success": true
                }
接入流程
demo下载
接口接入技术文档
电子面单接口Demo工具.NET版
电子面单接口Demo工具.PHP版
电子面单接口Demo工具.JAVA版
接口接入技术文档
电子面单批量打印Demo工具.JAVA版
电子面单批量打印Demo工具.NET版
电子面单批量打印Demo工具PHP版

相关文档与更多帮助？

30万+
数十万客户的选择
5.8亿次+
日均处理物流数据次数
1450万+
日均千万订单数据处理
600家+
支持全国600+家物流商

解决方案

自营商城解决方案电商平台解决方案ERP系统商解决方案国际物流解决方案WMS系统商解决方案工具类APP解决方案智能楼宇解决方案快递柜/驿站解决方案

产品服务

在线预约取件电子面单服务物流轨迹查询物流节点短信代收货款服务上门取件隐私快递智选物流物流体检

API文档

API接口文档DEMO下载技术文档下载插件下载快递鸟API接口

帮助与支持

免费注册会员套餐服务常见问题FAQ

关于我们

公司介绍新闻公告联系我们法律声明合作伙伴

联系我们

合作咨询：400-9633-321E-mail：service@kdniao.com
加入QQ群：快递鸟API技术对接群14
快金数据：收派宝快递鸟快递发发快递安全联盟
版权所有：深圳市快金数据技术服务有限公司  粤ICP备15010928号增值电信业务许可证：粤B2-20180811粤公安备案号：44030402002993
在线咨询
商务合作群:
1054978381
技术对接群11:
844089794
400-9633-321
免费获取API