快遞鳥一次性對接600+物流接口

首頁 > API文檔 > 在途監控API
在途監控API
申請API
提供物流訂單監控服務,用户可將訂單內容通過訂閲接口訂閲到快遞鳥,快遞鳥對訂單進行實時監控,當物流軌跡有更新時,實時獲取數據,對數據進行格式化,計算運單預計到達時間、全流程的物流狀態(無軌跡、已攬收、在途中、已簽收、問題件、到達派件城市、派件中、快遞櫃或驛站簽收、超時未更新、超時為簽收、拒籤/退件)、當前所在城市等數據後,推送給用户,監控直到訂單簽收後結束。也可以通過即時查詢接口,即時獲取訂單的當前的實時狀態。
應用場景
(1)電商平台物流查詢模塊,供用户查詢訂單當前的物流狀態
(2)電商、ERP後台的物流監控系統,客服在對賬前查詢所有運單的簽收狀態,並追蹤問題
(3)電商、ERP後台實時預警模塊,對各種問題件進行實時監控處理
(4)電商、ERP後台獲取物流狀態後,可結合其他服務進行使用,如通知短信、APP通知推送
(5)APP、公眾號、網址等物流查詢模塊,供用户輸入單號實時查詢物流狀態
功能説明
使用流程
API參數
一、接口描述/説明
1.即時查詢(增值版)接口
(1)查詢接口支持按照運單號查詢(單個查詢)。
(2)接口需要指定快遞單號的快遞公司編碼,格式不對或則編碼錯誤都會返失敗的信息。
如:EMS物流單號應選擇快遞公司編碼(EMS)查看快遞公司編碼
(3)返回的物流跟蹤信息按照發生的時間升序排列。
(4)接口指令8001。
(5)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"
(6)接口地址: API測試地址://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx

