截单转寄退回接口-速运类API
EXP_RECE_WANTED_INTERCEPT
1. 功能描述
2. 接口定义
2.1. 公共参数
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
}
{
"success": false,
"errorCode": "S0001",
"errorMsg": "非法的JSON格式",
"msgData": null
}
3.1. 错误代码
3.1 (API)平台结果代码列表
3.2 业务异常代码
# |
errorCode |
描述 |
【处理建议】 |
1 |
8199 |
未找到对应订单信息,无法发起通缉拦截 |
确认运单号传入是否有误 |
2 |
8198 |
通缉截单的新地址信息不能为空 |
转寄或者退回新的地址 需要传入新地址信息 |
3 |
8237 |
传入月结卡号与源订单月结卡号不匹配,无法发起通缉、拦截 |
月结卡号与该订单下单的月结卡号不一致 |
4 |
8251 |
转寄地址不在服务范围 |
联系销售经理查询服务地址范围 |
5 |
20088 |
第三方ERP客户只允许发起拦截退回、转寄! |
serviceCode修改为 1 2 |
速运类接口业务相关错误码