快递鸟
  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/dist
(1)此功能为专业定制,为特殊商户提供订阅服务,快递鸟系统会定时推送新的物流信息到商户系统。
(2)订阅快递号需指定相应的快递公司编码,格式不对或则编码错误都会返失败的信息。
如:EMS物流单号应选择快递公司编码(EMS)查看快递公司编码
(3)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)接口地址: API测试地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址:https://api.kdniao.com/api/dist
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/api/dist' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ShipperCode": "SF",
    "OrderCode": "SF201608081055208281",
    "LogisticCode": "3100707578976",
    "PayType": "1",
    "ExpType": "1",
    "CustomerName": "",
    "CustomerPwd": "",
    "MonthCode": "",
    "IsNotice": "0",
    "Sender": {
        "Name": "1255760",
        "Tel": "",
        "Mobile": "13700000000",
        "ProvinceName": "广东省",
        "CityName": "深圳市",
        "ExpAreaName": "福田区",
        "Address": "测试地址"
    },
    "Receiver": {
        "Name": "1255760",
        "Tel": "",
        "Mobile": "13800000000",
        "ProvinceName": "广东省",
        "CityName": "深圳市",
        "ExpAreaName": "龙华新区",
        "Address": "测试地址2"
    },
    "Commodity": [
        {
            "GoodsName": "书本"
        }
    ]
}'
响应示例响应示例
{
  "EBusinessID": "1151847",
  "UpdateTime": "2016-08-09 16:42:38",
  "Success": true,
  "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格式
Callback
string 
用户自定义回调信息
必需
MemberID
string 
必需
会员标识(备用字段)
WareHouseID
string 
必需
仓库标识(备用字段)
CustomerName
string 
必需
电子面单客户账号(与快递网点申请)
CustomerPwd
string 
电子面单密码
必需
SendSite
string 
必需
收件网点标识(名称)
ShipperCode
string 
快递公司编码
必需
OrderCode
string 
订单编号
必需
LogisticCode
string 
快递单号
必需
PayType
string 
必需
邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付
ExpType
string 
必需
快递类型:1-标准快件
MonthCode
string 
月结编号
必需
IsNotice
string 
必需
是否通知快递员上门揽件:0-通知;1-不通知;默认为1
StartDate
string 
必需
上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同
EndDate
string 
必需
上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同
Weight
number <double>
包裹总重量kg
必需
Quantity
integer 
件数/包裹数
必需
Volume
number <double>
物品总体积m3
必需
Remark
string 
备注
必需
IsSendMessage
integer 
必需
是否订阅短信:0-不需要;1-需要
Sender
object 
必需
Company
string 
发件人公司
必需
Name
string 
发件人
必需
Tel
string 
手机与电话必填一个
必需
Mobile
string 
发件人手机
必需
PostCode
string 
发件人邮编
必需
ProvinceName
string 
必需
发件省(如广东省,不要缺少“省”)
CityName
string 
必需
发件市(如深圳市,不要缺少“市”)
ExpAreaName
string 
必需
发件区(如福田区,不要缺少“区”或“县”)
Address
string 
发件人详细地址
必需
Receiver
object 
必需
company
string 
收件人公司
必需
Name
string 
收件人
必需
Tel
string 
必需
电话(电话与手机,必填一个)
Mobile
string 
必需
电话(电话与手机,必填一个)
ProvinceName
string 
必需
收件省(如广东省,不要缺少“省”)
CityName
string 
必需
收件市(如深圳市,不要缺少“市”)
ExpAreaName
string 
必需
收件区(如福田区,不要缺少“区”或“县”)
Address
string 
收件人详细地址
必需
Commodity
array [object {7}] 
必需
GoodsName
string 
商品名称
可选
GoodsCode
string 
商品编码
必需
Goodsquantity
string 
件数
必需
GoodsPrice
string 
商品价格
必需
GoodsWeight
string 
商品重量kg
必需
GoodsDesc
string 
商品描述
必需
GoodsVol
string 
商品体积m3
必需
示例

返回响应

🟢200成功
application/json
Body
EBusinessID
string 
用户ID
必需
UpdateTime
string 
必需
更新时间 YYYY-MM-DD HH24:MM:SS
Success
boolean 
必需
成功与否:true,false
Reason
string 
失败原因
必需
EstimatedDeliveryTime
string 
必需
订单预计到货时间yyyy-mm-dd
上一页
2.推送接口(商户实现)
下一页
应用场景/功能说明/使用流程
Built with