华南通用下单对接文档


1-揽件服务时间校验接口

揽件服务时间校验接口-速运类API

EXP_EXCE_CHECK_PICKUP_TIME

1. 功能描述
  • 客户系统通过该接口检查是否为揽件服务时间范围。
2. 接口定义
2.1. 公共参数
名称
接口服务代码 EXP_EXCE_CHECK_PICKUP_TIME
生产环境地址 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. 请求参数\
# 属性名 类型(约束) 必填 描述
1 address String 地址
2 cityCode String 城市代码
3 addressType String 地址类型 (1:寄件地址,2:收件地址)
4 sendTime String 预约上门时间(yyyy-MM-dd HH:mm:ss)
5 sysCode String 来源系统
6 version String version:不传 只返回是否在服务时间范围 1.1 返回是否在服务时间范围,并返回服务时间段
7 province String 省,如果没有cityCode,则通过省市区转换
8 city String
9 county 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 失败原因代码,成功时为空,如B0001
3 errorMsg String 失败原因,失败时记录具体原因,如系统异常
4 msgData String 返回结果: 请求V1.0时,仅返回截单状态;请求V1.1时,返回具体截单时间范围;(详见报文示例)
2.6. 请求示例\应用场景(JSON)示例

请求报文:

{
    "address": "深圳市南山区软件产业基地1栋A座",
    "cityCode": "755",
    "addressType": 1,
    "sendTime": "2021-03-21 12:00:00",
    "sysCode": "qiao",
    "version": "V1.1"
}
2.7. 返回示例\应用场景(JSON)示例

响应报文:

  • 成功响应:
{
   "apiErrorMsg": "",
   "apiResponseID": "00016C94BDBFBA3FB2A8B41013FEE03F",
   "apiResultCode": "A1000",
   "apiResultData": "{\"success\":true,\"errorCode\":\"S0000\",\"errorMsg\":null,\"msgData\":true}"
}
  • 失败响应:
{
    "apiErrorMsg": "",
    "apiResponseID": "00016AD45F84743F9486F3154DC9A03F",
    "apiResultCode": "A1000",
    "apiResultData": "{    \"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 S0000 成功
2 S0001 非法的JSON格式
3 S0002 必填参数%s为空
4 S0003 系统发生数据错误或运行时异常
5 S0004 参数%s超过最大长度%d
6 S0005 参数超过最大值
7 S0006 参数%s不能小于%d
8 S0007 参数%s数据类型错误

页面列表

ITEM_HTML