华南通用下单对接文档


8-截单转寄退回接口

截单转寄退回接口-速运类API

EXP_RECE_WANTED_INTERCEPT

1. 功能描述
  • 客户可通过接口通缉拦截接口对运单进行通缉拦截。
2. 接口定义
2.1. 公共参数
名称
接口服务代码 EXP_RECE_WANTED_INTERCEPT
生产环境地址 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_WANTED_INTERCEPT)
4 timestamp long 调用接口时间戳
5 已作废 String(128) 条件
6 已作废 String 条件
7 msgData String 业务数据报文
2.3. 请求参数\
# 字段 类型 必填 描述
1 waybillNo String 运单号
2 serviceCode String 1转寄2退回3优派4再派5改自取(改派-其他自取点取件)6改派送(上门派送)7更改派送时间8修改收件人信息9更改付款方式10修改代收货款12作废
3 role String 发起方1(寄方)2(收方)3(第三方)
4 payMode String 付款方式:1寄付 2到付 3转第三方月结 4寄付月结
5 monthlyCardNo String 月结卡号如果是月结账户,必填字段。付款方式为月结时,必填字段。修改代收货款,必填字段
6 productType String 产品类型
7 codAmount Double 代收货款金额
8 deliverDate String 派送日期,形如“2018-05-02”
9 deliverTimeMin String 派送最早时间,形如“09:00”
10 deliverTimeMax String 派送最晚时间,形如“12:00”
11 selfPickPoint String 自取点 1-合作点 2-快递柜 3-网点 4中转场
12 newDestAddress Obj 新目的地改联系人业务请携带姓名及手机号转寄、退回业务必须携带,撤销转寄、退回不携带改自取必须携带

2.3.1 元素 newDestAddress

# 参数名 参数类型 必填 描述
1 country String 国家,默认中国
2 countryCode String 国家编码,默认CN
3 province String 省,如广东省
4 city String 市,如深圳市
5 county String 区,如南山区
6 address String 详细地址,不包含省市区,如粤海街道高新区1C栋二楼
7 company String 公司
8 contact String 联系人姓名,如黄飞鸿
9 phone String 电话,如18012345678
10 areaCode String 网点代码,如755WQ
11 locationCode String 城市代码
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 失败原因代码,成功时为空,如A1099
3 errorMsg String 失败原因,失败时记录具体原因,如系统异常
4 msgData String 返回结果
2.6. 请求示例\应用场景(JSON)示例

请求报文:

{
    "cancel":false,
    "deliverDate":"2020-04-30",
    "deliverTimeMax":"12:00",
    "deliverTimeMin":"09:00",
    "monthlyCardNo":"9999999999",
    "newDestAddress":{
        "address":"粤海街道海阔天空雅居B栋16B",
        "city":"深圳市",
        "contact":"周大星",
        "county":"南山区",
        "phone":"15922226666",
        "province":"广东省"
    },
    "payMode":"3",
    "role":"1",
    "serviceCode":"7",
    "waybillNo":"SF444201931741"
}
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
    "success": true,
    "errorCode": "S000",
    "errorMsg": null,
    "msgData": null
}
  • 失败报文-范例1
{
    "success": false,
    "errorCode": "S0001",
    "errorMsg": "非法的JSON格式",
    "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 8199 未找到对应订单信息,无法发起通缉拦截 确认运单号传入是否有误
2 8198 通缉截单的新地址信息不能为空 转寄或者退回新的地址 需要传入新地址信息
3 8237 传入月结卡号与源订单月结卡号不匹配,无法发起通缉、拦截 月结卡号与该订单下单的月结卡号不一致
4 8251 转寄地址不在服务范围 联系销售经理查询服务地址范围
5 20088 第三方ERP客户只允许发起拦截退回、转寄! serviceCode修改为 1 2

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

页面列表

ITEM_HTML