1 用戶信息類
1.1 用戶註冊接口
1.1.1 功能說明
爲第三方平臺用戶提供註冊接口，方便平臺用戶接入快遞鳥服務，同時也方便快遞鳥爲平臺用戶提供查詢、訂閱、下單、金融等全方位物流服務。html
1.1.2 接口規則
(1)、接口只支持Json格式參數，接口指令9001。只支持POST請求方式，utf-8編碼。json
(2)、測試地址：http://testapi.kdniao.cc:8081/api/regapi
(3)、正式地址：http://api.kdniao.cc/api/reg安全
1.1.3 系統級輸入參數
| 參數名稱服務器 |
類型dom |
是否必須測試 |
描述網站 |
| RequestDataui |
String編碼 |
R |
請求內容，JSON格式,須和DataType一致 |
| String |
R |
電商ID |
|
| String |
R |
請求指令類型：9001 |
|
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：2-json(本接口只支持Json格式) |
1.1.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| MemberCode |
String（20） |
R |
用戶標識（各平臺必須惟一） |
| String（30） |
O |
公司名稱 |
|
| SiteName |
String（30） |
O |
網站/商城名稱 |
| Name |
String（20） |
O |
姓名 |
| Mobile |
String（20） |
R |
電話 |
| |
String（30） |
O |
郵箱 |
| SiteUrl |
String（100） |
R |
網站/商城連接 |
| JoinTime |
String（20） |
R |
入駐平臺時間: "yyyy-MM-ddHH:mm:ss"格式化，本文中全部時間格式相同 |
1.1.5 返回結果參數
| 類型 |
是否必須 |
描述 |
|
| MemberCode |
String（20） |
R |
用戶標識（做爲callback返回） |
| Success |
Bool |
R |
成功與否 |
| Reason |
String（50） |
O |
失敗緣由 |
| ReturnCode |
String(3) |
R |
結果狀態碼 |
| EBusinessID |
String（20） |
O |
子賬號商戶ID（快遞鳥惟一） |
| AppKey |
String（20） |
0 |
子賬號AppKey（快遞鳥惟一） |
| ParentEBusinessID |
String(20) |
O |
主帳號商戶ID |
| CreateTime |
String(20) |
R |
建立時間 |
1.1.6 結果代碼表示的含義
| 結果狀態碼 |
Reason |
客戶須要作的操做 |
| 200 |
成功 |
|
| 401 |
信息不完整 |
補全全部必填參數 |
| 402 |
賬號重複申請 |
仍會返回已註冊的商戶ID與AppKey |
| 500 |
服務器錯誤 |
一小時後重試 |
1.1.7 Json請求示例
"MemberCode":"YQ10001",
"CompanyName":"某公司名稱",
"SiteName":"某站點或商城名稱",
"Name":"李某某",
"Mobile":"18888888888",
"Email":"yourname@yourdomain.com",
"SiteUrl":"http://www.yourdomain.com",
"JoinTime":"2016-03-2000:00:00"
}
1.1.8 Json請求返回示例
{
"MemberCode": "YQ10001",
"Success": true,
"Reason": "",
"EBusinessID": "1300001",
"AppKey": "37dd1e35-f705-40e5-b9ae-3231e18c57f7",
"ParentEBusinessID" : "1255666"
}
1.2 更新用戶信息
1.2.1 功能說明
1.2.2 接口規則
(1)、接口只支持Json格式參數，接口指令CMD1002。只支持POST請求方式，utf-8編碼。
(2)、測試地址：http://testapi.kdniao.cc:8081/api/agencyfund
(3)、正式地址：http://api.kdniao.cc/api/agencyfund
1.2.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1002 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
1.2.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| Phone |
String |
O |
聯繫電話 |
| LinkMan |
String |
O |
聯繫人 |
| IdentityCardNo |
String |
O |
身份證號碼 |
| IdentityCardPicA |
String |
O |
身份證正面照Url |
| IdentityCardPicB |
String |
O |
身份證反面照Url |
| Address |
String |
O |
地址 |
1.2.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
| EBusinessID |
String |
R |
請求用戶標識 |
| RequestType |
String |
R |
請求指令 |
| Success |
Bool |
R |
成功與否 |
| ResultCode |
String |
R |
|
| Message |
String |
R |
返回消息 |
1.2.6 JSON請求示例
{
"LinkMan":"hoo",
"Phone":"15223830814",
"Address":"深圳",
"IdentityCardNo": "",
"IdentityCardPicA": "",
"IdentityCardPicB": ""
}
1.2.7 JSON返回示例
{
"Success": true,
"Message": "修改爲功",
"RequestType":"cmd1002",
"EBusinessID":"1261644",
"ResultCode":"100",
"Result":""
}
1.3 查詢用戶信息
1.3.1 功能說明
查詢收派寶用戶的信息，包含服務狀態的開通。
1.3.2 接口規則
(1)、接口指令cmd1003。
1.3.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：cmd1003 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
1.3.4 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
||
| EBusinessID |
String |
R |
請求用戶標識 |
||
| RequestType |
String |
O |
請求指令 |
||
| Success |
Bool |
R |
成功與否 |
||
| ResultCode |
String |
R |
|||
| Message |
String |
R |
返回消息 |
||
| Result |
UserGuid |
String |
R |
用戶Guid（惟一） |
|
| UserName |
String |
R |
用戶名（惟一） |
||
| LinkMan |
String |
O |
聯繫人 |
||
| Phone |
String |
O |
聯繫電話 |
||
| OneLevelAgent |
String |
O |
一級代理編號 |
||
| TwoLevelAgent |
String |
O |
二級代理編號 |
||
| IdentityCardNo |
String |
O |
身份證號碼 |
||
| Result |
IdentityCardPicA |
String |
O |
身份證正面照Url |
|
| IdentityCardPicB |
String |
O |
身份證反面照Url |
||
| Address |
String |
O |
聯繫地址 |
||
| Services |
ServicesCode |
String |
O |
服務編碼 |
|
| ServiceName |
String |
O |
服務名稱 |
||
| StartDate |
String |
O |
服務開始時間 |
||
| ValidDate |
String |
O |
服務失效時間，爲空時表示永久有效 |
||
|
|
|
LimitValue |
decimal |
O |
總額度，爲空表示不限 |
1.3.5 Json請求示例
1.3.6 Json請求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1003",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"UserGuid": "147adf16-8ef2-48d3-8c20-5fbb343ff8d4",
"UserName": "test04@1261602@test",
"LinkMan": "",
"Phone": "15612345678",
"OneLevelAgent": "test",
"TwoLevelAgent": "test_fafa",
"Services": [
{
"ServicesCode": "COD",
"ServiceName": "普通代收服務",
"ValidDate": "",
"StartDate": "2017-01-16"
},
{
"ServicesCode": "CODFAST",
"ServiceName": "網點速退",
"ValidDate": "",
"StartDate": "2017-01-16"
}
]
}
1.4 提交返款銀行信息
1.4.1 功能說明
設置用戶代收貨款訂單的銀行返款信息。
1.4.2 接口規則
(1)、接口指令CMD1009。
1.4.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1009 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
1.4.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| BankType |
String |
R |
信息類型：0-直退，1-墊付 |
| BankAccountNo |
String |
O |
銀行帳號 |
| BankAccountName |
String |
O |
開戶名 |
| BankName |
String |
O |
開戶銀行 |
| BankBranch |
String |
O |
開戶分行 |
| BankCardPicA |
String |
O |
銀行卡正面照Url |
| BankCardPicB |
String |
O |
銀行卡反面照Url |
1.4.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
| EBusinessID |
String |
R |
請求用戶標識 |
| RequestType |
String |
O |
請求指令 |
| Success |
Bool |
R |
成功與否 |
| ResultCode |
String |
R |
|
| Message |
String |
R |
返回消息 |
1.4.6 Json請求示例
{
"BankType":"0",
"BankAccountNo":"62266226622662266226",
"BankAccountName": "hoo",
"BankName":"招商銀行",
"BankBranch":"",
"BankCardPicA":"",
"BankCardPicB":""
}
1.4.7 Json請求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1003",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"UserGuid": "147adf16-8ef2-48d3-8c20-5fbb343ff8d4",
"UserName": "test04@1261602@test",
"LinkMan": "",
"Phone": "15612345678",
"OneLevelAgent": "test",
"TwoLevelAgent": "test_fafa",
"Services": [
{
"ServicesCode":"COD",
"ServiceName": "普通代收服務",
"ValidDate":"",
"StartDate":"2017-01-16"
},
{
"ServicesCode":"CODFAST",
"ServiceName": "網點速退",
"ValidDate":"",
"StartDate":"2017-01-16"
}
]
}
}
1.5 查詢返款銀行信息
1.5.1 功能說明
查詢代收貨款訂單的銀行返款信息。
1.5.2 接口規則
(1)、接口指令CMD1008。
1.5.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1008 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
1.5.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| BankType |
String |
R |
信息類型：0-直退，1-墊付 |
1.5.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
|
| EBusinessID |
String |
R |
請求用戶標識 |
|
| RequestType |
String |
0 |
請求指令 |
|
| Success |
Bool |
R |
成功與否 |
|
| ResultCode |
String |
R |
||
| Message |
String |
R |
返回消息 |
|
| Result |
UserGuid |
String |
O |
用戶Guid（惟一） |
| BankAccountNo |
String |
O |
銀行帳號 |
|
| BankAccountName |
String |
O |
開戶名 |
|
| BankName |
String |
O |
開戶銀行 |
|
| BankBranch |
String |
O |
開戶分行 |
1.5.6 Json請求示例
{
"BankType":"0"
}
1.5.7 Json請求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1008",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"UserGuid": "bee49a46-5852-45a0-b706-fd60e793e1ef"
}
}
1.6 查詢用戶額度
1.6.1 功能說明
查詢用戶的代收貨款的額度限制和當前可用額度。
1.6.2 接口規則
(1)、接口指令CMD1014。
1.6.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1014 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
1.6.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| String |
R |
服務代碼:COD-普通代收服務,CODBACK-貨款直退,CODFAST-網點速退,CODPAY-貨款墊付. |
1.6.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
|
| EBusinessID |
String |
R |
請求用戶標識 |
|
| RequestType |
String |
O |
請求指令 |
|
| Success |
Bool |
R |
成功與否 |
|
| ResultCode |
String |
R |
||
| Message |
String |
R |
返回消息 |
|
| Result |
UserGuid |
String |
R |
用戶標識 |
| LimitAmount |
decimal |
R |
服務額度,爲空表示不限額度 |
|
| EnabledAmount |
decimal |
R |
當前可用額度,爲空表示不限額度 |
1.6.6 Json請求示例
{
"ServicesCode":"CODPAY"
}
1.6.7 Json請求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1014",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"UserGuid": "8525344E-3BAF-4B36-8672-97E3403061B3",
"LimitAmount": 10000,
"EnabledAmount": 10000
}
}
2 服務申請類
2.1 墊付業務申請
2.1.1 功能說明
墊付業務須要用戶申請，收派寶審覈經過後方可以使用該服務。
2.1.2 接口規則
(1)、接口指令CMD1004。
2.1.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1004 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：2-json; |
2.1.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| BankAccountNo |
String |
R |
銀行帳號 |
| BankAccountName |
String |
R |
開戶名 |
| BankName |
String |
R |
開戶銀行 |
| BankBranch |
String |
R |
開戶分行 |
| BankCardPicA |
String |
O |
銀行卡正面照Url |
| BankCardPicB |
String |
O |
銀行卡反面照Url |
| IdentityCardNo |
String |
O |
身份證號碼 |
| IdentityCardPicA |
String |
O |
身份證正面照Url |
| IdentityCardPicB |
String |
O |
身份證反面照Url |
2.1.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
| EBusinessID |
String |
R |
請求用戶標識 |
| RequestType |
String |
O |
請求指令 |
| Success |
Bool |
R |
成功與否 |
| ResultCode |
String |
R |
|
| Message |
String |
R |
返回消息 |
2.1.6 JSON請求示例
{
"BankAccountNo": "62266226622662266226",
"BankAccountName": "hoo",
"BankName": "招商銀行",
"BankBranch": "深圳深圳支行",
"BankCardPicA": "",
"BankCardPicB": ""
}
2.1.7 JSON返回示例
{
"Success": true,
"Message": "申請成功",
"RequestType": "cmd1004",
"EBusinessID": "1261599",
"ResultCode": "100",
"Result": ""
}
2.2 直退業務申請
2.2.1 功能說明
申請直退業務的權限。
2.2.2 接口規則
(1)、請求指令CMD1005。
2.2.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1005 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：2-json; |
2.2.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| BankAccountNo |
String |
O |
銀行帳號 |
| BankAccountName |
String |
O |
開戶名 |
| BankName |
String |
O |
開戶銀行 |
| BankBranch |
String |
O |
開戶分行 |
| BankCardPicA |
String |
O |
銀行卡正面照Url |
| BankCardPicB |
String |
O |
銀行卡反面照Url |
2.2.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
| EBusinessID |
String |
R |
請求用戶標識 |
| RequestType |
String |
O |
請求指令 |
| Success |
Bool |
R |
成功與否 |
| ResultCode |
String |
R |
|
| Message |
String |
R |
返回消息 |
2.2.6 JSON請求示例
{
"BankAccountNo": "62266226622662266226",
"BankAccountName": "hoo",
"BankName": "招商銀行",
"BankBranch": "深圳深圳支行",
"BankCardPicA": "",
"BankCardPicB": ""
}
2.2.7 JSON返回示例
{
"Success": true,
"Message": "申請成功",
"RequestType": "cmd1005",
"EBusinessID": "1261599",
"ResultCode": "100",
"Result": ""
}
2.3 普通代收貨款申請
2.3.1 功能說明
申請普通代收貨款業務的權限。
2.3.2 接口規則
(1)、請求指令CMD1006。
2.3.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1006 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：2-json; |
2.3.4 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
| EBusinessID |
String |
R |
請求用戶標識 |
| RequestType |
String |
O |
請求指令 |
| Success |
Bool |
R |
成功與否 |
| ResultCode |
String |
R |
|
| Message |
String |
R |
返回消息 |
2.3.5 JSON請求示例
{
"BankAccountNo": "62266226622662266226",
"BankAccountName": "hoo",
"BankName": "招商銀行",
"BankBranch": "深圳深圳支行",
"BankCardPicA": "",
"BankCardPicB": ""
}
2.3.6 JSON返回示例
{
"Success": true,
"Message": "申請成功",
"RequestType": "cmd1006",
"EBusinessID": "1261599",
"ResultCode": "100",
"Result": ""
}
2.4 查詢服務申請狀態
2.4.1 功能說明
查詢某用戶的服務開通狀況。
2.4.2 接口規則
(1)、請求指令CMD1007。
2.4.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1007 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
2.4.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| String |
R |
服務編號:COD-普通代收服務,CODBACK-貨款直退,CODFAST-網點速退,CODPAY-貨款墊付 |
2.4.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
|
| EBusinessID |
String |
R |
請求用戶標識 |
|
| RequestType |
String |
O |
請求指令 |
|
| Success |
Bool |
R |
成功與否 |
|
| ResultCode |
String |
R |
||
| Message |
String |
R |
返回消息 |
|
| Result |
UserGuid |
String |
O |
用戶GUID |
| ServicesCode |
String |
O |
服務編碼 |
|
| ServiceName |
String |
O |
服務名稱 |
|
| StartDate |
String |
O |
服務開始時間 |
|
| LimitValue |
decimal |
O |
總額度，爲空則不限額度 |
|
| Status |
String |
O |
服務狀態:0-未開通，1-已開通，2-失效，3-未經過，4-關閉 |
|
| ValidDate |
String |
O |
服務有效期，爲空這永久生效 |
|
|
|
Remark |
String |
O |
備註 |
2.4.6 JSON請求示例
{
"ServiceCode": "CODBACK"
}
2.4.7 JSON返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1007",
"EBusinessID": "1261599",
"ResultCode": "100",
"Result": {
"UserGuid": "d07d687a-691a-45d9-82e0-e54aab076ed6",
"ServicesCode": "CODBACK",
"ServiceName": "貨款直退",
"ValidDate": "",
"StartDate": "2017-01-09",
"Status": "1",
"Remark": "接口調用申請自動開通"
}
}
3 訂單類
3.1 服務費計算
3.1.1 功能說明
根據代收貨款訂單金額和類型計算服務費。
3.1.2 接口規則
(1)、接口指令CMD1012。
3.1.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1012 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
3.1.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| Amount |
decimal |
R |
貨款金融 |
| OrderType |
Int |
R |
訂單類型： 3-貨款直退、2-貨款墊付 4-網點速退 |
| LogisticsCode |
String |
R |
物流公司代碼 |
3.1.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
|
| EBusinessID |
String |
R |
請求用戶標識 |
|
| RequestType |
String |
O |
請求指令 |
|
| Success |
Bool |
R |
成功與否 |
|
| ResultCode |
String |
R |
||
| Message |
String |
R |
返回消息 |
|
| Result |
CommissionAmount |
decimal |
R |
服務費 |
3.1.6 Json請求示例
{
"Amount":"1000",
"OrderType":"2",
"LogisticsCode":"LB",
"OneLevelAgent":"test",
"TwoLevelAgent":"test_fafa"
}
3.1.7 Json請求返回示例
{
"Success": false,
"Message": "成功",
"RequestType": "cmd1012",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"CommissionAmount": 5
}
}
3.2 獲取訂單貨款狀態
3.2.1 功能說明
獲取訂單貨款狀態。
3.2.2 接口規則
(1)、接口指令CMD1010。
3.2.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1010 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
3.2.4 應用級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| OrderNos |
String |
O |
訂單編號集合,號隔開 |
| BeginTime |
String |
O |
開始時間 如2016-01-10 |
| EndTime |
String |
O |
截止時間 如2016-01-15 |
| PageIndex |
Int |
O |
當前頁 |
| PageSize |
Int |
O |
頁大小 |
3.2.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
||
| EBusinessID |
String |
R |
請求用戶標識 |
||
| RequestType |
String |
O |
請求指令 |
||
| Success |
Bool |
R |
成功與否 |
||
| ResultCode |
String |
R |
|||
| Message |
String |
R |
返回消息 |
||
| Result |
PageIndex |
Int |
O |
當前頁 |
|
| PageSize |
Int |
O |
頁大小 |
||
| TotalCount |
Int |
O |
總記錄數 |
||
| TotalPage |
Int |
O |
總頁數 |
||
| ResultList |
OrderNo |
String |
O |
訂單號 |
|
| BillNo |
String |
O |
物流單號 |
||
| Int |
O |
出款狀態:1-待收款，2-已收款，3-已結清，4-已取消貸款，5-網點待放款 |
|||
| Amount |
decimal |
O |
貨款金額 |
||
| OutTime |
String |
O |
出款時間 |
||
| BankAccountNo |
String |
O |
帳號 |
||
| BankAccountName |
String |
O |
戶名 |
||
| BankName |
String |
O |
開戶銀行 |
||
|
|
|
CommisionAmount |
Decimal |
O |
服務費 |
3.2.6 Json請求示例
{
"OrderNos":"",
"BeginTime":"",
"EndTime":"",
"PageIndex":"1",
"PageSize":"10"
}
3.2.7 Json請求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1010",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"PageIndex": 1,
"PageSize": 10,
"TotalCount": 1,
"TotalPage": 1,
"ResultList": [
{
"OrderNo":"1234",
"Status": 0
}
]
}
}
4 下單
4.1 電子面單預覽
4.1.1 功能說明
顯示電子面單預覽界面
4.1.2 接口規則
(1)、接口指令CMD1023
4.1.3 系統級輸入參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
| RequestData |
String |
R |
請求內容，JSON格式,須和DataType一致 |
| EBusinessID |
String |
R |
用戶標識 |
| RequestType |
String |
R |
請求指令類型：CMD1023 |
| DataSign |
String |
R |
數據內容簽名 |
| DataType |
String |
O |
請求、返回數據類型：json； |
4.1.4 應用級參數
| 參數名稱 |
類型 |
是否必須 |
描述 |
|
| CallBack |
String |
O |
用戶自定義回調信息 |
|
| MemberID |
String |
O |
會員標識 平臺方與快遞鳥統一用戶標識的商家ID |
|
| CustomerName |
String |
O |
電子面單客戶帳號 （與快遞網點申請） |
|
| CustomerPwd |
String |
O |
電子面單密碼 |
|
| SendSite |
String |
O |
收件網點標識 |
|
| ShipperCode |
String |
R |
快遞公司編碼 |
|
| LogisticCode |
String |
O |
快遞單號 |
|
| OrderCode |
String |
R |
訂單編號 |
|
| ThrOrderCode |
String |
O |
第三方訂單編號 |
|
| MonthCode |
String |
C |
月結編碼 |
|
| PayType |
Int |
R |
郵費支付方式: 1-現付，2-到付，3-月結，4-第三方支付 |
|
| ExpType |
String |
R |
快遞類型：1-標準快件 |
|
| IsNotice |
Int |
O |
是否通知快遞員上門攬件：0-通知；1-不通知；不填則默認爲0 |
|
| Cost |
Double |
O |
寄件費（運費） |
|
| OtherCost |
Double |
O |
其餘費用 |
|
| Receiver |
Company |
String |
O |
收件人公司 |
| Name |
String |
R |
收件人 |
|
| Tel |
String |
R |
電話與手機，必填一個 |
|
| Mobile |
String |
|||
| PostCode |
String |
O |
收件人郵編 |
|
| ProvinceName |
String |
R |
收件省（如廣東省，不要缺乏「省」） |
|
| CityName |
String |
R |
收件市（如深圳市，不要缺乏「市」） |
|
| ExpAreaName |
String |
O |
收件區（如福田區，不要缺乏「區」或「縣」） |
|
| Address |
String |
R |
收件人詳細地址 |
|
| Sender |
Company |
String |
O |
發件人公司 |
| Name |
String |
R |
發件人 |
|
| Tel |
String |
R |
電話與手機，必填一個 |
|
| Mobile |
String |
|||
| PostCode |
String |
O |
發件人郵編 |
|
| ProvinceName |
String |
R |
發件省（如廣東省，不要缺乏「省」） |
|
| CityName |
String |
R |
發件市（如深圳市，不要缺乏「市」） |
|
| ExpAreaName |
String |
O |
發件區（如福田區，不要缺乏「區」或「縣」） |
|
| Address |
String |
R |
發件詳細地址 |
|
| StartDate |
String |
O |
上門取貨時間段: "yyyy-MM-dd HH:mm:ss"格式化，本文中全部時間格式相同 |
|
| EndDate |
String |
O |
||
| Weight |
Double |
O |
物品總重量kg |
|
| Quantity |
Int |
O |
件數/包裹數 |
|
| Volume |
Double |
O |
物品整體積m3 |
|
| Remark |
String |
O |
備註 |
|
| AddService |
Name |
String |
0 |
|
| Value |
String |
0 |
增值服務值 |
|
| CustomerID |
String |
0 |
客戶標識(選填) |
|
| Commodity |
GoodsName |
String |
R |
商品名稱 |
| GoodsCode |
String |
O |
商品編碼 |
|
| Goodsquantity |
Int |
O |
件數 |
|
| GoodsPrice |
Double |
O |
商品價格 |
|
| GoodsWeight |
Double |
O |
商品重量kg |
|
| GoodsDesc |
String |
O |
商品描述 |
|
| GoodsVol |
Double |
O |
商品體積m3 |
|
| IsReturnPrintTemplate |
String |
O |
返回電子面單模板： 0-不須要；1-須要 |
增值服務配置表
| 增值服務名稱（name） |
描述 |
Value |
| COD |
COD |
代收貨款金額 |
| CODBACK |
貨款直退 |
代收貨款金額 |
| CODPAY |
貨款墊付 |
代收貨款金額 |
| CODFAST |
網點速退 |
代收貨款金額 |
| SafeMail |
隱私快遞 |
1,2,3 |
SafeMail安全號生成規則（1，隱藏收件人信息，2.隱身發件人信息，3.同時隱藏收件人，發件人信息）
4.1.5 返回結果參數
| 參數名稱 |
類型 |
必需要求 |
說明 |
| EBusinessID |
String |
R |
請求用戶標識 |
| RequestType |
String |
R |
請求指令 |
| Success |
Bool |
R |
成功與否 |
| ResultCode |
String |
R |
|
| Message |
String |
R |
返回消息 |
| Result |
String |
O |
返回電子面單預覽模板 |
4.1.6 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": "COD",
"Value": "1020"
}
],
"Weight": 1.0,
"Quantity": 1,
"Volume": 0.0,
"Remark": "當心輕放",
"IsReturnPrintTemplate":1
}
4.1.7 JSON返回示例
{
"Success": true,
"RequestType": "cmd1023",
"EBusinessID": "1257227",
"ResultCode": "102",
"Result":「電子面單模板html」
}
4.2 電子面單
(http://kdniao.com/download->接口技術文檔.doc->3.3電子面單)
4.3 預定取件
參看快遞鳥預定取件接口介紹
(http://kdniao.com/download->接口技術文檔.doc->3.1預定取件)
5 附錄
5.1 返回代碼含義
| 級別 |
說明 |
|
| 系統級 |
100 |
成功 |
| 101 |
系統維護中 |
|
| 102 |
缺乏系統級參數 |
|
| 103 |
簽名驗證失敗 |
|
| 104 |
提交數據格式錯誤 |
|
| 105 |
IP受限 |
|
| 106 |
系統處理異常 |
|
| 107 |
指令爲空 |
|
| 108 |
沒法識別的指令 |
|
| 109 |
用戶不存在 |
|
| 110 |
失敗 |
|
| 應用級 |
201 |
缺乏參數 |
| 202 |
輸入參數格式錯誤 |
|
| 203 |
邏輯校驗失敗 |
|
|
|
|
|
5.2 快遞公司和業務類型的配置表
| 快遞公司 |
編碼 |
代收貨款(在線下單) |
代收貨款(電子面單) |
| 順豐 |
SF |
COD |
COD，貨款直退 |
| 龍邦 |
LB |
COD，貨款直退，貨款墊付 |
|
| 韻達 |
YD |
COD,貨款直退 |
COD,貨款直退 |
| EMS |
EMS |
COD,貨款直退 |
COD,貨款直退 |
6 技術支持
| 聯繫方式 |
號碼 |
| 韋振華 |
15899768843 |