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

首頁 > API文檔 > 隱私快遞API
隱私快遞API
申請API
隱私快遞是一種利用隱私通訊技術實現在隱藏收/發件人信息的同時,快遞員通過掃描二維碼或者撥打安全號碼與收/發件人直接通話的方法,可以杜絕物流運輸過程中,對收/發件人隱私的獲取和泄露,為收/發件人提供能保護隱私信息的服務
應用場景
(1)電商買家在提交訂單時,勾選隱私快遞選項
(2)打單工具在商户打單時選擇隱私快遞模式
(3)ERP集成隱私電子面單打單功能,供商户使用
(4)APP、公眾號、網站等下單模塊,集成隱私快遞功能
功能説明
使用流程
API參數
一、接口描述/説明
安全號碼
(1)接口需要指定快遞單號的快遞公司編碼,格式不對或則編碼錯誤都會返失敗的信息。
如:EMS物流單號應選擇快遞公司編碼(EMS)查看快遞公司編碼
(2)返回的物流跟蹤信息按照發生的時間升序排列。
(3)接口指令3001。
(4)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"
(5)接口地址: API測試地址://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址://api.kdniao.com/api/apiservice
請求系統級參數説明:
參數名稱類型説明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。R
EBusinessIDString商户ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:3001R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然後Base64編碼,最後 進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:2-json;O
備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
隱私電子面單
(1)電子面單接口是快遞鳥提供給獨立電商、倉儲管理系統、物流供應鏈等物流系統平台使用的下單接口。
(2)為客户解決在線發貨需求,商户通過網絡選擇快遞公司發送請求通知快遞公司有快遞要發貨。
(3) 客户把數據通過此接口轉發到快遞鳥,由快遞鳥為您安排快遞員上門取件的服務。
(4)訂單編號(OrderCode)不可重複提交,重複提交系統會返回具體錯誤代碼。
(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/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)
二、接口參數
安全號碼
請求內容字段定義:
參數名稱類型説明是否必須
OrderCodeString訂單編號R
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號R
ReceiverCompanyString收件人公司O
NameString收件人R
TelString電話與手機,必填一個R
MobileString
PostCodeString收件人郵編O
ProvinceNameString收件省(如廣東省,不要缺少“省”)R
CityNameString收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString收件區(如福田區,不要缺少“區”或“縣”)O
AddressString收件人詳細地址R
SenderCompanyString發件人公司O
NameString發件人R
TelString電話與手機,必填一個R
MobileString
PostCodeString發件人郵編O
ProvinceNameString發件省(如廣東省,不要缺少“省”)R
CityNameString發件市(如深圳市,不要缺少“市”)R
ExpAreaNameString發件區(如福田區,不要缺少“區”或“縣”)O
AddressString發件人詳細地址R
HideTypeInt安全號生成規則(1,隱藏收件人信息,2.隱身發件人信息,3.同時隱藏收件人,發件人信息)R
返回參數定義:
參數名稱類型説明是否必須
OrderCodeString訂單編號R
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號R
ReceiverSafePhoneString收件人安全電話R
ReceiverPhoneString收件人電話R
SenderSafePhoneString寄件人安全電話R
SenderPhoneString寄件人電話R
ReceiverSafePhoneString收件人安全電話R
DialPageString撥號頁面網址(轉換成二維碼可掃描撥號)R
ResultCodeString錯誤編碼R
SuccessBool成功與否R
ReasonString失敗原因O
隱私電子面單
請求內容字段定義:
參數名稱類型説明是否必須
CallBackString用户自定義回調信息O
MemberIDString會員標識O
CustomerNameString電子面單客户賬號(與快遞網點申請)O
CustomerPwdString電子面單密碼O
SendSiteString收件網點標識O
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號O
OrderCodeString訂單編號R
ThrOrderCodeString第三方訂單編號O
MonthCodeString月結編碼C
PayTypeInt郵費支付方式:1-現付,2-到付,3-月結,4-第三方支付R
ExpTypeString快遞類型:1-標準快件R
IsNoticeInt是否通知快遞員上門攬件:0-通知;1-不通知;不填則默認為0O
CostDouble寄件費(運費)O
OtherCostDouble其他費用O
ReceiverCompanyString收件人公司O
NameString收件人R
TelString電話與手機,必填一個R
MobileString
PostCodeString收件人郵編O
ProvinceNameString收件省(如廣東省,不要缺少“省”)R
CityNameString收件市(如深圳市,不要缺少“市”)R
ExpAreaNameString收件區(如福田區,不要缺少“區”或“縣”)O
AddressString收件人詳細地址R
SenderCompanyString發件人公司O
NameString發件人R
TelString電話與手機,必填一個R
MobileString
PostCodeString發件人郵編O
ProvinceNameString發件省(如廣東省,不要缺少“省”)R
CityNameString發件市(如深圳市,不要缺少“市”)R
ExpAreaNameString發件區(如福田區,不要缺少“區”或“縣”)O
AddressString發件人詳細地址R
StartDateString上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有時間格式相同O
EndDateStringO
WeightDouble物品總重量kgO
QuantityInt件數/包裹數O
VolumeDouble物品總體積m3O
RemarkString備註O
AddServices
AddServiceNameString增值服務名稱O
ValueString增值服務值O
CustomerIDString客户標識(選填)O
Commoditys
CommodityGoodsNameString商品名稱R
GoodsCodeString商品編碼O
GoodsquantityInt商品數量O
GoodsPriceDouble商品價格O
GoodsWeightDouble商品重量kgO
GoodsDescString商品描述O
GoodsVolDouble商品體積m3O
IsReturnPrintTemplateString返回電子面單模板:0-不需要;1-需要O
返回參數定義:
參數名稱類型説明必須要求
EBusinessIDString用户IDR
OrderOrderCodeString訂單編號R
ShipperCodeString快遞公司編碼R
LogisticCodeString快遞單號R
MarkDestinationString大頭筆O
OriginCodeString始發地區域編碼O
OriginNameString始發地/始髮網點O
DestinatioCodeString目的地區域編碼O
DestinatioNameString目的地/到達網點O
SortingCodeString分揀編碼O
PackageCodeString集包編碼O
SuccessBool成功與否R
ResultCodeString錯誤編碼R
ReasonString失敗原因O
UniquerRequestNumberString唯一標識R
PrintTemplateString面單打印模板O
EstimatedDeliveryTimeString訂單預計到貨時間yyyy-mm-ddO
CallbackString用户自定義回調信息O
SubCountInt子單數量O
SubOrdersString子單號O
SubPrintTemplatesString子單模板O
三、示例
安全號碼
請求示例 JSON
{          "OrderCode": "012657700387",          "ShipperCode": "SF",          "LogisticCode": "612018489480",          "Receiver":           {              "Company": "LV",              "Name": "張勇",              "Mobile": "15223830813",              "ProvinceName": "重慶市",              "CityName": "重慶市",              "ExpAreaName": "九龍坡",              "Address": "九龍35號"          },          "Sender":           {              "Company": "GCCUI",              "Name": "張勇",              "Mobile": "15223830813",              "ProvinceName": "北京",              "CityName": "北京",              "ExpAreaName": "朝陽區",              "Address": "三里屯街道雅秀大廈"          },          "HideType": "3"        }'
返回示例 JSON
{    "EBusinessID": "1261600",    "OrderCode": "012657700387",    "ShipperCode": "SF",    "Success": true,    "Reason": "",    "ResultCode": "100",    "LogisticCode": "612018489480",    "ReceiverSafePhone": "4000988856 轉 167306",    "ReceiverPhone": "15223830813",    "SenderSafePhone": "4000988856 轉 940007",    "SenderPhone": "15223830813",    "DialPage": "//192.168.1.109:8083//KDN170103211401580104"  }
隱私電子面單
請求示例 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": "SafeMail",          "Value": "3"        }      ],      "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萬+
日均千萬訂單數據處理
600家+
支持全國600+家物流商
在線諮詢
商務合作羣:
1054978381
技術對接羣11:
844089794
400-9633-321
免費獲取API