华南通用下单对接文档


3-订单结果查询接口

订单结果查询接口-速运类API

EXP_RECE_SEARCH_ORDER_RESP

1. 功能描述
  • 因Internet环境下,网络不是绝对可靠,用户系统下订单到顺丰后,不一定可以收到顺丰系统返回的数据,此接口用于在未收到返回数据时,查询订单创建接口客户订单当前的处理情况。
2. 接口定义
2.1. 公共参数
名称
接口服务代码 EXP_RECE_SEARCH_ORDER_RESP
生产环境地址 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_SEARCH_ORDER_RESP)
4 timestamp long 调用接口时间戳
5 已作废 String(128) 条件
6 已作废 String 条件
7 msgData String 业务数据报文
2.3. 请求参数\ /OrderSearchReqDto
属性名 类型(约束) 必填 默认值 描述
1 orderId String(64) 客户订单号
2 searchType String(10) 查询类型:1正向单 2退货单
3 language String(100) 语言
2.4. 公共响应参数
# 属性名 类型(约束) 必填 默认值 描述
1 success String true 请求成功,false 请求失败
2 errorCode String 错误编码,S0000成功
3 errorMsg String 错误描述
4 msgData String 返回的详细数据
2.5. 响应参数\ /OrderSearchRespDto
# 属性名 类型(约束) 必填 默认值 描述
1 orderId String(64) 客户订单号
2 originCode String(30) 1 原寄地区域代码,可用 于顺丰电子运单标签打印
3 destCode String(30) 目的地区域代码,可用 于顺丰电子运单标签打印
4 filterResult String(30) 筛单结果: 1:人工确认 2:可收派 3:不可以收派
5 returnExtraInfoList List 返回信息扩展属性
6 waybillNoInfoList List 顺丰运单号
7 routeLabelInfo List 路由标签数据
2.5.1 元素 returnExtraInfoList/List
# 属性名 类型(约束) 必填 描述
1 attrName String(30) 扩展属性名
2 attrVal String(30) 扩展属性值
2.5.2 元素 waybillNoInfoList/List
# 属性名 类型(约束) 必填 描述
1 waybillType String(30) 运单号类型 1:母单 2 :子单 3 : 签回单
2 waybillNo String(30) 运单号
2.5.3 元素 routeLabelInfo/List
# 属性名 类型(约束) 必填 描述
1 code String(30) 0000(接口参数异常) 0010(其它异常) 0001(xml解析异常) 0002(字段校验异常) 0003(票数节点超出最大值, 批量请求最大票数为100票) 0004(RLS获取路由标签的必要 字段为空) 1000 成功
2 message String(30) code为0XXX时的错误消息
3 routeLabelData RouteLabelRespDetailDto 路由标签响应详情
2.5.4 元素 routeLabelInfo/List/routeLabelData/RouteLabelRespDetailDto
# 属性名 类型(约束) 必填 默认值 描述
1 waybillNo String(30) 运单号
2 sourceTransferCode String(60) 原寄地中转场
3 sourceCityCode String(60) 原寄地城市代码
4 sourceDeptCode String(60) 原寄地网点代码
5 sourceTeamCode String(60) 原寄地单元区域
6 destCityCode String(60) 目的地城市代码,eg:755
7 destDeptCode String(60) 目的地网点代码,eg:755AQ
8 destDeptCodeMapping String(60) 目的地网点代码映射码
9 destTeamCode String(60) 目的地单元区域,eg:001
10 destTeamCodeMapping String(60) 目的地单元区域映射码
11 destTransferCode String(60) 目的地中转场
12 destRouteLabel String(200) 打单时的路由标签信息如果是大网的路由标签,这里的值是目的地网点代码,如果是同城配的路由标签,这里的值是根据同城配的设置映射出来的值,不同的配置结果会不一样,不能根据-符号切分(如:上海同城配,可能是:集散点-目的地网点-接驳点,也有可能是目的地网点代码-集散点-接驳点)
13 twoDimensionCode String(600) 二维码根据规则生成字符串信息,格式为MMM={'k1':'(目的地中转场代码)','k2':'(目的地原始网点代码)','k3':'(目的地单元区域)','k4':'(附件通过三维码(express_type_code、 limit_type_code、 cargo_type_code)映射时效类型)','k5':'(运单号)','k6':'(AB标识)'}
14 proCode String(30) 时效类型:值为二维码中的K4
15 printIcon String(100) 打印图标根据托寄物判断需要打印的图标(重货,蟹类,生鲜,易碎,Z标)?返回值有8位,每一位只有0和1两种,0表示按运单默认的规则,1表示显示。后面两位默认0备用。顺序如下:重货,蟹类,生鲜,易碎,医药类,Z标,0,0如:00000000表示不需要打印重货,蟹类,生鲜,易碎,医药,Z标,备用,备用
16 abFlag String(30) AB标
17 errMsg String(1000) 查询出现异常时返回信息。返回代码:0 系统异常1 未找到运单
18 destPortCode String(100) 目的地口岸代码
19 destCountry String(50) 目的国别(国别代码如:JP)
20 destPostCode String(100 目的地邮编
21 goodsValueTotal String(30) 总价值(保留两位小数,数字类型,可补位)
22 currencySymbol String(30) 币种
23 goodsNumber String(20) 件数
24 twoDimensionCode String(600) 二维码根据规则生成字符串信息,格式为MMM={'k1':'(目的地中转场代码)','k2':'(目的地原始网点代码)','k3':'(目的地单元区域)','k4':'(附件通过三维码(express_type_code、 limit_type_code、 cargo_type_code)映射时效类型)','k5':'(运单号)','k6':'(AB标识)'}
25 proCode String(30) 时效类型:值为二维码中的K4
26 printIcon String(100) 打印图标根据托寄物判断需要打印的图标(重货,蟹类,生鲜,易碎,Z标)?返回值有8位,每一位只有0和1两种,0表示按运单默认的规则,1表示显示。后面两位默认0备用。顺序如下:重货,蟹类,生鲜,易碎,医药类,Z标,0,0如:00000000表示不需要打印重货,蟹类,生鲜,易碎,医药,Z标,备用,备用
27 abFlag String(30) AB标
28 errMsg String(1000) 查询出现异常时返回信息。返回代码:0 系统异常1 未找到运单
29 destPortCode String(100) 目的地口岸代码
30 destCountry String(50) 目的国别(国别代码如:JP)
31 destPostCode String(100 目的地邮编
32 goodsValueTotal String(30) 总价值(保留两位小数,数字类型,可补位)
33 currencySymbol String(30) 币种
34 goodsNumber String(20) 件数
2.6. 请求示例\应用场景(JSON)示例

请求报文:

{
    "searchType": "1",
    "orderId": "TE201407020016",
    "language": "zh-cn"
}
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
    "errorCode": "S0000",
    "msgData": {
        "destcode": "020",
        "filterResult": "2",
        "orderId": "2020051114001",
        "origincode": "769",
        "routeLabelInfo": [{
            "code": "1000",
            "message": "SF7444400034485:",
            "routeLabelData": {
                "abFlag": "",
                "cargoTypeCode": "C201",
                "checkCode": "5f5f8a2d",
                "codingMapping": "C50",
                "codingMappingOut": "1",
                "currencySymbol": "",
                "cusBatch": "",
                "destCityCode": "020",
                "destCountry": "",
                "destDeptCode": "020AA",
                "destDeptCodeMapping": "020W",
                "destGisDeptCode": "020AA",
                "destPortCode": "",
                "destPostCode": "",
                "destRouteLabel": "020AA",
                "destTeamCode": "",
                "destTeamCodeMapping": "",
                "destTransferCode": "020",
                "errMsg": "",
                "expressTypeCode": "B1",
                "fbaIcon": "",
                "fileIcon": "",
                "goodsNumber": "",
                "goodsValueTotal": "",
                "icsmIcon": "",
                "limitTypeCode": "T4",
                "printFlag": "000000000",
                "printIcon": "00100000",
                "proCode": "T4",
                "proIcon": "",
                "proName": "顺丰标快",
                "sourceCityCode": "769",
                "sourceDeptCode": "769",
                "sourceTeamCode": "",
                "sourceTransferCode": "",
                "twoDimensionCode": "MMM={'k1':'020','k2':'020AA','k3':'','k4':'T4','k5':'SF7444400034485','k6':'','k7':'5f5f8a2d'}",
                "waybillNo": "SF7444400034485",
                "xbFlag": "0"
            }
        },
        {
            "code": "1000",
            "message": "SF7444600201958:",
            "routeLabelData": {
                "abFlag": "",
                "cargoTypeCode": "C201",
                "checkCode": "ae1f2320",
                "codingMapping": "K01",
                "codingMappingOut": "",
                "currencySymbol": "",
                "cusBatch": "",
                "destCityCode": "769",
                "destCountry": "",
                "destDeptCode": "769K",
                "destDeptCodeMapping": "769WA",
                "destGisDeptCode": "769K",
                "destPortCode": "",
                "destPostCode": "",
                "destRouteLabel": "769K",
                "destTeamCode": "",
                "destTeamCodeMapping": "",
                "destTransferCode": "769",
                "errMsg": "",
                "expressTypeCode": "B1",
                "fbaIcon": "",
                "fileIcon": "",
                "goodsNumber": "",
                "goodsValueTotal": "",
                "icsmIcon": "",
                "limitTypeCode": "T4",
                "printFlag": "000000000",
                "printIcon": "00100000",
                "proCode": "T4",
                "proIcon": "",
                "proName": "顺丰标快",
                "sourceCityCode": "020",
                "sourceDeptCode": "",
                "sourceTeamCode": "",
                "sourceTransferCode": "",
                "twoDimensionCode": "MMM={'k1':'769','k2':'769K','k3':'','k4':'T4','k5':'SF7444600201958','k6':'','k7':'ae1f2320'}",
                "waybillNo": "SF7444600201958",
                "xbFlag": "0"
            }
        }],
        "waybillNoInfoList": [{
            "waybillNo": "SF7444400034485",
            "waybillType": 1
        },
        {
            "waybillNo": "SF7444500019626",
            "waybillType": 2
        },
        {
            "waybillNo": "SF7444500019634",
            "waybillType": 2
        },
        {
            "waybillNo": "SF7444600201958",
            "waybillType": 3
        }]
    },
    "success": true
}
  • 失败报文-范例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 8018 未获取到订单信息 确认订单号orderId是否传错
2 6150 找不到该订单 确认订单号orderId是否传错
3 6135 未传入订单信息 传入格式错误

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

页面列表

ITEM_HTML