快递鸟
  1. 电子面单API
快递鸟
  • 电子面单API
    • 应用场景/功能说明/使用流程
    • 电子面单接口
      POST
    • 订单取消接口
      POST
    • 单号余量查询接口
      POST
    • 客户号申请接口
      POST
  • 上门取件API
    • 应用场景/功能说明/使用流程
  • 预约取件API
    • 应用场景/功能说明/使用流程
    • 预约取件接口
      POST
  • 即时查询API
    • 应用场景/功能说明/使用流程
    • 即时查询
      POST
  • 物流跟踪API
    • 应用场景/功能说明/使用流程
    • 2.推送接口(商户实现)
    • 订阅接口
      POST
  • 在途监控API
    • 应用场景/功能说明/使用流程
    • 推送(增值版)接口(商户实现)
    • 即时查询(增值版)接口
      POST
    • 订阅(增值版)接口
      POST
  • 快递查询API
    • 应用场景/功能说明/使用流程
    • 快递查询
      POST
  • 物流轨迹地图API
    • 应用场景/功能说明/使用流程
    • 推送(轨迹地图版)接口(商户实现)
    • 即时查询(轨迹地图版)
      POST
    • 订阅(轨迹地图版)
      POST
  • 物流短信API
    • 应用场景/功能说明/物流短信
    • 设置短信模板
  • 单号识别API
    • 应用场景/功能说明/使用流程
    • 单号识别API
  • 智能地址解析API
    • 应用场景/功能说明
    • 智能地址解析API
  1. 电子面单API

电子面单接口

POST
/api/EOrderService
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
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/api/EOrderService' \
--header 'Content-Type: application/json' \
--data-raw '{
                          "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"
                            }
                          ],
                          "Weight": 1.0,
                          "Quantity": 1,
                          "Volume": 0.0,
                          "Remark": "小心轻放"
                        }'
响应示例响应示例
成功示例
{
  "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": "成功"
}

请求参数

