华南通用下单对接文档


5-订单筛选接口

订单筛选接口-速运类API

EXP_RECE_FILTER_ORDER_BSP

1. 功能描述
  • 客户系统通过此接口向顺丰系统发送主动的筛单请求,用于判断客户的收、派地址是否属于顺丰的收派范围。
2. 接口定义
2.1. 公共参数
名称
接口服务代码 EXP_RECE_FILTER_ORDER_BSP
生产环境地址 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 已作废 Number 条件
7 msgData String 业务数据报文
2.3. 请求参数\ /OrderFilter
# 属性名 类型(约束) 必填 默认值 描述
1 filterType Number(1) 1 筛单类别: 1:自动筛单(系统根据地址库进行判断,并返回结果,系统无法检索到可派送的将返回不可派送) 2:可人工筛单(系统首先根据地址库判断,如果无法自动判断是否收派,系统将生成需要人工判断的任务,后续由人工处理,处理结束后,顺丰可主动推送给客户系统)
2 orderId String 客户订单号
3 monthlyCard String 月结卡号
4 contactInfos List 地址信息(详细参看下 2.3.1)

2.3.1 元素 contactInfos/FilterAddrInfoDto

# 属性名 类型(约束) 必填 默认值 描述
1 contactType Integer 地址类型 1:寄件方 2:到件方
2 tel String 联系电话
3 country String 国家或地区代码 2位
4 province String 省级行政区名称
5 city String 地级行政区名称
6 county String 县/区级行政区名称
7 address String 详细地址
8 postCode String 条件 邮编,跨境件必填
2.4. 公共响应参数
# 属性名 类型(约束) 必填 默认值 描述
1 success String true 请求成功,false 请求失败
2 errorCode String 错误编码,S0000成功
3 errorMsg String 错误描述
4 msgData String 返回的详细数据
2.5. 响应参数\
# 属性名 类型(约束) 必填 默认值 描述
1 orderId boolean 客户订单号
2 filterResult Integer 筛单结果:1:人工确认2:可收派3:不可以收派4 : 地址无法确认当filter_type=1时,不存在1值
3 originCode String 条件 原寄地区域代码,如果可收派,此项不能为空
4 destCode String 条件 目的地区域代码,如果可收派,此项不能为空
5 remark String 条件 如果filter_result=3时为必填,不可以收派的原因代码:1:收方超范围2:派方超范围3:其它原因
2.6. 请求示例\应用场景(JSON)示例

请求报文:

[
    {
        "contactInfos":[
            {
                "address":"创业总部基地B07二楼",
                "city":"天津市",
                "contactType":2,
                "country":"中国",
                "county":"武清区",
                "province":"天津市",
                "tel":"19851401196"
            },
            {
                "address":"测试订单,请不要接单",
                "city":"成都市",
                "contactType":1,
                "country":"中国",
                "county":"锦江区",
                "province":"四川省"
            }],
        "filterType":1
    }]
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
    "success": true,
    "errorCode": null,
    "errorMsg": null,
    "msgData": {
        "resDtos": [
            {
                "orderId": "TE201407020016",
                "filterResult": 3,
                "originCode": "test",
           "destCode": "test",
                "remark": "2"
            }
        ]
    }
}
  • 失败报文-范例1
{
    "success": false,
    "errorCode": 4001,
    "errorMsg": "系统发生数据错误或运行时异常",
    "msgData": null
}
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数据类型错误

页面列表

ITEM_HTML