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

API服務

預約取件API

首頁 > API文檔 > 隱私快遞API

隱私快遞API

申請API

隱私快遞是一種利用隱私通訊技術實現(xiàn)在隱藏收/發(fā)件人信息的同時，快遞員通過掃描二維碼或者撥打安全號碼與收/發(fā)件人直接通話的方法，可以杜絕物流運輸過程中，對收/發(fā)件人隱私的獲取和泄露，為收/發(fā)件人提供能保護隱私信息的服務

應用場景功能說明使用流程 API參數(shù)接入流程 demo下載

應用場景

（1）電商買家在提交訂單時，勾選隱私快遞選項
（2）打單工具在商戶打單時選擇隱私快遞模式
（3）ERP集成隱私電子面單打單功能，供商戶使用
（4）APP、公眾號、網(wǎng)站等下單模塊，集成隱私快遞功能

功能說明

使用流程

API參數(shù)

一、接口描述/說明

安全號碼

（1）接口需要指定快遞單號的快遞公司編碼，格式不對或則編碼錯誤都會返失敗的信息。
如：EMS物流單號應選擇快遞公司編碼（EMS）查看快遞公司編碼
（2）返回的物流跟蹤信息按照發(fā)生的時間升序排列。
（3）接口指令3001。
（4）接口支持的消息接收方式為HTTP POST，請求方法的編碼格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（5）接口地址： API測試地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/apiservice

請求系統(tǒng)級參數(shù)說明：

