华南通用下单对接文档


14-清单运费查询接口

清单运费查询接口-速运类API

EXP_RECE_QUERY_SFWAYBILL

1. 功能描述
  • 此功能主要是根据订单号或者运单号查询清单运费信息。
2. 接口定义
2.1. 公共参数
名称
接口服务代码 EXP_RECE_QUERY_SFWAYBILL
生产环境地址 https://sz-mix.sf-express.com/backend/std/service/{hnCustomerCode} 生产{hnCustomerCode}请向大客获取。
沙箱环境地址 https://sz-mix.sit.sf-express.com/backend/std/service/{hnCustomerCode} 测试{hnCustomerCode}统一为11aeea6bdd7fbae1
批量交易 不支持
接口类型 接入
报文类型 JSON/XML
2.2. 公共请求参数
序号 参数列表 类型 是否必传 含义
1 已作废 String(64)
2 requestID String(40) 请求唯一号UUID
3 serviceCode String(50) 接口服务代码(EXP_RECE_QUERY_SFWAYBILL)
4 timestamp long 调用接口时间戳
5 已作废 String(128) 条件
6 已作废 String 条件
7 msgData String 业务数据报文
2.3. 请求参数\ /QuerySFWaybill
# 字段 类型 必填 描述
1 trackingType String 1:表示按订单查询 2:表示按运单查询
2 trackingNum String 订单号或运单号;
3 phone String 条件 配置校验手机号时必传,支持最高6个收寄方电话后4位下发, 每个电话号码使用英文逗号分隔
4 bizTemplateCode String 业务配置代码,针对客户业务需求配置的一套接口处理逻辑,一个接入编码可对应多个业务配置代码
2.4. 公共响应参数
# 属性名 类型(约束) 必填 默认值 描述
1 success String true 请求成功,false 请求失败
2 errorCode String 错误编码,S0000成功
3 errorMsg String 错误描述
4 msgData String 返回的详细数据
2.5. 响应参数\
# 属性名 类型(约束) 默认值 描述
1 waybillInfo object 运单信息
2 waybillFeeList list 费用信息

2.3.1.1 元素 waybillInfo

# 属性名 类型(约束) 描述
1 waybillNo String(30) 运单号
2 orderId String(64) 客户订单号
3 waybillChilds String 子单号,英文逗号分隔
4 customerAcctCode String(64) 月结帐号
5 meterageWeightQty Double 计费重量
6 realWeightQty Double 实际重量
7 consigneeEmpCode String(30) 收件员工号
8 deliverEmpCode String(30) 派件员工号
9 cargoTypeCode String(30) 快件内容
10 cargoTypeName String(30) 快件内容名称
11 limitTypeCode String(30) 时效类型
12 limitName String(30) 时效类型名称
13 expressTypeCode String(30) 业务类型
14 expressTypeName String(30) 业务类型名称
15 consValue Double 声明价值
16 consValueCurrencyCode String(30) 声明价值币种
17 productCode String(30) 产品代码
18 productName String(30) 产品名称
19 jProvince String(30) 寄件省份
20 jCity String(30) 寄件城市
21 consignorAddr String(30) 寄件详细地址
22 consignorContName String(30) 寄件联系人
23 consignorPhone String(30) 寄件电话号码
24 consignorMobile String(30) 寄件手机号
25 dProvince String(30) 收件省份
26 dCity String(30) 收件城市
27 addresseeAddr String(30) 收件详细地址
28 addresseeContName String(30) 收件联系人
29 addresseePhone String(30) 收件电话号码
30 addresseeMobile String(30) 收件手机号

2.3.1.2 元素 waybillFeeList

