华南通用下单对接文档


1-订单状态推送接口

订单状态推送接口-速运类API

PushOrderState

1. 功能描述
  • 此接口用于订单状态推送,将订单状态的各类信息推送给对接的客户; 仅限于推送预约上门订单调度状态,非预约订单不推送。 注意: 1、回调地址为HTTPS的客户将无法收到订单状态信息的推送,一定要使用HTTPS地址的客户请线下联系地区IT 2、联调测试,地区IT联系方式可拨95338或月结客户经理处获取。
2. 接口定义
2.1. 公共参数
名称
接口服务代码 PushOrderState
接口方式 HTTP POST Content_type:application/xml;charset=UTF-8
接口类型 推送
报文类型 顺丰支持3种格式推送供客户自行选择1、form2、xml3、json
2.2. 公共请求参数
2.3. 请求参数\
# 属性名 类型(约束) 必填 描述
1 orderNo String(64) 客户订单号
2 waybillNo String(64) 顺丰运单号
3 orderStateCode String(20) 订单状态
4 orderStateDesc String(200) 订单状态描述
5 empCode String(100) 收件员工工号
6 empPhone String(100) 收件员手机号
7 netCode String(20) 网点
8 lastTime date 最晚上门时间
9 bookTime date 客户预约时间
10 carrierCode String(10) 承运商代码(SF)
2.4. 公共响应参数
2.5. 响应参数\
# 属性名 类型(约束) 必填 默认值 描述
1 success String(10) 是否成功接收 true:是 false:否
2 msg String(200) 接收失败异常描述
2.6. 请求示例\应用场景(JSON)示例

请求报文:

{
 "requestId": "0597a8d2-42e3-46d6-86e9-14acf03598de",
 "timestamp": "1630376445286",
 "orderState": [{
  "orderNo": "442321000025419019",
  "waybillNo": "SF7444778095881",
  "orderStateCode": "04",
  "orderStateDesc": "调度失败/等待",
  "empCode": "",
  "empPhone": "",
  "netCode": "755A",
  "lastTime": "2021-08-31 09:00:00",
  "bookTime": "2021-08-31 09:00:00",
  "carrierCode": "SF",
  "createTm": "2021-08-31 09:00:00"
 }]
}
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
    "success": "true",
    "code": "0",
    "msg": ""
}
  • 失败报文-范例1
{
    "success": "false",
    "msg": "订单状态接收异常"
}
2.7. 请求示例\应用场景(XML)示例

请求报文:


    444123456789
    2018-04-16 15:23:24
    845215
    04-40001
    755A
    2018-04-16 15:23:24
    sf20124512
    13888888888
    调度成功,收派员信息
    SF

响应报文:

  • 成功响应:

    true
  • 失败报文-范例1

    false
    订单状态接收异常
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 描述 errorMsg 分类
S0000 成功
S0001 非法的JSON格式 系统错误
S0002 必填参数为空 系统错误
S0003 系统发生数据错误或运行时异常 系统错误
3.2.1 业务状态编码
状态码 状态描述
04 调度失败/等待
04-40001 调度成功+收派员信息
04-40037 下单已接收
04-40002-40021 电话号码异常(电话错误/空号/停机)
04-40002-40022 无法进入客户处,且客户不愿出来
04-40002-40004 暂未联系上客户(电话无人接听/无法接通/关机)
04-40002-40005 经客户同意,更改收派时间
04-40002-40027 天气原因,延误收派件
04-40002-40028 交通原因,延误收派件
04-40002-40031 不符合收件要求,无法揽收
04-40002-40014 客户取消寄件
04-40002-40015 客户重复下单
04-40002-40016 下错单需转单
04-40002-40035 工作量过大,延误收派件
04-40002-40036 重货需转单
00-40045-1000 调度取消订单
00-2000 客户已取消订单
05-40003 已正常收件状态

页面列表

ITEM_HTML