1-运单号合法性校验接口

运单号合法性校验接口-速运类API

EXP_RECE_VALIDATE_WAYBILLNO

---

1. 功能描述

• 提供顺丰运单号合法性校验功能。

2. 接口定义

2.1. 公共参数

名称	值
接口服务代码	EXP_RECE_VALIDATE_WAYBILLNO
生产环境地址	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

2.2. 公共请求参数

序号	参数列表	类型	是否必传	含义
1	已作废	String(64)	是
2	requestID	String(40)	是	请求唯一号UUID
3	serviceCode	String(50)	是	接口服务代码
4	timestamp	long	是	调用接口时间戳
5	已作废	String(128)	条件	数字签名,使用数字签名方式认证时必填 签名方法参考：数字签名认证说明
6	expiresIn	Number	条件	已作废,使用OAuth2方式认证时必填 获取方法参考：OAuth2认证说明
7	msgData	String	是	业务数据报文

2.3. 请求参数\

#	元素名	类型（约束）	必填	默认值	描述
1	waybillNo	String(15)	Y		运单号 （支持12位或者15位运单号）

2.4. 公共响应参数

#	属性名	类型(约束)	必填	默认值	描述
1	success	String	是		true 请求成功，false 请求失败
2	errorCode	String	是		错误编码，S0000成功
3	errorMsg	String	是		错误描述
4	msgData	String	是		返回的详细数据

2.5. 响应参数\

#	元素名	类型（约束）	必填	默认值	描述
1	success	boolean	Y		成功返回true;失败返回false
2	errorCode	String	N		失败原因代码，如4001
3	errorMsg	String	N		失败原因，失败时记录具体原因，如系统异常
4	msgData	String	N		运单号合法，返回true；否则返回false；

2.6. 请求示例\应用场景(JSON)示例

请求报文:

{
    "waybillNo":"SF1040275268927"
}

2.7. 返回示例\应用场景(JSON)示例

响应报文:

• 成功响应:

{
    "success": true,
    "errorCode": "S0000",
    "errorMsg": null,
    "msgData": true
}

• 失败响应

{
    "success": true,
    "errorCode": "S0000",
    "errorMsg": null,
    "msgData": false
}

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	描述
1	S0000	成功
2	S0001	非法的JSON格式
3	S0002	必填参数%s为空
4	S0003	系统发生数据错误或运行时异常
5	S0004	参数%s超过最大长度%d
6	S0005	参数超过最大值
7	S0006	参数%s不能小于%d
8	S0007	参数%s数据类型错误