# 属性名 类型(约束 描述
1 type String(3) 费用类型
2 name String(30) 费用名称
3 value Double 费用金额
4 paymentTypeCode String(1) 付款类型:1、寄付;2、到付;3、第三方付
5 settlementTypeCode String(1) 结算类型:1为现结;2为月结
6 serviceProdCode String(30) 增值服务代码
7 insuredValue String(30) 保价金额
8 customerAcctCode String(30) 月结账号
备注:费用类型说明
type字段 name费用释义
1 运费
2 其它费用
3 保价
4 代收货款
5 代收货款
6 正式报关
7 等通知派送
8 签单返还
10 指定派送费用
12 标准化包装服务
13 香港偏远件
14 燃油附加费
19 委托件
20 上门收款服务费
21 特派服务
23 特安服务
24 指定日期派送费
26 定时派送(指定时段)
27 台湾保价
28 自寄件费用
29 自取件费用
34 台湾偏远附加费
35 冷冻箱1
37 特殊增值服务费用
38 检测服务
39 木质包装
40 住宅附加费
41 定时派送
42 POS手续费
43 存仓费
44 散单代收服务
45 送货上楼
46 货物保管
47 保鲜服务
48 超长超重服务
49 节假日派送
52 验货服务
53 换货服务
56 拍照验证
57 酒宴稽核
59 口令签收
62 散单代收服务
62 散单代收服务
63 代办航空申报
65 装卸服务
66 挂号
67 个性化包装服务
71 报关综合服务费
72 清关综合服务费
73 提货服务
74 送货服务
ES078 特惠提货费
79 医院服务
83 精准温控2-8°C
84 买卖保
85 维修服务
86 更改付款方式
87 保单配送
88 派件地址变更服务
90 易碎件
91 电子验收
92 高峰资源调节费
93 原单退回
94 顺丰国际小包平邮处理费1
96 国际电商专递操作费
97 顺丰国际小包退回费
98 大件入户
99 税金
101 票据专送
102 优惠
103 安装服务
104 高峰期附加费
105 签收确认服务
106 特殊入仓
107 优派服务
108 海外高峰期附加费
113 丰巢寄件优惠
2.6. 请求示例\应用场景(JSON)示例

请求报文:

{
'trackingNum':'SF1011854711123',
'trackingType':'2'
}
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
    "apiResponseID": "0001732719DD763FEABEEBA244A5B23F",
    "apiErrorMsg": "",
    "apiResultCode": "A1000",
    "apiResultData": "{\"errorCode\":\"S0000\",\"msgData\":{\"waybillFeeList\":[{\"customerAcctCode\":\"9999999999\",\"name\":\"保费\",\"paymentTypeCode\":\"1\",\"settlementTypeCode\":\"2\",\"type\":\"1\",\"value\":205.0},{\"customerAcctCode\":\"9999999999\",\"paymentTypeCode\":\"2\",\"settlementTypeCode\":\"2\",\"type\":\"3\",\"value\":2.0}],\"waybillInfo\":{\"addresseeAddr\":\"北京市-市辖区-朝阳区-十里河文化园a座9楼\",\"addresseeContName\":\"好先生\",\"addresseeMobile\":\"13976655900\",\"billHigh\":0.0,\"billLong\":0.0,\"billWidth\":0.0,\"cargoTypeCode\":\"SP636\",\"consignorAddr\":\"广东省深圳市福田上沙东村0号\",\"consignorContName\":\"潘俊儒\",\"consignorMobile\":\"17688939300\",\"consignorPhone\":\"17688939300\",\"customerAcctCode\":\"9999999999\",\"destZoneCode\":\"755\",\"expressTypeCode\":\"B2\",\"limitTypeCode\":\"T6\",\"meterageWeightQty\":1.0,\"shieldFlg\":\"0\",\"sourceZoneCode\":\"755A\",\"volume\":35000.0,\"waybillNo\":\"SF7444400035470\"}},\"success\":true}"
  • 失败报文-范例1
{
    "apiResponseID": "000173271968963FA47C03E68000103F",
    "apiErrorMsg": "",
    "apiResultCode": "A1000",
    "apiResultData": "{\"errorMessage\":\"非法的JSON格式\",\"success\":false,\"errorCode\":\" S0001\"}"
}
3.1. 错误代码
3.1 (API)平台结果代码列表
标识 说明 【处理建议】
A1000 统一接入平台校验成功,调用后端服务成功; 注意:不代表后端业务处理成功,实际业务处理结果, 需要查看响应属性apiResultData中的详细结果
A1001 必传参数不可为空 serviceCode 已作废 requestID timestamp 已作废 msgData 不可为空
A1002 请求时效已过期 时效参考auth2 https://open.sf-express.com/customerService/395002?interId=590549&faqId=4
A1003 IP无效 参考常见问题 https://open.sf-express.com/customerService/395002?activeIndex=905584&interId=590549&faqId=2
A1004 无对应服务权限 联系销售经理,配置权限
A1005 流量受控 测试环境流量限制为5000,请不要在测试环境做压测
A1006 数字签名无效 参考常见问题 签名加解密问题 https://open.sf-express.com/customerService/395002?activeIndex=905584&interId=795986
A1007 重复请求 过一分钟在尝试
A1008 数据解密失败
A1009 目标服务异常或不可达
A1099 系统异常
3.2 业务异常代码
原因代码 errorCode 描述 errorMsg 【处理建议】
8148 没有运单信息! 该订单还未揽收
8149 无法找到订单数据! 确认传入的订单号或者运单号是否正确

速运类接口业务相关错误码

页面列表

ITEM_HTML