參數(shù)名稱	類型	說明	必須要求
RequestData	String	請求內(nèi)容需進行URL(utf-8)編碼。請求內(nèi)容JSON格式，須和DataType一致。	是
EBusinessID	String	商戶ID，請在我的服務頁面查看。	是
RequestType	String	請求指令類型：3001	是
DataSign	String	數(shù)據(jù)內(nèi)容簽名：把(請求內(nèi)容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數(shù)據(jù)類型：2-json；	否

隱私電子面單

（1）電子面單接口是快遞鳥提供給獨立電商、倉儲管理系統(tǒng)、物流供應鏈等物流系統(tǒng)平臺使用的下單接口。
（2）為客戶解決在線發(fā)貨需求，商戶通過網(wǎng)絡選擇快遞公司發(fā)送請求通知快遞公司有快遞要發(fā)貨。
（3）客戶把數(shù)據(jù)通過此接口轉發(fā)到快遞鳥，由快遞鳥為您安排快遞員上門取件的服務。
（4）訂單編號（OrderCode）不可重復提交，重復提交系統(tǒng)會返回具體錯誤代碼。
（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

請求系統(tǒng)級參數(shù)說明：

參數(shù)名稱	類型	說明	必須要求
RequestData	String	請求內(nèi)容需進行URL(utf-8)編碼。請求內(nèi)容JSON格式，須和DataType一致。	是
EBusinessID	String	商戶ID，請在我的服務頁面查看。	是
RequestType	String	請求指令類型：1007	是
DataSign	String	數(shù)據(jù)內(nèi)容簽名：把(請求內(nèi)容(未編碼)+AppKey)進行MD5加密，然后Base64編碼，最后進行URL(utf-8)編碼。詳細過程請查看Demo。	是
DataType	String	請求、返回數(shù)據(jù)類型：只支持JSON格式	否

二、接口參數(shù)

安全號碼

請求內(nèi)容字段定義：

參數(shù)名稱		類型	說明	是否必須
OrderCode		String	訂單編號	是
ShipperCode		String	快遞公司編碼	是
LogisticCode		String	快遞單號	是
Receiver	Company	String	收件人公司	否
	Name	String	收件人	是
	Tel	String	電話與手機，必填一個	是
	Mobile	String	電話與手機，必填一個	是
	PostCode	String	收件人郵編	否
	ProvinceName	String	收件省（如廣東省，不要缺少“省”）	是
	CityName	String	收件市（如深圳市，不要缺少“市”）	是
	ExpAreaName	String	收件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）	否
	Address	String	收件人詳細地址	是
Sender	Company	String	發(fā)件人公司	否
	Name	String	發(fā)件人	是
	Tel	String	電話與手機，必填一個	是
	Mobile	String	電話與手機，必填一個	是
	PostCode	String	發(fā)件人郵編	否
	ProvinceName	String	發(fā)件省（如廣東省，不要缺少“省”）	是
	CityName	String	發(fā)件市（如深圳市，不要缺少“市”）	是
	ExpAreaName	String	發(fā)件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）	否
	Address	String	發(fā)件人詳細地址	是
HideType		Int	安全號生成規(guī)則（1，隱藏收件人信息，2.隱身發(fā)件人信息，3.同時隱藏收件人，發(fā)件人信息）	是

返回參數(shù)定義：

參數(shù)名稱	類型	說明	是否必須
OrderCode	String	訂單編號	是
ShipperCode	String	快遞公司編碼	是
LogisticCode	String	快遞單號	是
ReceiverSafePhone	String	收件人安全電話	是
ReceiverPhone	String	收件人電話	是
SenderSafePhone	String	寄件人安全電話	是
SenderPhone	String	寄件人電話	是
ReceiverSafePhone	String	收件人安全電話	是
DialPage	String	撥號頁面網(wǎng)址（轉換成二維碼可掃描撥號）	是
ResultCode	String	錯誤編碼	是
Success	Bool	成功與否	是
Reason	String	失敗原因	否

隱私電子面單

請求內(nèi)容字段定義：

參數(shù)名稱		類型	說明	是否必須
CallBack		String	用戶自定義回調信息	否
MemberID		String	會員標識	否
CustomerName		String	電子面單客戶賬號（與快遞網(wǎng)點申請）	否
CustomerPwd		String	電子面單密碼	否
SendSite		String	收件網(wǎng)點標識	否
ShipperCode		String	快遞公司編碼	是
LogisticCode		String	快遞單號	否
OrderCode		String	訂單編號	是
ThrOrderCode		String	第三方訂單編號	否
MonthCode		String	月結編碼	可選
PayType		Int	郵費支付方式:1-現(xiàn)付，2-到付，3-月結，4-第三方支付	是
ExpType		String	快遞類型：1-標準快件	是
IsNotice		Int	是否通知快遞員上門攬件：0-通知；1-不通知；不填則默認為0	否
Cost		Double	寄件費（運費）	否
OtherCost		Double	其他費用	否
Receiver	Company	String	收件人公司	否
	Name	String	收件人	是
	Tel	String	電話與手機，必填一個	是
	Mobile	String	電話與手機，必填一個	是
	PostCode	String	收件人郵編	否
	ProvinceName	String	收件省（如廣東省，不要缺少“省”）	是
	CityName	String	收件市（如深圳市，不要缺少“市”）	是
	ExpAreaName	String	收件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）	否
	Address	String	收件人詳細地址	是
Sender	Company	String	發(fā)件人公司	否
	Name	String	發(fā)件人	是
	Tel	String	電話與手機，必填一個	是
	Mobile	String	電話與手機，必填一個	是
	PostCode	String	發(fā)件人郵編	否
	ProvinceName	String	發(fā)件省（如廣東省，不要缺少“省”）	是
	CityName	String	發(fā)件市（如深圳市，不要缺少“市”）	是
	ExpAreaName	String	發(fā)件區(qū)（如福田區(qū)，不要缺少“區(qū)”或“縣”）	否
	Address	String	發(fā)件人詳細地址	是
StartDate		String	上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時間格式相同	否
EndDate		String	上門取貨時間段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有時間格式相同	否
Weight		Double	物品總重量kg	否
Quantity		Int	件數(shù)/包裹數(shù)	否
Volume		Double	物品總體積m3	否
Remark		String	備注	否
AddServices
AddService	Name	String	增值服務名稱	否
	Value	String	增值服務值	否
	CustomerID	String	客戶標識（選填）	否
Commoditys
Commodity	GoodsName	String	商品名稱	是
	GoodsCode	String	商品編碼	否
	Goodsquantity	Int	商品數(shù)量	否
	GoodsPrice	Double	商品價格	否
	GoodsWeight	Double	商品重量kg	否
	GoodsDesc	String	商品描述	否
	GoodsVol	Double	商品體積m3	否
IsReturnPrintTemplate		String	返回電子面單模板：0-不需要；1-需要	否

返回參數(shù)定義：

參數(shù)名稱		類型	說明	必須要求
EBusinessID		String	用戶ID	是
Order	OrderCode	String	訂單編號	是
	ShipperCode	String	快遞公司編碼	是
	LogisticCode	String	快遞單號	是
	MarkDestination	String	大頭筆	否
	OriginCode	String	始發(fā)地區(qū)域編碼	否
	OriginName	String	始發(fā)地/始發(fā)網(wǎng)點	否
	DestinatioCode	String	目的地區(qū)域編碼	否
	DestinatioName	String	目的地/到達網(wǎng)點	否
	SortingCode	String	分揀編碼	否
	PackageCode	String	集包編碼	否
Success		Bool	成功與否	是
ResultCode		String	錯誤編碼	是
Reason		String	失敗原因	否
UniquerRequestNumber		String	唯一標識	是
PrintTemplate		String	面單打印模板	否
EstimatedDeliveryTime		String	訂單預計到貨時間yyyy-mm-dd	否
Callback		String	用戶自定義回調信息	否
SubCount		Int	子單數(shù)量	否
SubOrders		String	子單號	否
SubPrintTemplates		String	子單模板	否

三、示例

安全號碼

請求示例 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": "朝陽區(qū)",
            "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": "http://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": "青浦區(qū)",
      "Address": "明珠路73號"
    },
    "Receiver": {
      "Company": "GCCUI",
      "Name": "Yann",
      "Mobile": "15018442396",
      "ProvinceName": "北京",
      "CityName": "北京",
      "ExpAreaName": "朝陽區(qū)",
      "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內(nèi)容",
    "EstimatedDeliveryTime":"2016-03-06",
    "Callback":"調用時傳入的Callback",
    "Success": true,
    "ResultCode": "100",
    "Reason": "成功"
  }

接入流程