請求系統級參數説明:
參數名稱類型説明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商户ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:8001R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然後Base64編碼,最後 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:2-json;O
備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
2.訂閲(增值版)接口
(1)此功能為專業定製,為特殊商户提供訂閲服務,快遞鳥系統會定時推送新的物流信息到商户系統。
(2)訂閲快遞號需指定相應的快遞公司編碼,格式不對或則編碼錯誤都會返失敗的信息。
如:EMS物流單號應選擇快遞公司編碼(EMS)查看快遞公司編碼
(3)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)接口地址: API測試地址://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址://api.kdniao.com/api/dist
請求系統級參數説明:
參數名稱類型説明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商户ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:8008R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然後Base64編碼,最後 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:2-json;O
備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
3.推送(增值版)接口(商户實現)
(1)客户需要按快遞鳥要求開發接口,保證信息的正常接收。
(2)快遞鳥主動推送時,物流信息接收接口由客户提供。
(3)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(4)運單物流信息全量推送(每次推送的運單物流信息包括運單當前所有的的物流信息)。
請求系統級參數説明:
參數名稱類型説明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容只支持JSON格式。R
EBusinessIDString102-軌跡查詢結果, 107-貨款狀態。R
備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
二、接口參數
1.即時查詢(增值版)接口
請求內容字段定義:
參數名稱類型説明必須要求
OrderCodeString訂單編號O
ShipperCodeString快遞公司編碼R
LogisticCodeString物流單號R
返回參數定義:
參數名稱類型説明必須要求
EBusinessIDString用户IDR
OrderCodeString訂單編號O
ShipperCodeString快遞公司編碼R
LogisticCodeString物流運單號O
SuccessBool成功與否R
ReasonString失敗原因O
StateString物流狀態:2-在途中,3-簽收,4-問題件R
StateExString增值物流狀態: 1-已攬收, 2-在途中, 201-到達派件城市, 202-派件中, 211-已放入快遞櫃或驛站, 3-已簽收, 311-已取出快遞櫃或驛站, 4-問題件, 401-發貨無信息, 402-超時未簽收, 403-超時未更新, 404-拒收(退件), 412-快遞櫃或驛站超時未取R
LocationString增值所在城市R
Traces
AcceptTimeString時間R
AcceptStationString描述R
LocationString當前城市O
ActionString當前狀態O
RemarkString備註O
2.訂閲(增值版)接口
請求內容字段定義:
參數名稱類型説明必須要求
CallbackString用户自定義回調信息。O
MemberIDString會員標識。O
WareHouseIDString倉庫標識O
CustomerNameString電子面單客户號O
CustomerPwdString電子面單密碼O
SendSiteString收件網點標識(名稱)O
ShipperCodeString快遞公司編碼 詳細編碼參考《快遞鳥接口支持快遞公司編碼.xlsx》R
LogisticCodeString快遞單號R
OrderCodeString訂單編號O
MonthCodeString月結編號O
PayTypeInt(1)運費支付方式: 1-現付,2-到付,3-月結,4-第三方支付O
ExpTypeString(2)快遞類型:1-標準快件 詳細快遞類型參考《快遞公司快遞業務類型.xlsx》O
CostDouble快遞運費O
OtherCostDouble快遞運費O
ReceiverCompanyString收件人公司O
NameString收件人R
TelString電話與手機,必填一個R
MobileString
PostCodeString收件地郵編(ShipperCode為EMS、YZPY時必填)O
ProvinceNameString收件省 (如廣東省,不要缺少“省”;如是直轄市,請直接傳北京、上海等; 如是自治區,請直接傳廣西壯族自治區等)R
CityNameString收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString收件區/縣(如福田區,不要缺少“區”或“縣”)R
AddressString收件人詳細地址R
SenderCompanyString發件人公司O
NameString發件人R
TelString電話與手機,必填一個R
MobileString
PostCodeString發件地郵編(ShipperCode為EMS、YZPY時必填)O
ProvinceNameString發件省 (如廣東省,不要缺少“省”; 如是直轄市,請直接傳北京、上海等; 如是自治區,請直接傳廣西壯族自治區等)R
CityNameString發件市(如深圳市,不要缺少“市”)R
ExpAreaNameString發件區/縣(如福田區,不要缺少“區”或“縣”)R
AddressString發件人詳細地址R
IsNoticeInt(1)是否通知快遞員上門攬件:0-通知;1-不通知;不填則O
StartDateString上門攬件時間段,格式:YYYY-MM-DD HH24:MM:SSO
EndDateStringO
WeightDouble月結編號O
MonthCodeString包裹總重量kgO
QuantityInt(2)包裹數,一個包裹對應一個運單號,如果是大於1個包裹,返回則按照子母件的方式返回母運單號和子運單號O
VolumeDouble包裹總體積m3O
RemarkString備註O
IsSendMessageInt(1)是否訂閲短信: 0-不需要;1-需要O
AddServiceNameString增值服務名稱O
ValueString增值服務值O
CustomerIDString客户標識O
CommodityGoodsNameString商品名稱O
GoodsCodeString商品編碼O
GoodsquantityInt(5)商品件數O
GoodsPriceString商品價格O
GoodsWeightString商品重量kgO
GoodsDescString商品描述O
GoodsVolDouble商品體積m3O
返回參數定義:
參數名稱類型説明必須要求
EBusinessIDString用户IDR
UpdateTimeString時間R
SuccessBool成功與否:true,falseR
ReasonString失敗原因O
EstimatedDeliveryTimeString訂單預計到貨時間yyyy-mm-dd(即將上線)O
3.推送(增值版)接口
應用級輸入參數
參數名稱類型説明必須要求
EBusinessIDString用户電商IDR
PushTimeString推送時間R
CountString推送物流單號軌跡個數R
DataString推送物流單號軌跡集合R
訂閲查詢(增值版)結果(RequestType:102)
通過軌跡查詢(訂閲查詢)接口訂閲到快遞鳥的數據,快遞鳥推送時,會將推送的RequestType的值置為102,同時返回下列數據
請求內容字段定義:
參數類型説明必須要求
DataEBusinessIDString商户IDO
OrderCodeString訂單編號O
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號R
SuccessBool成功與否:true,falseR
ReasonString失敗原因O
StateString物流狀態: 0-無軌跡,1-已攬收,2-在途中 201-到達派件城市,3-簽收,4-問題件R
StateExString增值物流狀態: 1-已攬收, 2-在途中, 201-到達派件城市, 202-派件中, 211-已放入快遞櫃或驛站, 3-已簽收, 311-已取出快遞櫃或驛站, 4-問題件, 401-發貨無信息, 402-超時未簽收, 403-超時未更新, 404-拒收(退件), 412-快遞櫃或驛站超時未取R
LocationString增值所在城市R
CallBackString訂閲接口的Bk值O
Traces
TraceAcceptTimeString時間R
AcceptStationString描述R
ActionString當前狀態R
LocationString當前城市R
RemarkString備註O
EstimatedDeliveryTimeString預計到達時間yyyy-mm-ddO
PickerInfoPersonNameString快遞員姓名O
PersonTelString快遞員電話O
PersonCodeString快遞員工號O
StationNameString網點名稱O
StationAddressString網點地址O
StationTelString網點電話O
SenderInfoPersonNameString派件員姓名O
PersonTelString派件員電話O
PersonCodeString派件員工號O
StationNameString派件網點名稱O
StationAddressString派件網點地址O
StationTelString派件網點電話O
返回參數定義
參數名稱類型説明必須要求
EBusinessIDString用户IDR
UpdateTimeString時間R
SuccessBool成功與否:true,falseR
ReasonString失敗原因O
三、示例
即時查詢(增值版)接口
請求示例 JSON
{      "OrderCode": "",      "ShipperCode": "QFKD",      "LogisticCode": "390141793061"  }
返回示例 JSON
沒有物流軌跡的{      "EBusinessID":"1261585",      "Traces":[],      "OrderCode":"",      "ShipperCode":"QFKD",      "LogisticCode":"390141793061",      "Success":false,      "Reason":null  }有物流軌跡的{      "EBusinessID":"1261585",      "ShipperCode":"QFKD",      "Success":true,      "LogisticCode":"390141793061",      "State":"3",      "StateEx":"3",      "Location":"威海市",      "Traces":[          {              "AcceptTime":"2016-10-26 18:31:38",              "AcceptStation":"【多寶集運倉地址】已收件",              "Location":"北京市",              "Action":"1"          },          {              "AcceptTime":"2016-10-26 19:53:50",              "AcceptStation":"快件在【多寶集運倉地址】",              "Location":"北京市",              "Action":"2"          },          {              "AcceptTime":"2016-10-26 21:00:13",              "AcceptStation":"快件到達【多寶集運倉地址】",              "Location":"北京市",              "Action":"2"          },          {              "AcceptTime":"2016-10-26 21:06:27",              "AcceptStation":"快件在【多寶集運倉地址】",              "Location":"北京市",              "Action":"2"          },          {              "AcceptTime":"2016-10-27 11:04:43",              "AcceptStation":"快件到達【多寶集運倉地址】",              "Location":"北京市",              "Action":"2"          },          {              "AcceptTime":"2016-10-27 13:04:43",              "AcceptStation":"快件在【多寶集運倉地址】",              "Location":"北京市",              "Action":"2"          },          {              "AcceptTime":"2016-10-27 20:06:03",              "AcceptStation":"快件到達【多寶集運倉地址】",              "Location":"濰坊市",              "Action":"2"          },          {              "AcceptTime":"2016-10-27 22:06:03",              "AcceptStation":"快件在【多寶集運倉地址】",              "Location":"濰坊市",              "Action":"2"          },          {              "AcceptTime":"2016-10-28 09:53:53",              "AcceptStation":"快件到達【多寶集運倉地址】",              "Location":"威海市",              "Action":"2"          },          {              "AcceptTime":"2016-10-28 10:44:39",              "AcceptStation":"快件到達【多寶集運倉地址】",              "Location":"威海市",              "Action":"2"          },          {              "AcceptTime":"2016-10-28 10:48:03",              "AcceptStation":"【多寶集運倉地址】正在派件",              "Location":"威海市",              "Action":"202"          },          {              "AcceptTime":"2016-10-28 18:09:45",              "AcceptStation":"已簽收,簽收人是【多寶集運倉地址】",              "Location":"威海市",              "Action":"3"          }      ]  }
訂閲(增值版)接口
請求示例 JSON
{      "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":"書本"          }      ]  }
返回示例 JSON
{      "EBusinessID":"1151847",      "UpdateTime":"2016-08-09 16:42:38",      "Success":true,      "Reason":""  }
推送接口(增值版)
請求示例 JSON[訂閲查詢(增值版)]
{      "EBusinessID":"1261585",      "Count":"1",      "PushTime":"2016-11-03 11:54:34",      "Data":[          {              "EBusinessID":"1261585",              "ShipperCode":"ZTO",              "LogisticCode":"416071867790",              "Success":true,              "State":"2",              "Traces":[                  {                      "AcceptTime":"2016-10-28 17:54:18",                      "AcceptStation":"杭州錢江開發區 的 悠可1 已收件",                      "Location":"杭州市",                      "Action":"1"                  },                  {                      "AcceptTime":"2016-10-28 19:10:59",                      "AcceptStation":"快件離開 杭州錢江開發區 已發往 上海",                      "Location":"杭州市",                      "Action":"2"                  },                  {                      "AcceptTime":"2016-10-28 21:49:34",                      "AcceptStation":"快件已到達 杭州中轉部",                      "Location":"杭州市",                      "Action":"2"                  },                  {                      "AcceptTime":"2016-10-28 22:39:12",                      "AcceptStation":"快件離開 杭州中轉部 已發往 上海",                      "Location":"杭州市",                      "Action":"2"                  },                  {                      "AcceptTime":"2016-10-29 02:07:53",                      "AcceptStation":"快件已到達 上海航空部",                      "Location":"上海市",                      "Action":"2"                  },                  {                      "AcceptTime":"2016-10-29 02:36:04",                      "AcceptStation":"快件離開 上海 已發往 楊浦同濟",                      "Location":"上海市",                      "Action":"2"                  },                  {                      "AcceptTime":"2016-10-29 03:28:29",                      "AcceptStation":"快件已到達 上海",                      "Location":"上海市",                      "Action":"2"                  },                  {                      "AcceptTime":"2016-10-29 07:25:46",                      "AcceptStation":"快件已到達 楊浦同濟",                      "Location":"上海市",                      "Action":"2"                  },                  {                      "AcceptTime":"2016-10-29 07:27:02",                      "AcceptStation":"楊浦同濟 的 近鄰寶 正在派件",                      "Location":"上海市",                      "Action":"402"                  }              ],              "StateEx":"402",              "Location":"上海市"          }      ]  }
返回示例JSON
{      "EBusinessID":"1151847",      "UpdateTime":"2016-08-09 16:42:38",      "Success":true,      "Reason":""  }
接入流程
demo下載

相關文檔與更多幫助?

30萬+
數十萬客户的選擇
5.8億次+
日均處理物流數據次數
1450萬+
日均千萬訂單數據處理
600家+
支持全國600+家物流商
在線諮詢
商務合作羣:
1054978381
技術對接羣11:
844089794
400-9633-321
免費獲取API