华南通用下单对接文档


1-路由注册接口

路由注册接口-速运类API

EXP_RECE_REGISTER_ROUTE

1. 功能描述
  • 此功能主要是向外提供路由注册功能。 备注:对接该接口前,请先对接前置接口:路由推送接口。路由注册成功后,系统会将路由信息通过路由推送接口给客户

    注意: 请先在丰桥设定模式 (设定路径:控制台》开发者对接》查看API》路由注册接口,查看》配置信息》点击 ✎ 选择查询)

    1.1、订单号模式:(type=1)
    type为1订单模式,丰桥页面勾选没有强制效果
    根据订单号+顾客编码(已作废),查询订单信息,存在,即可注册成功
    1.2、运单号模式:(type=2)
    type为2运单号模式,丰桥页面勾选没有强制效果
    根据运单号+顾客编码,查询订单信息,存在,即可注册成功
    根据运单号+顾客编码+校验月结卡号,查询订单信息,存在,即可注册成功
    1.3、电话号码模式注册:(type=1或者type=2)
    订单号模式-校验收寄任一方的手机号后四位
    运单号模式-校验收寄任一方的手机号后四位
2. 接口定义
2.1. 公共参数
名称
接口服务代码 EXP_RECE_REGISTER_ROUTE
生产环境地址 https://sfapi.sf-express.com/std/service
沙箱环境地址 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) 接口服务代码(EXP_RECE_SEARCH_ROUTES)
4 timestamp long 调用接口时间戳
5 已作废 String(128) 条件 数字签名,使用数字签名方式认证时必填 签名方法参考:数字签名认证说明
6 expiresIn Number 条件 已作废,使用OAuth2方式认证时必填 获取方法参考:OAuth2认证说明
7 msgData String 业务数据报文
2.3. 请求参数\
# 元素名 类型(约束) 必填 默认值 描述
1 type String(1) 1-按订单号注册, 2-按运单号注册默认为1
2 attributeNo String(100) 订单号或者运单号
3 checkPhoneNo String(20) 电话号码后四位
4 orderId String(100)
5 clientIp String(60)
6 language String(20) 目前支持以下值zh-CN表示中文简体, zh-TW或zh-HK或zh-MO表示中文繁体,en表示英文
7 country String(20)
2.4. 公共响应参数
# 属性名 类型(约束) 必填 默认值 描述
1 success String true 请求成功,false 请求失败
2 errorCode String 错误编码,S0000成功
3 errorMsg String 错误描述
4 msgData String 返回的详细数据
2.5. 响应参数\
# 元素名 类型(约束) 必填 默认值 描述
1 success boolean 成功返回true;失败返回false
2 errorCode String 失败原因代码,如4001
3 errorMsg String 失败原因,失败时记录具体原因,如系统异常
4 msgData String 成功时返回的订单数据数据
2.6. 请求示例\应用场景(JSON)示例

请求报文:

{
    "attributeNo": "SF1040300507426",
    "type": "2",
    "checkPhoneNo": "9784",
    "orderId": "",
    "clientIp": "10.118.92.11",
    "language": "zh-CN",
    "country": "CN"
}
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
    "success": "true",
    "errorCode": "",
    "errorMsg": "",
    "msgData": "{\"attributeNo\": \"SF1040300507426\",\"type\": \"2\",\"checkPhoneNo\": \"9784\", \"orderId\": \"\",\"clientIp\": \"10.118.92.11\", \"language\": \"zh-CN\",\"country\": \"CN\"}"
}
  • 失败报文-范例1
{
    "apiErrorMsg": "",
    "apiResponseID": "00016ABEC9ECCB3FE1C04106BA87EF3F",
    "apiResultCode": "A1000",
    "apiResultData": "{***}"
}
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 20053 路由注册次数超值 路由注册调用次数超过限制,默认值:

页面列表

ITEM_HTML