清单运费推送接口-速运类API
EXP_RECE_WAYBILLS_FEE_PUSH
1. 功能描述
- 清单费用收费信息推送给客户,推送相关字段信息:订单号、运单号、子单号、月结账号等,根据配置的属性推送。
2. 接口定义
2.1. 公共参数
名称 |
值 |
接口服务代码 |
EXP_RECE_WAYBILLS_FEE_PUSH |
批量交易 |
不支持 |
接口类型 |
推送 |
报文类型 |
application/x-www-form-urlencoded |
2.2. 公共请求参数
2.3. 请求参数
元素名 |
类型(约束) |
必填 |
描述 |
|
1 |
orderNo |
String(100) |
Y |
客户下单时传入的订单号 |
2 |
waybillNo |
String(100) |
Y |
顺丰下单接口返回的15或12位运单号,母单号 如:SF10116351372291 |
3 |
childNos |
String(100) |
N |
多个用逗号隔开,子母件,当一票有多个包裹时,每个子件的运单号 |
4 |
customerAcctCode |
String(100) |
N |
10位数字,用来做账单结算的账号 |
5 |
meterageWeightQty |
String(100) |
Y |
包裹计费重量 单位kg |
6 |
productName |
String(100) |
Y |
如顺丰特惠,顺丰标快 |
7 |
quantity |
String(100) |
Y |
托寄物包裹数量 |
8 |
volume |
String(100) |
N |
托寄物总体积 |
9 |
feeList |
List |
N |
费用信息 |
2.3.1 元素 feeInfo
# |
元素名 |
类型(约束) |
必填 |
描述 |
1 |
bizOwnerZoneCode |
String(100) |
Y |
业务所属地区编码 |
2 |
currencyCode |
String(100) |
Y |
币别 |
3 |
customerAcctCode |
String(100) |
Y |
付款帐号 |
4 |
feeAmt |
String(100) |
Y |
金额 |
5 |
feeAmtInd |
String(100) |
Y |
个性化费用(如一些折扣或加价费用) |
6 |
feeIndType |
Number(2) |
Y |
个性费用类型 |
7 |
gatherEmpCode |
String(100) |
Y |
交款人 |
8 |
gatherZoneCode |
String(100) |
Y |
收付款网点 |
9 |
paymentChangeTypeCode |
String(100) |
Y |
付款变更类型 |
10 |
paymentTypeCode |
Number(2) |
Y |
付款类型 1 寄付 2 到付 3 第三方付 |
11 |
serviceId |
String(100) |
Y |
运单服务标记,可忽略 |
12 |
settlementTypeCode |
String(100) |
Y |
结算类型 1 现结 2 月结 |
13 |
versionNo |
Number(2) |
Y |
版本号 当红冲后版本号会增加 |
14 |
waybillId |
String(100) |
Y |
运单关联标记 可忽略 |
15 |
waybillNo |
String(50) |
Y |
运单母单号, |
16 |
feeTypeCode |
String(100) |
Y |
费用类型 1 主运费 2 其他费用 3 保费 4 代收货款服务费 5 代收货款 |
2.4. 公共响应参数
# |
属性名 |
类型(约束) |
必填 |
默认值 |
描述 |
1 |
success |
String |
是 |
|
true 请求成功,false 请求失败 |
2 |
errorCode |
String |
是 |
|
错误编码,S0000成功 |
3 |
errorMsg |
String |
是 |
|
错误描述 |
4 |
msgData |
String |
是 |
|
返回的详细数据 |
2.5. 响应参数
# |
元素名 |
类型(约束) |
必填 |
描述 |
1 |
code |
Int |
Y |
200成功 400失败 |
2 |
partnerCode |
String |
N |
合作伙伴code |
3 |
service |
String |
N |
服务code |
4 |
message |
String |
N |
失败时返回失败消息 |
2.6. 请求示例\应用场景(JSON)示例
请求报文:
sign=OGUzOWRhY2Y3N2JkYWNlMTZkOTNkMjI3NzYzNDVkOWU=&content={
"waybillNo": "444069129271",
"customerAcctCode": "9999999999",
"childNos": "002803693071,002803693099,002803693080",
"orderNo": "1dc300ee-d5bb-465f-86ed-f3f82a326153",
"meterageWeightQty": 12.5,
"volume": 0,
"quantity": 4,
"feeList": [
{
"bizOwnerZoneCode": "755A",
"currencyCode": "CNY",
"customerAcctCode": "9999999999",
"feeAmt": 1,
"feeAmtInd": 1,
"feeIndType": 0,
"feeTypeCode": "3",
"gatherEmpCode": "000212",
"gatherZoneCode": "755A",
"paymentChangeTypeCode": "0",
"paymentTypeCode": "1",
"serviceId": -1,
"settlementTypeCode": "2",
"versionNo": 0,
"waybillId": -1,
"waybillNo": "444069129271"
},
{
"bizOwnerZoneCode": "755A",
"currencyCode": "CNY",
"customerAcctCode": "9999999999",
"feeAmt": 13.2,
"feeAmtInd": 13.2,
"feeIndType": 0,
"feeTypeCode": "1",
"gatherEmpCode": "000212",
"gatherZoneCode": "755A",
"inputTm": 1545203801000,
"paymentChangeTypeCode": "0",
"paymentTypeCode": "1",
"settlementTypeCode": "2",
"versionNo": 0,
"waybillId": -1,
"waybillNo": "444069129271"
}
],
"productName": "标准快递"
}
2.7. 返回示例\应用场景(JSON)示例
响应报文:
{
"code": 200,
"partnerCode": "fengqiaoTest",
"service": "",
"msgData": ""
}
{
"code": 400,
"partnerCode": "fengqiaoTest",
"service": "",
"msgData": ""
}
3.1. 错误代码
3.1 (API)平台结果代码列表
3.2 业务异常代码
原因代码 errorCode |
描述 errorMsg |
分类 |
S0000 |
成功 |
是 |
S0001 |
非法的JSON格式 |
系统错误 |
S0002 |
必填参数为空 |
系统错误 |
S0003 |
系统发生数据错误或运行时异常 |
系统错误 |
3.2.1 业务状态编码
状态码 |
状态描述 |
04 |
调度失败/等待 |
04-40001 |
调度成功+收派员信息 |
04-40037 |
下单已接收 |
04-40002-40021 |
电话号码异常(电话错误/空号/停机) |
04-40002-40022 |
无法进入客户处,且客户不愿出来 |
04-40002-40004 |
暂未联系上客户(电话无人接听/无法接通/关机) |
04-40002-40005 |
经客户同意,更改收派时间 |
04-40002-40027 |
天气原因,延误收派件 |
04-40002-40028 |
交通原因,延误收派件 |
04-40002-40031 |
不符合收件要求,无法揽收 |
04-40002-40014 |
客户取消寄件 |
04-40002-40015 |
客户重复下单 |
04-40002-40016 |
下错单需转单 |
04-40002-40035 |
工作量过大,延误收派件 |
04-40002-40036 |
重货需转单 |
00-40045-1000 |
调度取消订单 |
00-2000 |
客户已取消订单 |
05-40003 |
已正常收件状态 |