Body 参数application/json
RequestData
string 
必需
请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。
EBusinessID
string 
必需
商户ID,请在我的服务页面查看。
RequestType
string 
必需
请求指令类型:1007
DataSign
string 
必需
数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。
DataType
string 
可选
请求、返回数据类型:只支持JSON格式
MemberID
string 
可选
ERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户
<= 50 字符
CustomerName
string 
可选
电子面单客户号,需要下载《快递鸟电子面单客户号参数对照表.xlsx》,参考对应字段传值
<= 50 字符
CustomerPwd
string 
可选
电子面单客户号,需要下载《快递鸟电子面单客户号参数对照表.xlsx》,参考对应字段传值
SendSite
string 
可选
电子面单客户号,需要下载《快递鸟电子面单客户号参数对照表.xlsx》,参考对应字段传值
<= 30 字符
SendStaff
string 
可选
电子面单客户号,需要下载《快递鸟电子面单客户号参数对照表.xlsx》,参考对应字段传值
<= 30 字符
MonthCode
string 
可选
电子面单客户号,需要下载《快递鸟电子面单客户号参数对照表.xlsx》,参考对应字段传值
CustomArea
string 
商家自定义区域
可选
<= 500 字符
WareHouseID
string 
发货仓编码
可选
TransType
integer 
可选
运输方式 1- 陆运 2- 空运 不填默认为1
ShipperCode
string 
必需
快递公司编码 详细编码参考《快递鸟接口支持快递公司编码.xlsx》
LogisticCode
string 
可选
快递单号(仅宅急送可用)
ThrOrderCode
string 
可选
第三方订单号 (ShipperCode为JD且ExpType为1时必填)
OrderCode
string 
可选
订单编号(自定义,不可重复)
PayType
string 
可选
邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付(仅SF支持)
<= 1 字符
ExpType
string 
可选
快递类型:1-标准快件 ,详细快递类型参考《快递公司快递业务类型.xlsx》
<= 2 字符
IsReturnSignBill
integer <int32>
可选
是否要求签回单 1- 要求 0-不要求
OperateRequire
string 
可选
签回单操作要求(如:签名、盖章、身份证复印件等)
<= 20 字符
Cost
number <double>
快递运费
可选
OtherCost
number <double>
其他费用
必需
Receiver
object 
可选
Company
string 
收件人公司
可选
Name
string 
收件人
必需
Tel
string 
电话
必需
Mobile
string 
手机
必需
PostCode
string 
收件人邮编
可选
ProvinceName
string 
必需
收件省 (如广东省,不要缺少“省”;如是直辖市,请直接传北京、上海等; 如是自治区,请直接传广西壮族自治区等)
CityName
string 
必需
收件市(如深圳市,不要缺少“市”; 如果是市辖区,请直接传北京市、上海市等)
ExpAreaName
string 
必需
收件区/县(如福田区,不要缺少“区”或“县”)
Address
string 
收件人详细地址
必需
string 
必需
Sender
object 
可选
Company
string 
发件人公司
可选
Name
string 
发件人
必需
Tel
string 
必需
电话与手机,必填一个
Mobile
string 
必需
电话与手机,必填一个
PostCode
string 
可选
发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)
ProvinceName
string 
必需
发件省 (如广东省,不要缺少“省”; 如是直辖市,请直接传北京、上海等; 如是自治区,请直接传广西壮族自治区等)
CityName
string 
必需
发件市(如深圳市,不要缺少“市; 如是市辖区,请直接传北京市、上海市等”)
ExpAreaName
string 
必需
发件区/县(如福田区,不要缺少“区”或“县”)
Address
string 
发件人详细地址
必需
IsNotice
integer 
可选
是否通知快递员上门揽件 0- 通知 1- 不通知 不填则默认为1
StartDate
string <date>
可选
上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同
EndDate
string <date>
可选
上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同
Weight
number <double>
可选
包裹总重量kg 当为快运的订单时必填,不填时快递鸟将根据各个快运公司要求传对应的默认值
>= 3<= 10
Quantity
integer 
必需
包裹数(最多支持30件) 一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号
Volume
number <double>
可选
包裹总体积m3 当为快运的订单时必填,不填时快递鸟将根据各个快运公司要求传对应的默认值
Remark
string 
备注
可选
AddService
object 
可选
Name
string 
可选
增值服务名称 (数组形式,可以有多个增值服务)
Value
string 
增值服务值
可选
CustomerID
string 
客户标识(选填)
可选
Commodity
object 
必需
GoodsName
string 
商品名称
必需
GoodsCode
string 
商品编码
可选
Goodsquantity
integer 
商品数量
可选
GoodsPrice
number <double>
商品价格
可选
GoodsWeight
number <double>
商品重量kg
可选
GoodsDesc
string 
商品描述
可选
GoodsVol
number <double>
商品体积m3
可选
IsReturnPrintTemplate
string 
必需
返回电子面单模板:0-不需要;1-需要
IsSendMessage
integer 
必需
是否订阅短信:0-不需要;1-需要
TemplateSize
string 
必需
模板规格(默认的模板无需传值,非默认模板传对应模板尺寸)
PackingType
integer 
必需
包装类型(快运字段)默认为0; 0- 纸 1- 纤 2- 木 3- 托膜 4- 木托 99-其他
DeliveryMethod
integer 
必需
送货方式(快运字段)默认为0; 0- 自提 1- 送货上门(不含上楼) 2- 送货上楼
示例

返回响应

🟢200成功
application/json
Body
EBusinessID
string 
用户ID
必需
Order
object 
必需
OrderCode
string 
订单编号
必需
ShipperCode
string 
快递公司编号
必需
LogisticCode
string 
快递单号
必需
MarkDestination
string 
大头笔
可选
OriginCode
string 
始发地区域编码
可选
OriginName
string 
始发地/始发网点
可选
DestinatioCode
string 
目的地区域编码
可选
DestinatioName
string 
目的地/到达网点
可选
SortingCode
string 
分拣编码
可选
PackageCode
string 
集包编码
可选
PackageName
string 
集包地
可选
DestinationAllocationCentre
string 
目的地分类
可选
Success
boolean 
必需
成功与否(true/false)
ResultCode
string 
返回编码
必需
Reason
string 
失败原因
必需
PrintTemplate
string 
必需
面单打印模板内容(html格式)
EstimatedDeliveryTime
string <date>
必需
订单预计到货时间yyyy-mm-dd
SubCount
integer 
子单数量
必需
SubOrders
string 
子单单号
必需
SubPrintTemplates
string 
必需
子单模板内容(html格式)
SignBillPrintTemplate
string 
必需
签回单模板内容(html格式)
ReceiverSafePhone
string 
收件人安全电话
必需
SenderSafePhone
string 
收件人安全电话
必需
DialPage
string 
必需
拨号页面网址(转换成二维码可扫描拨号)
上一页
应用场景/功能说明/使用流程
下一页
订单取消接口
Built with