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 |