华南通用下单对接文档


6-子单号申请接口

子单号申请接口-速运类API

EXP_RECE_GET_SUB_MAILNO

1. 功能描述
  • 客户在下单成功后 ,因业务场景需要可以调用此接口获取更多的子单号数。但不能超过配置的最大数/1200个。
2. 接口定义
2.1. 公共参数
名称
接口服务代码 EXP_RECE_GET_SUB_MAILNO
生产环境地址 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_GET_SUB_MAILNO)
4 timestamp long 调用接口时间戳
5 已作废 String(128) 条件
6 已作废 String 条件
7 msgData String 业务数据报文
2.3. 请求参数\ /SubMailNoReqDto
# 字段 类型 必填 描述
1 orderId String(64) 客户订单号
2 parcelQty Integer 子单号数
3 waybillNoInfoList List[waybillNoInfo]见:下单接口 顺丰运单号子单申请需要指定每个子包裹的长宽高提交重量时需要传入此参数
2.4. 公共响应参数
# 属性名 类型(约束) 必填 默认值 描述
1 success String true 请求成功,false 请求失败
2 errorCode String 错误编码,S0000成功
3 errorMsg String 错误描述
4 msgData String 返回的详细数据
2.5. 响应参数\ /OrderUpdateResponse
# 属性名 类型(约束) 必填 默认值 描述
1 orderId String(64) 客户订单号
2 parcelQty Integer 子单号数
3 waybillNoInfoList List 运单号
2.6. 请求示例\应用场景(JSON)示例

请求报文:

{
    "orderId ": "F2_20200408122346",
    "parcelQty": 2
}
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
    "success": true,
    "errorCode": "S0000",
    "errorMsg": null,
    "msgData": {
        "orderId": "F2_20200408122346",
        "waybillNoInfoList": [{
            "waybillType": 2,
            "waybillNo": "SF2000169567604"
        }, {
            "waybillType": 1,
            "waybillNo": "SF1011638677010"
        }]
    }
}
  • 失败响应:
{
    "success": false,
    "errorCode": "A1099",
    "errorMsg": null,
    "msgData": ""
}
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 8168 订单已生成路由不能申请子单 该订单已揽收
2 6150 找不到该订单 确认订单号orderId是否传错

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

页面列表

ITEM_HTML